From: Alex Kost <alezost@gmail.com>
To: guix-devel@gnu.org
Subject: [PATCH 05/11] doc: Replace references to 'dmd' with 'shepherd'.
Date: Thu, 28 Jan 2016 00:10:30 +0300 [thread overview]
Message-ID: <1453929036-10408-6-git-send-email-alezost@gmail.com> (raw)
In-Reply-To: <1453929036-10408-1-git-send-email-alezost@gmail.com>
* doc/guix.texi: Use 'shepherd'/'herd' instead of 'dmd'/'deco'. Fix
info references.
---
doc/guix.texi | 98 ++++++++++++++++++++++++++++++-----------------------------
1 file changed, 50 insertions(+), 48 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index a6ba948..55e2c67 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -194,7 +194,7 @@ Defining Services
* Service Composition:: The model for composing services.
* Service Types and Services:: Types and services.
* Service Reference:: API reference.
-* dmd Services:: A particular type of service.
+* Shepherd Services:: A particular type of service.
Packaging Guidelines
@@ -5595,7 +5595,7 @@ ext2/ext3/ext4 file systems.
Once that is done, mount the target root partition under @file{/mnt}.
@item
-Lastly, run @code{deco start cow-store /mnt}.
+Lastly, run @code{herd start cow-store /mnt}.
This will make @file{/gnu/store} copy-on-write, such that packages added
to it during the installation phase will be written to the target disk
@@ -6492,22 +6492,22 @@ Configuration System}). System services are typically daemons launched
when the system boots, or other actions needed at that time---e.g.,
configuring network access.
-Services are managed by GNU@tie{}dmd (@pxref{Introduction,,, dmd, GNU
-dmd Manual}). On a running system, the @command{deco} command allows
-you to list the available services, show their status, start and stop
-them, or do other specific operations (@pxref{Jump Start,,, dmd, GNU dmd
-Manual}). For example:
+Services are managed by GNU@tie{}Shepherd (@pxref{Introduction,,,
+shepherd, GNU Shepherd Manual}). On a running system, the
+@command{herd} command allows you to list the available services, show
+their status, start and stop them, or do other specific operations
+(@pxref{Jump Start,,, shepherd, GNU Shepherd Manual}). For example:
@example
-# deco status dmd
+# herd status
@end example
The above command, run as @code{root}, lists the currently defined
-services. The @command{deco doc} command shows a synopsis of the given
+services. The @command{herd doc} command shows a synopsis of the given
service:
@example
-# deco doc nscd
+# herd doc nscd
Run libc's name service cache daemon (nscd).
@end example
@@ -6516,9 +6516,9 @@ have the effect you would expect. For instance, the commands below stop
the nscd service and restart the Xorg display server:
@example
-# deco stop nscd
+# herd stop nscd
Service nscd has been stopped.
-# deco restart xorg-server
+# herd restart xorg-server
Service xorg-server has been stopped.
Service xorg-server has been started.
@end example
@@ -8947,7 +8947,7 @@ Tell the initial RAM disk to load @var{boot}, a file containing a Scheme
program, once it has mounted the root file system.
GuixSD uses this option to yield control to a boot program that runs the
-service activation programs and then spawns GNU@tie{}dmd, the
+service activation programs and then spawns GNU@tie{}Shepherd, the
initialization system.
@item --root=@var{root}
@@ -9332,8 +9332,9 @@ produces a PDF file showing the extension relations among services.
@anchor{system-dmd-graph}
@item dmd-graph
Emit in Dot/Graphviz format to standard output the @dfn{dependency
-graph} of dmd services of the operating system defined in @var{file}.
-@xref{dmd Services}, for more information and for an example graph.
+graph} of Shepherd services of the operating system defined in
+@var{file}. @xref{Shepherd Services}, for more information and for an
+example graph.
@end table
@@ -9400,7 +9401,7 @@ them in the first place? And what is a service anyway?
* Service Composition:: The model for composing services.
* Service Types and Services:: Types and services.
* Service Reference:: API reference.
-* dmd Services:: A particular type of service.
+* Shepherd Services:: A particular type of service.
@end menu
@node Service Composition
@@ -9423,15 +9424,15 @@ directory.
@cindex service extensions
GuixSD services are connected by @dfn{extensions}. For instance, the
-secure shell service @emph{extends} dmd---GuixSD's initialization system,
-running as PID@tie{}1---by giving it the command lines to start and stop
-the secure shell daemon (@pxref{Networking Services,
+secure shell service @emph{extends} Shepherd---GuixSD's initialization
+system, running as PID@tie{}1---by giving it the command lines to start
+and stop the secure shell daemon (@pxref{Networking Services,
@code{lsh-service}}); the UPower service extends the D-Bus service by
passing it its @file{.service} specification, and extends the udev
service by passing it device management rules (@pxref{Desktop Services,
-@code{upower-service}}); the Guix daemon service extends dmd by passing
-it the command lines to start and stop the daemon, and extends the
-account service by passing it a list of required build user accounts
+@code{upower-service}}); the Guix daemon service extends Shepherd by
+passing it the command lines to start and stop the daemon, and extends
+the account service by passing it a list of required build user accounts
(@pxref{Base Services}).
All in all, services and their ``extends'' relations form a directed
@@ -9496,9 +9497,10 @@ In this example, @var{guix-service-type} extends three services:
@table @var
@item dmd-root-service-type
-The @var{guix-dmd-service} procedure defines how the dmd service is
+The @var{guix-dmd-service} procedure defines how the Shepherd service is
extended. Namely, it returns a @code{<dmd-service>} object that defines
-how @command{guix-daemon} is started and stopped (@pxref{dmd Services}).
+how @command{guix-daemon} is started and stopped (@pxref{Shepherd
+Services}).
@item account-service-type
This extension for this service is computed by @var{guix-accounts},
@@ -9757,20 +9759,20 @@ extend it by passing it lists of packages to add to the system profile.
@end defvr
-@node dmd Services
-@subsubsection dmd Services
+@node Shepherd Services
+@subsubsection Shepherd Services
@cindex PID 1
@cindex init system
The @code{(gnu services dmd)} provides a way to define services managed
-by GNU@tie{}dmd, which is GuixSD initialization system---the first
+by GNU@tie{}Shepherd, which is GuixSD initialization system---the first
process that is started when the system boots, aka. PID@tie{}1
-(@pxref{Introduction,,, dmd, GNU dmd Manual}).
+(@pxref{Introduction,,, shepherd, GNU Shepherd Manual}).
-Services in dmd can depend on each other. For instance, the SSH daemon
-may need to be started after the syslog daemon has been started, which
-in turn can only happen once all the file systems have been mounted.
-The simple operating system defined earlier (@pxref{Using the
+Services in Shepherd can depend on each other. For instance, the SSH
+daemon may need to be started after the syslog daemon has been started,
+which in turn can only happen once all the file systems have been
+mounted. The simple operating system defined earlier (@pxref{Using the
Configuration System}) results in a service graph like this:
@image{images/dmd-graph,,5in,Typical dmd service graph.}
@@ -9784,19 +9786,19 @@ of type @var{dmd-root-service-type}; it can be extended by passing it
lists of @code{<dmd-service>} objects.
@deftp {Data Type} dmd-service
-The data type representing a service managed by dmd.
+The data type representing a service managed by Shepherd.
@table @asis
@item @code{provision}
This is a list of symbols denoting what the service provides.
-These are the names that may be passed to @command{deco start},
-@command{deco status}, and similar commands (@pxref{Invoking deco,,,
-dmd, GNU dmd Manual}). @xref{Slots of services, the @code{provides}
-slot,, dmd, GNU dmd Manual}, for details.
+These are the names that may be passed to @command{herd start},
+@command{herd status}, and similar commands (@pxref{Invoking herd,,,
+shepherd, GNU Shepherd Manual}). @xref{Slots of services, the
+@code{provides} slot,, shepherd, GNU Shepherd Manual}, for details.
@item @code{requirements} (default: @code{'()})
-List of symbols denoting the dmd services this one depends on.
+List of symbols denoting the Shepherd services this one depends on.
@item @code{respawn?} (default: @code{#t})
Whether to restart the service when it stops, for instance when the
@@ -9804,20 +9806,20 @@ underlying process dies.
@item @code{start}
@itemx @code{stop} (default: @code{#~(const #f)})
-The @code{start} and @code{stop} fields refer to dmd's facilities to
-start and stop processes (@pxref{Service De- and Constructors,,, dmd,
-GNU dmd Manual}). They are given as G-expressions that get expanded in
-the dmd configuration file (@pxref{G-Expressions}).
+The @code{start} and @code{stop} fields refer to Shepherd's facilities
+to start and stop processes (@pxref{Service De- and Constructors,,,
+shepherd, GNU Shepherd Manual}). They are given as G-expressions that
+get expanded in the Shepherd configuration file (@pxref{G-Expressions}).
@item @code{documentation}
A documentation string, as shown when running:
@example
-deco doc @var{service-name}
+herd doc @var{service-name}
@end example
where @var{service-name} is one of the symbols in @var{provision}
-(@pxref{Invoking deco,,, dmd, GNU dmd Manual}).
+(@pxref{Invoking herd,,, shepherd, GNU Shepherd Manual}).
@item @code{modules} (default: @var{%default-modules})
This is the list of modules that must be in scope when @code{start} and
@@ -9825,17 +9827,17 @@ This is the list of modules that must be in scope when @code{start} and
@item @code{imported-modules} (default: @var{%default-imported-modules})
This is the list of modules to import in the execution environment of
-dmd.
+Shepherd.
@end table
@end deftp
@defvr {Scheme Variable} dmd-root-service-type
-The service type for the dmd ``root service''---i.e., PID@tie{}1.
+The service type for the Shepherd ``root service''---i.e., PID@tie{}1.
This is the service type that extensions target when they want to create
-dmd services (@pxref{Service Types and Services}, for an example). Each
-extension must pass a list of @code{<dmd-service>}.
+Shepherd services (@pxref{Service Types and Services}, for an example).
+Each extension must pass a list of @code{<dmd-service>}.
@end defvr
@defvr {Scheme Variable} %dmd-root-service
--
2.6.3
next prev parent reply other threads:[~2016-01-27 21:11 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-01-27 21:10 [PATCH 00/11]: Rename dmd to shepherd in Guix source Alex Kost
2016-01-27 21:10 ` [PATCH 01/11] gnu: elogind: Use 'shepherd' input Alex Kost
2016-01-28 10:22 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 02/11] Use 'shepherd' instead of 'dmd' as init system Alex Kost
2016-01-28 10:23 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 03/11] linux-boot: Rename /root/etc/dmd directory Alex Kost
2016-01-28 10:24 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 04/11] services: Rename %do-not-kill-file Alex Kost
2016-01-28 10:25 ` Ludovic Courtès
2016-01-28 17:50 ` Alex Kost
2016-01-31 9:46 ` Ludovic Courtès
2016-01-27 21:10 ` Alex Kost [this message]
2016-01-28 10:27 ` [PATCH 05/11] doc: Replace references to 'dmd' with 'shepherd' Ludovic Courtès
2016-01-27 21:10 ` [PATCH 06/11] Rename (gnu services dmd) to (gnu services shepherd) Alex Kost
2016-01-28 10:28 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 07/11] services: shepherd: Rename shepherd configuration file Alex Kost
2016-01-28 10:28 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 08/11] services: xorg: Use 'shepherd' instead of 'dmd' Alex Kost
2016-01-28 10:28 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 09/11] services: Rename 'dmd' services to 'shepherd' Alex Kost
2016-01-28 10:29 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 10/11] guix system: Rename 'dmd-graph' to 'shepherd-graph' Alex Kost
2016-01-28 10:29 ` Ludovic Courtès
2016-01-27 21:10 ` [PATCH 11/11] Rename 'dmd' to 'shepherd' in comments and strings Alex Kost
2016-01-28 10:33 ` Ludovic Courtès
2016-01-28 21:03 ` Alex Kost
2016-01-28 10:22 ` [PATCH 00/11]: Rename dmd to shepherd in Guix source Ludovic Courtès
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=1453929036-10408-6-git-send-email-alezost@gmail.com \
--to=alezost@gmail.com \
--cc=guix-devel@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).