Web lists-archives.com

Re: [PATCH v2] doc: format pathnames and URLs as monospace




On Sun, Mar 3, 2019 at 11:41 AM Corentin BOMPARD
<corentin.bompard@xxxxxxxxxxxxxxxxx> wrote:
> Updating the documentation to use monospace on URLs and pathnames because it makes more sense
>
> Signed-off-by: Corentin BOMPARD <corentin.bompard@xxxxxxxxxxxxxxxxx>
> Signed-off-by: Nathan BERBEZIER <nathan.berbezier@xxxxxxxxxxxxxxxxx>
> Signed-off-by: Pablo CHABANNE <pablo.chabanne@xxxxxxxxxxxxxxxxx>
> ---
> diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
> @@ -48,10 +48,10 @@ repository root, i.e. be all under a single parent repository (but see also
>  projects' root" subsection).
>
>  -----------------------------------------------------------------------
> -our $projectroot = '/path/to/parent/directory';
> +our $projectroot = `/path/to/parent/directory`;
>  -----------------------------------------------------------------------

For the same reason explained in [1], don't do this. Due to the "----"
lines surrounding this text, it is already formatted using a monospace
font. More importantly, however, changing the quotes like this
actually changes the meaning of the code snippet, and not in a good
way (in fact in a potentially bad way since it tries to execute code
inside the `...` rather than just assigning the content of '...' as a
literal string to the variable $projectroot).

[1]: https://public-inbox.org/git/CAPig+cSkpUCm0=TZ-T2Lv5F0bxhGhyMMS6Nxj42JFbNupgpf0A@xxxxxxxxxxxxxx/