[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: |
Ludovic Courtès |
Subject: |
Re: [PATCH 2/2] gnu: Add GSSD and Pipefs services (Usage of @var) |
Date: |
Wed, 14 Sep 2016 16:42:11 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) |
John Darrington <address@hidden> skribis:
> 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?
Dunno, my interpretation is that ‘nfs-utils’ here denotes the value of
the ‘nfs-utils’ variable, so it “stands for another piece of text”,
which is (package (name "nfs-utils") …).
No big deal, but we should settle on a single convention and so far
we’ve used @var in such cases.
Ludo’.
- [PATCH 1/2] doc: "Various Services" -> "Miscellaneous Services", John Darrington, 2016/09/10
- "filesystem" vs. "file system", John Darrington, 2016/09/15
- Re: "filesystem" vs. "file system", Ludovic Courtès, 2016/09/15
- [PATCH] gnu: Add NFS related services., John Darrington, 2016/09/25
- Re: [PATCH] gnu: Add NFS related services., Ludovic Courtès, 2016/09/30
- Re: [PATCH] gnu: Add NFS related services., John Darrington, 2016/09/30
Re: [PATCH 1/2] doc: "Various Services" -> "Miscellaneous Services", Ludovic Courtès, 2016/09/13