04/04: doc: Use @var for meta-syntactic variables.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit a0d4aa2457d7e36012143ffe3fbc9dd4bc20ca4f
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Fri Sep 25 23:25:17 2020 +0200

    doc: Use @var for meta-syntactic variables.
    
    * doc/guix.texi (Transparent Emulation with QEMU): Use @var instead of
    angle brackets for meta-syntactic variables.
---
 doc/guix.texi | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 9986df0..82241b0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25519,15 +25519,17 @@ By default, it produces
 @lisp
 '("--device" "rtl8139,netdev=net0"
   "--netdev" "user,id=net0\
-              ,hostfwd=tcp:127.0.0.1:<secrets-port>-:1004\
-              ,hostfwd=tcp:127.0.0.1:<ssh-port>-:2222\
-              ,hostfwd=tcp:127.0.0.1:<vnc-port>-:5900")
+              ,hostfwd=tcp:127.0.0.1:@var{secrets-port}-:1004\
+              ,hostfwd=tcp:127.0.0.1:@var{ssh-port}-:2222\
+              ,hostfwd=tcp:127.0.0.1:@var{vnc-port}-:5900")
 @end lisp
-with forwarded ports
+
+with forwarded ports:
+
 @example
-<ssh-port>: @code{(+ 11004 (* 1000 @var{ID}))}
-<ssh-port>: @code{(+ 10022 (* 1000 @var{ID}))}
-<vnc-port>: @code{(+ 15900 (* 1000 @var{ID}))}
+@var{ssh-port}: @code{(+ 11004 (* 1000 @var{ID}))}
+@var{ssh-port}: @code{(+ 10022 (* 1000 @var{ID}))}
+@var{vnc-port}: @code{(+ 15900 (* 1000 @var{ID}))}
 @end example
 
 @item @code{secret-root} (default: @file{/etc/childhurd})