summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2019-04-15 17:03:33 +0200
committerLudovic Courtès <ludo@gnu.org>2019-04-15 17:03:33 +0200
commit16cdba76e46324869cfe1372a477db6a9362b42b (patch)
treea8d0d063ae5522cfb3e218771dd6137fe1f5cf0a /doc
parent4aea820f0954fce4d076718072faf211f62f3f9d (diff)
doc: Replace misuses of @var by @code.
* doc/guix.texi (Hardware Considerations, Service Types and Services) (Service Reference, Shepherd Services, Security Updates): Use @code instead of @var for things that are not meta-syntactic variables.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi34
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 4593d793b4a..f8e7436cf18 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1841,7 +1841,7 @@ devices. WiFi devices known to work include those using Atheros chips
1841driver, and those using Broadcom/AirForce chips (BCM43xx with 1841driver, and those using Broadcom/AirForce chips (BCM43xx with
1842Wireless-Core Revision 5), which corresponds to the @code{b43-open} 1842Wireless-Core Revision 5), which corresponds to the @code{b43-open}
1843Linux-libre driver. Free firmware exists for both and is available 1843Linux-libre driver. Free firmware exists for both and is available
1844out-of-the-box on Guix System, as part of @var{%base-firmware} 1844out-of-the-box on Guix System, as part of @code{%base-firmware}
1845(@pxref{operating-system Reference, @code{firmware}}). 1845(@pxref{operating-system Reference, @code{firmware}}).
1846 1846
1847@cindex RYF, Respects Your Freedom 1847@cindex RYF, Respects Your Freedom
@@ -24745,23 +24745,23 @@ exception is the @dfn{boot service type}, which is the ultimate service.
24745Optionally, a default value for instances of this type. 24745Optionally, a default value for instances of this type.
24746@end enumerate 24746@end enumerate
24747 24747
24748In this example, @var{guix-service-type} extends three services: 24748In this example, @code{guix-service-type} extends three services:
24749 24749
24750@table @var 24750@table @code
24751@item shepherd-root-service-type 24751@item shepherd-root-service-type
24752The @var{guix-shepherd-service} procedure defines how the Shepherd 24752The @code{guix-shepherd-service} procedure defines how the Shepherd
24753service is extended. Namely, it returns a @code{<shepherd-service>} 24753service is extended. Namely, it returns a @code{<shepherd-service>}
24754object that defines how @command{guix-daemon} is started and stopped 24754object that defines how @command{guix-daemon} is started and stopped
24755(@pxref{Shepherd Services}). 24755(@pxref{Shepherd Services}).
24756 24756
24757@item account-service-type 24757@item account-service-type
24758This extension for this service is computed by @var{guix-accounts}, 24758This extension for this service is computed by @code{guix-accounts},
24759which returns a list of @code{user-group} and @code{user-account} 24759which returns a list of @code{user-group} and @code{user-account}
24760objects representing the build user accounts (@pxref{Invoking 24760objects representing the build user accounts (@pxref{Invoking
24761guix-daemon}). 24761guix-daemon}).
24762 24762
24763@item activation-service-type 24763@item activation-service-type
24764Here @var{guix-activation} is a procedure that returns a gexp, which is 24764Here @code{guix-activation} is a procedure that returns a gexp, which is
24765a code snippet to run at ``activation time''---e.g., when the service is 24765a code snippet to run at ``activation time''---e.g., when the service is
24766booted. 24766booted.
24767@end table 24767@end table
@@ -24786,7 +24786,7 @@ value is omitted, the default value specified by
24786(service guix-service-type) 24786(service guix-service-type)
24787@end example 24787@end example
24788 24788
24789@var{guix-service-type} is quite simple because it extends other 24789@code{guix-service-type} is quite simple because it extends other
24790services but is not extensible itself. 24790services but is not extensible itself.
24791 24791
24792@c @subsubsubsection Extensible Service Types 24792@c @subsubsubsection Extensible Service Types
@@ -24812,7 +24812,7 @@ The service type for an @emph{extensible} service looks like this:
24812This is the service type for the 24812This is the service type for the
24813@uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device 24813@uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device
24814management daemon}. Compared to the previous example, in addition to an 24814management daemon}. Compared to the previous example, in addition to an
24815extension of @var{shepherd-root-service-type}, we see two new fields: 24815extension of @code{shepherd-root-service-type}, we see two new fields:
24816 24816
24817@table @code 24817@table @code
24818@item compose 24818@item compose
@@ -24839,7 +24839,7 @@ them (@pxref{Invoking guix system}).
24839@end table 24839@end table
24840 24840
24841There can be only one instance of an extensible service type such as 24841There can be only one instance of an extensible service type such as
24842@var{udev-service-type}. If there were more, the 24842@code{udev-service-type}. If there were more, the
24843@code{service-extension} specifications would be ambiguous. 24843@code{service-extension} specifications would be ambiguous.
24844 24844
24845Still here? The next section provides a reference of the programming 24845Still here? The next section provides a reference of the programming
@@ -24913,7 +24913,7 @@ Here is an example of how a service is created and manipulated:
24913 24913
24914The @code{modify-services} form provides a handy way to change the 24914The @code{modify-services} form provides a handy way to change the
24915parameters of some of the services of a list such as 24915parameters of some of the services of a list such as
24916@var{%base-services} (@pxref{Base Services, @code{%base-services}}). It 24916@code{%base-services} (@pxref{Base Services, @code{%base-services}}). It
24917evaluates to a list of services. Of course, you could always use 24917evaluates to a list of services. Of course, you could always use
24918standard list combinators such as @code{map} and @code{fold} to do that 24918standard list combinators such as @code{map} and @code{fold} to do that
24919(@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual}); 24919(@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual});
@@ -25094,8 +25094,8 @@ You can actually generate such a graph for any operating system
25094definition using the @command{guix system shepherd-graph} command 25094definition using the @command{guix system shepherd-graph} command
25095(@pxref{system-shepherd-graph, @command{guix system shepherd-graph}}). 25095(@pxref{system-shepherd-graph, @command{guix system shepherd-graph}}).
25096 25096
25097The @var{%shepherd-root-service} is a service object representing 25097The @code{%shepherd-root-service} is a service object representing
25098PID@tie{}1, of type @var{shepherd-root-service-type}; it can be extended 25098PID@tie{}1, of type @code{shepherd-root-service-type}; it can be extended
25099by passing it lists of @code{<shepherd-service>} objects. 25099by passing it lists of @code{<shepherd-service>} objects.
25100 25100
25101@deftp {Data Type} shepherd-service 25101@deftp {Data Type} shepherd-service
@@ -25143,10 +25143,10 @@ A documentation string, as shown when running:
25143herd doc @var{service-name} 25143herd doc @var{service-name}
25144@end example 25144@end example
25145 25145
25146where @var{service-name} is one of the symbols in @var{provision} 25146where @var{service-name} is one of the symbols in @code{provision}
25147(@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). 25147(@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}).
25148 25148
25149@item @code{modules} (default: @var{%default-modules}) 25149@item @code{modules} (default: @code{%default-modules})
25150This is the list of modules that must be in scope when @code{start} and 25150This is the list of modules that must be in scope when @code{start} and
25151@code{stop} are evaluated. 25151@code{stop} are evaluated.
25152 25152
@@ -25393,7 +25393,7 @@ order of magnitudes lower than a full rebuild of the dependency chain.
25393@cindex replacements of packages, for grafts 25393@cindex replacements of packages, for grafts
25394For instance, suppose a security update needs to be applied to Bash. 25394For instance, suppose a security update needs to be applied to Bash.
25395Guix developers will provide a package definition for the ``fixed'' 25395Guix developers will provide a package definition for the ``fixed''
25396Bash, say @var{bash-fixed}, in the usual way (@pxref{Defining 25396Bash, say @code{bash-fixed}, in the usual way (@pxref{Defining
25397Packages}). Then, the original package definition is augmented with a 25397Packages}). Then, the original package definition is augmented with a
25398@code{replacement} field pointing to the package containing the bug fix: 25398@code{replacement} field pointing to the package containing the bug fix:
25399 25399
@@ -25408,14 +25408,14 @@ Packages}). Then, the original package definition is augmented with a
25408From there on, any package depending directly or indirectly on Bash---as 25408From there on, any package depending directly or indirectly on Bash---as
25409reported by @command{guix gc --requisites} (@pxref{Invoking guix 25409reported by @command{guix gc --requisites} (@pxref{Invoking guix
25410gc})---that is installed is automatically ``rewritten'' to refer to 25410gc})---that is installed is automatically ``rewritten'' to refer to
25411@var{bash-fixed} instead of @var{bash}. This grafting process takes 25411@code{bash-fixed} instead of @code{bash}. This grafting process takes
25412time proportional to the size of the package, usually less than a 25412time proportional to the size of the package, usually less than a
25413minute for an ``average'' package on a recent machine. Grafting is 25413minute for an ``average'' package on a recent machine. Grafting is
25414recursive: when an indirect dependency requires grafting, then grafting 25414recursive: when an indirect dependency requires grafting, then grafting
25415``propagates'' up to the package that the user is installing. 25415``propagates'' up to the package that the user is installing.
25416 25416
25417Currently, the length of the name and version of the graft and that of 25417Currently, the length of the name and version of the graft and that of
25418the package it replaces (@var{bash-fixed} and @var{bash} in the example 25418the package it replaces (@code{bash-fixed} and @code{bash} in the example
25419above) must be equal. This restriction mostly comes from the fact that 25419above) must be equal. This restriction mostly comes from the fact that
25420grafting works by patching files, including binary files, directly. 25420grafting works by patching files, including binary files, directly.
25421Other restrictions may apply: for instance, when adding a graft to a 25421Other restrictions may apply: for instance, when adding a graft to a