summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLuis Felipe <luis.felipe.la@protonmail.com>2022-04-08 15:57:36 -0500
committerLudovic Courtès <ludo@gnu.org>2022-04-10 00:17:41 +0200
commite1c040b7b3290cfa1e87b6f554f5cb35dc87c87d (patch)
tree9792f9b643036471fb370da829102090485e075b /doc
parentcec2ec4440cf63f6b8b75f2bb4e47659fca9e5eb (diff)
downloadguix-e1c040b7b3290cfa1e87b6f554f5cb35dc87c87d.tar.gz
doc: package Reference: Mention syntax of package-description.
* doc/guix.texi (package Reference) <description>: Mention that the
string is in Texinfo syntax.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 43f27722e8..7369a306f6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7362,7 +7362,8 @@ for details.
 A one-line description of the package.
 
 @item @code{description}
-A more elaborate description of the package.
+A more elaborate description of the package, as a string in Texinfo
+syntax.
 
 @item @code{license}
 @cindex license, of packages