guix-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 2/2] gnu: Add GSSD and Pipefs services (Usage of @var)


From: John Darrington
Subject: Re: [PATCH 2/2] gnu: Add GSSD and Pipefs services (Usage of @var)
Date: Tue, 13 Sep 2016 15:53:30 +0200
User-agent: Mutt/1.5.23 (2014-03-12)

On Tue, Sep 13, 2016 at 01:45:19PM +0200, Ludovic Court??s wrote:
     John Darrington <address@hidden> skribis:

     > address@hidden @code{nfs-utils} (default: @code{nfs-utils})
                                         ^^^^^
     Should be @var, because here we???re talking about the value of the
     ???nfs-utils??? global variable.

I think you are mistaken here.  Quoting from the Texinfo manual:

    Use the @var command to indicate metasyntactic variables. A metasyntactic 
   variable is something that stands for another piece of text. For example, you
   should use a metasyntactic variable in the documentation of a function to 
   describe the arguments that are passed to that function.

    Do not use @var for the names of normal variables in computer programs. 
These
   are specific names, so @code is correct for them (@code).  For example, the 
   Emacs Lisp variable texinfo-tex-command is not a metasyntactic variable; it 
   is properly formatted using @code.

Or have I got it wrong?

J'


     

-- 
Avoid eavesdropping.  Send strong encrypted email.
PGP Public key ID: 1024D/2DE827B3 
fingerprint = 8797 A26D 0854 2EAB 0285  A290 8A67 719C 2DE8 27B3
See http://sks-keyservers.net or any PGP keyserver for public key.

Attachment: signature.asc
Description: Digital signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]