[pacman-dev] [PATCH 1/3] makepkg.conf(5): Add missing backticks around vars, and use single quotes around "gpg" command

[Dan McGee]

On Thu, Jan 16, 2014 at 5:30 PM, Jason St. John <jstjohn at purdue.edu> wrote:

> Signed-off-by: Jason St. John <jstjohn at purdue.edu>
> ---
> I left some of the references to CFLAGS, etc. without backticks because
> they are
> references to sections within the man page rather than about the literal
> variables
> themselves.
>
> I added backticks around "C/C++/ObjC" to prevent any possible confusion by
> AsciiDoc,
> as plus signs are parsed as AsciiDoc quotes. This apparently confused
> Vim's syntax
> highlighting, which is why I noticed it.
>

Is backticks the right thing for this string? I believe it becomes
monospace in HTML output, which doesn't feel quite right. There might be
another AsciiDoc quoting syntax that just does a passthrough literal that
might be more appropriate, or do something like we do with the double-dash
\-\-options flags.


>
>  doc/makepkg.conf.5.txt | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt
> index ef64d17..e43368c 100644
> --- a/doc/makepkg.conf.5.txt
> +++ b/doc/makepkg.conf.5.txt
> @@ -78,7 +78,7 @@ Options
>         Other flags that make accepts can also be passed.
>
>  **DEBUG_CFLAGS=**"debug_cflags"::
> -       Additional compiler flags appended to CFLAGS for use in debugging.
> Usually
> +       Additional compiler flags appended to `CFLAGS` for use in
> debugging. Usually
>         this would include: ``-g''. Read gcc(1) for more details on the
> wide
>         variety of compiler flags available.
>
> @@ -96,7 +96,7 @@ Options
>                 Allow building packages as a non-root user. This is highly
> recommended.
>
>         *distcc*;;
> -               Use the distributed C/C++/ObjC compiler to spread
> compilation among
> +               Use the distributed `C/C++/ObjC` compiler to spread
> compilation among
>                 multiple machines. If this is enabled, `DISTCC_HOSTS` must
> be specified
>                 as well.
>
> @@ -115,8 +115,8 @@ Options
>                 makepkg's '\--check' and '\--nocheck' options respectively.
>
>         *sign*;;
> -               Generate a PGP signature file using GnuPG. This will
> execute `gpg
> -               --detach-sign --use-agent` on the built package to
> generate a detached
> +               Generate a PGP signature file using GnuPG. This will
> execute 'gpg
> +               \--detach-sign \--use-agent' on the built package to
> generate a detached
>                 signature file, using the GPG agent if it is available.
> The signature
>                 file will be the entire filename of the package with a
> ``.sig''
>                 extension.
> @@ -202,20 +202,20 @@ Options
>         for details.
>
>  **MAN_DIRS=(**{usr{,/local}{,/share},opt/*}/{man,info} ...**)**::
> -       If `zipman` is specified in the OPTIONS array, this variable will
> +       If `zipman` is specified in the `OPTIONS` array, this variable will
>         instruct makepkg where to look to compress manual (man and info)
>         pages. If you build packages that are located in opt/, you may need
>         to add the directory to this array. *NOTE:* Do not add the leading
>         slash to the directory name.
>
>  **DOC_DIRS=(**usr/{,share/}{doc,gtk-doc} ...**)**::
> -       If `!docs` is specified in the OPTIONS array, this variable will
> +       If `!docs` is specified in the `OPTIONS` array, this variable will
>         instruct makepkg where to look to remove docs. If you build
> packages
>         that are located in opt/, you may need to add the directory to this
>         array. *NOTE:* Do not add the leading slash to the directory name.
>
>  **PURGE_TARGETS=(**usr/{,share}/info/dir .podlist *.pod...**)**::
> -       If `purge` is specified in the OPTIONS array, this variable will
> +       If `purge` is specified in the `OPTIONS` array, this variable will
>         instruct makepkg which files to remove from the package. This is
>         useful for index files that are added by multiple packages.
>
> --
> 1.8.5.3
>
>
>