Undocumented base services in Guix manual

  • Open
  • quality assurance status badge
Details
One participant
  • Richard Sent
Owner
unassigned
Submitted by
Richard Sent
Severity
normal
R
R
Richard Sent wrote on 25 Jan 16:40 +0100
(address . bug-guix@gnu.org)
87r0i5s9o6.fsf@freakingpenguin.com
Hi all,

Despite being exported by gnu/services/base.scm, and despite Section 11.9.1 Base
Services saying

Toggle snippet (5 lines)
The ‘(gnu services base)’ module provides definitions for the basic
services that one expects from the system. The services exported by
this module are listed below.

the following services and/or types are exported by base.scm, but are not
documented in the reference manual (commit 250477d869). I marked
extendable services with (e).

- fstab-service-type (e)
- root-file-system-service
- file-system-service-type (e)
- swap-service

An argument could be made for not documenting root-file-system-service
and swap-service, since they're a) not extensible b) not service
types and c) likely not relevant for the vast majority of users.
Personally I'd still lean towards documenting them, if only to match
what the manual says.

fstab-service-type and file-system-service-type, however, are extensible
and conceivably could be extended by a user. For instance, a custom NAS
client service that creates a mount point. As such, I believe those two
should be documented. That should help make them a bit more discoverable
to users.

--
Take it easy,
Richard Sent
Making my computer weirder one commit at a time.
?
Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 68715@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 68715
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch