summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-10-15 15:24:07 +0200
committerLudovic Courtès <ludo@gnu.org>2020-10-15 18:50:22 +0200
commit51f34e21c69459d3226bb1bbe0c0aaaf2e00465c (patch)
treeb2160930b48ff8c34ed10718e6ee50ccf3b7f05a
parent7802988201820dd951407521e243557293dceb94 (diff)
doc: cookbook: Use @var for meta-syntactic variables.
* doc/guix-cookbook.texi (Extended example): Use @var for meta-syntactic variables in 'modify-phases' description.
-rw-r--r--doc/guix-cookbook.texi10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi
index c4abeda1e1..a669015269 100644
--- a/doc/guix-cookbook.texi
+++ b/doc/guix-cookbook.texi
@@ -1067,16 +1067,16 @@ the following forms:
@itemize
@item
-@code{(add-before PHASE NEW-PHASE PROCEDURE)}: Run @code{PROCEDURE} named @code{NEW-PHASE} before @code{PHASE}.
+@code{(add-before @var{phase} @var{new-phase} @var{procedure})}: Run @var{procedure} named @var{new-phase} before @var{phase}.
@item
-@code{(add-after PHASE NEW-PHASE PROCEDURE)}: Same, but afterwards.
+@code{(add-after @var{phase} @var{new-phase} @var{procedure})}: Same, but afterwards.
@item
-@code{(replace PHASE PROCEDURE)}.
+@code{(replace @var{phase} @var{procedure})}.
@item
-@code{(delete PHASE)}.
+@code{(delete @var{phase})}.
@end itemize
-The @code{PROCEDURE} supports the keyword arguments @code{inputs} and @code{outputs}. Each
+The @var{procedure} supports the keyword arguments @code{inputs} and @code{outputs}. Each
input (whether @emph{native}, @emph{propagated} or not) and output directory is referenced
by their name in those variables. Thus @code{(assoc-ref outputs "out")} is the store
directory of the main output of the package. A phase procedure may look like