git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>
Cc: Git List <git@vger.kernel.org>,
	nathan.berbezier@etu.univ-lyon1.fr,
	pablo.chabanne@etu.univ-lyon1.fr,
	Matthieu Moy <matthieu.moy@univ-lyon1.fr>
Subject: Re: [PATCH v2] doc: format pathnames and URLs as monospace
Date: Sun, 3 Mar 2019 11:50:54 -0500	[thread overview]
Message-ID: <CAPig+cRTHV27pC-87rNhgVEFqadXBGVXdrUtNo9xOqK0Pyw2rw@mail.gmail.com> (raw)
In-Reply-To: <20190303164008.3928-1-corentin.bompard@etu.univ-lyon1.fr>

On Sun, Mar 3, 2019 at 11:41 AM Corentin BOMPARD
<corentin.bompard@etu.univ-lyon1.fr> wrote:
> Updating the documentation to use monospace on URLs and pathnames because it makes more sense
>
> Signed-off-by: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>
> Signed-off-by: Nathan BERBEZIER <nathan.berbezier@etu.univ-lyon1.fr>
> Signed-off-by: Pablo CHABANNE <pablo.chabanne@etu.univ-lyon1.fr>
> ---
> 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@mail.gmail.com/

  reply	other threads:[~2019-03-03 16:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-03 16:40 [PATCH v2] doc: format pathnames and URLs as monospace Corentin BOMPARD
2019-03-03 16:50 ` Eric Sunshine [this message]
     [not found] <ddf8692759de4bc28f8d49dfec939805@BPMBX2013-01.univ-lyon1.fr>
2019-03-03 19:20 ` Matthieu Moy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAPig+cRTHV27pC-87rNhgVEFqadXBGVXdrUtNo9xOqK0Pyw2rw@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=corentin.bompard@etu.univ-lyon1.fr \
    --cc=git@vger.kernel.org \
    --cc=matthieu.moy@univ-lyon1.fr \
    --cc=nathan.berbezier@etu.univ-lyon1.fr \
    --cc=pablo.chabanne@etu.univ-lyon1.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).