[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
02/06: doc: cookbook: Use @var for meta-syntactic variables.
From: |
guix-commits |
Subject: |
02/06: doc: cookbook: Use @var for meta-syntactic variables. |
Date: |
Thu, 15 Oct 2020 12:51:33 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit 51f34e21c69459d3226bb1bbe0c0aaaf2e00465c
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Thu Oct 15 15:24:07 2020 +0200
doc: cookbook: Use @var for meta-syntactic variables.
* doc/guix-cookbook.texi (Extended example): Use @var for meta-syntactic
variables in 'modify-phases' description.
---
doc/guix-cookbook.texi | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi
index c4abeda..a669015 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
- branch master updated (3391779 -> 61263e1), guix-commits, 2020/10/15
- 02/06: doc: cookbook: Use @var for meta-syntactic variables.,
guix-commits <=
- 04/06: doc: cookbook: Use @code for the identifiers of utility functions., guix-commits, 2020/10/15
- 03/06: doc: cookbook: More "#true" and "#false"., guix-commits, 2020/10/15
- 05/06: ui: Only suggest modules that export the unbound variable identifier., guix-commits, 2020/10/15
- 01/06: doc: cookbook: Fix 'let' form in example., guix-commits, 2020/10/15
- 06/06: doc: Add "Build Utilities" section., guix-commits, 2020/10/15