All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "jr via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, jr <johan@latehours.net>
Subject: Re: [PATCH] gitignore.txt: use backticks instead of double quotes
Date: Tue, 18 Jul 2023 06:53:07 -0700	[thread overview]
Message-ID: <xmqqlefdiaws.fsf@gitster.g> (raw)
In-Reply-To: <pull.1553.git.git.1689685982027.gitgitgadget@gmail.com> (jr via GitGitGadget's message of "Tue, 18 Jul 2023 13:13:01 +0000")

"jr via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Johan Ruokangas <johan@latehours.net>
>
> unifies highlighting with the rest of the documentation

I find "The rest of the documentation" is a bit of overstatement,
but something like

    Among four examples, only this one used "double quoted" sample
    patterns, but all others marked up the patterns in `monospace`.

would be a good justification.  The change is good.

A change in the same vein elsewhere in the same document ...

diff --git i/Documentation/gitignore.txt w/Documentation/gitignore.txt
index 4c17f2356c..bf2d823c94 100644
--- i/Documentation/gitignore.txt
+++ w/Documentation/gitignore.txt
@@ -88,7 +88,7 @@ PATTERN FORMAT
    Put a backslash ("`\`") in front of the first "`!`" for patterns
    that begin with a literal "`!`", for example, "`\!important!.txt`".
 
- - The slash '/' is used as the directory separator. Separators may
+ - The slash "`/`" is used as the directory separator. Separators may
    occur at the beginning, middle or end of the `.gitignore` search pattern.
 
  - If there is a separator at the beginning or middle (or both) of the

... would be sufficient to make the PATTERN FORMAT section
consistent, I think.

> Signed-off-by: Johan Ruokangas <johan@latehours.net>

Thanks, will queue.

> diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
> index 4c17f2356c4..810041acd17 100644
> --- a/Documentation/gitignore.txt
> +++ b/Documentation/gitignore.txt
> @@ -174,10 +174,10 @@ EXAMPLES
>     is not relevant  if there is already a middle slash in
>     the pattern.
>  
> - - The pattern "foo/*", matches "foo/test.json"
> -   (a regular file), "foo/bar" (a directory), but it does not match
> -   "foo/bar/hello.c" (a regular file), as the asterisk in the
> -   pattern does not match "bar/hello.c" which has a slash in it.
> + - The pattern `foo/*`, matches `foo/test.json`
> +   (a regular file), `foo/bar` (a directory), but it does not match
> +   `foo/bar/hello.c` (a regular file), as the asterisk in the
> +   pattern does not match `bar/hello.c` which has a slash in it.
>  
>  --------------------------------------------------------------
>      $ git status
>
> base-commit: 5e238546dc7a232d8998f1cd1ec9d3f4a0add68b

      reply	other threads:[~2023-07-18 13:53 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-18 13:13 [PATCH] gitignore.txt: use backticks instead of double quotes jr via GitGitGadget
2023-07-18 13:53 ` Junio C Hamano [this message]

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

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

  git send-email \
    --in-reply-to=xmqqlefdiaws.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=johan@latehours.net \
    /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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.