From: Joshua Branson <jbranso@dismail.de>
To: Xinglu Chen <public@yoctocell.xyz>
Cc: guix-devel@gnu.org
Subject: Re: Best practices for writing services
Date: Fri, 19 Mar 2021 12:12:06 -0400 [thread overview]
Message-ID: <87h7l7p1gp.fsf@dismail.de> (raw)
In-Reply-To: <878s6kqydj.fsf@yoctocell.xyz> (Xinglu Chen's message of "Thu, 18 Mar 2021 16:23:36 +0100")
Xinglu Chen <public@yoctocell.xyz> writes:
> Hi Guix,
>
> I am going to write an mcron service for `guix home`[1][2] and before
> proceding, I would like to get some suggestions on what the best
> practices are for writing services in Guix.
Please note that I am a guix documentation contributor, and I am not
quite a guix developer yet. :) Though I do have a patch pending on
http://issues.guix.gnu.org/39136 (not certain why the 2/2 patch does
not show, 'cause I saw that come through in my inbox).
>
> Currently there seems to be two main ways to do this, the first one
> is the define one or more records for the configuration field of a
> service using `define-record-type*`, see the tor service in (gnu
> services networking) for example. The other method is to use
> `define-configuration` to declare the configuration fields of a service,
> see the transmission service in (gnu services file-sharing) for example.
I believe that the first method via define-record-type* seems to be the
recommended method to do this. I only say that because I feel like more
services are defined that way now. :)
> The second method removes quite a lot of boilerplate and the developer
> will define different serializers that convert scheme syntax like lists,
> alist, boolean... to the "real" configuration syntax of the program. It
> also does some automatic typechecking to some degree and allows the
> developer to write docstrings for each configuration field. There is
> then a procedure called `generate-documentation` which can automatically
> generate texinfo documenation from the docstrings.
I do like that generate-documentation procedure. Perhaps we could add
that for the define-record-type* somehow...
>
> I couldn't find any information in the manual regarding what conventions
> should be used when writing services for Guix and would like to hear
> from more experienced Guix hackers what the best practices are.
You might try asking in irc in #guix too!
I've been working on a sway service and an endlessh service in my
hacking videos
(https://video.hardlimit.com/accounts/joshua_branson/video-channels). I
was running into issues, where I could compile the service, but trying
to reconfigure my system would result in errors. The errors messages
were a little vague. I will also say that the better method I have
found in writing a guix service is to
1) write the service as simply as possible first. I personally would
copy the simplest service that you can find in gnu/services/ and modify
that via a M-x anzu-query-replace-regexp. If re-configuring works, make a commit.
2) If possible, containerize the service. If it works, make a commit.
3) Now start adding in all the features you left out before.
--
Joshua Branson (joshuaBPMan in #guix)
Sent from Emacs and Gnus
https://gnucode.me
https://video.hardlimit.com/accounts/joshua_branson/video-channels
https://propernaming.org
"You can have whatever you want, as long as you help
enough other people get what they want." - Zig Ziglar
next prev parent reply other threads:[~2021-03-19 16:12 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-18 15:23 Best practices for writing services Xinglu Chen
2021-03-19 16:12 ` Joshua Branson [this message]
2021-03-19 17:01 ` Xinglu Chen
2021-04-21 3:54 ` Maxim Cournoyer
2021-04-21 10:45 ` Xinglu Chen
2021-04-21 18:05 ` Maxim Cournoyer
2021-04-22 7:27 ` Xinglu Chen
2021-04-23 4:42 ` Maxim Cournoyer
2021-04-23 6:04 ` Xinglu Chen
2021-04-21 22:10 ` raingloom
2021-04-22 7:19 ` Xinglu Chen
2021-04-26 20:29 ` raingloom
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h7l7p1gp.fsf@dismail.de \
--to=jbranso@dismail.de \
--cc=guix-devel@gnu.org \
--cc=public@yoctocell.xyz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).