unofficial mirror of bug-guix@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Sent <richard@freakingpenguin.com>
To: 68715@debbugs.gnu.org
Subject: bug#68715: Undocumented base services in Guix manual
Date: Thu, 25 Jan 2024 10:40:57 -0500	[thread overview]
Message-ID: <87r0i5s9o6.fsf@freakingpenguin.com> (raw)

Hi all,

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

--8<---------------cut here---------------start------------->8---
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.
--8<---------------cut here---------------end--------------->8---

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.




                 reply	other threads:[~2024-01-25 15:42 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=87r0i5s9o6.fsf@freakingpenguin.com \
    --to=richard@freakingpenguin.com \
    --cc=68715@debbugs.gnu.org \
    /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).