git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>, git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>
Subject: Re: [PATCH] gitignore.txt: suggestions how to get literal # or ! at the beginning
Date: Sat, 6 Oct 2012 12:33:14 +0100	[thread overview]
Message-ID: <01ADED0717024E6F93B7FBADB1AEAE6B@PhilipOakley> (raw)
In-Reply-To: 1349512701-29729-1-git-send-email-pclouds@gmail.com

From: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
> We support backslash escape, but we hide the details behind the phrase
> "a shell glob suitable for consumption by fnmatch(3)". So it may not
> be obvious how one can get literal # or ! at the beginning of a 
> pattern.
> Add a few lines on how to work around the magic characters.
>
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
> Asciidoc 8.2.6 does not like me writing
> "Put \# if you need a literal #.." so I go with "backslash" and
> "hash" instead. `\!` displays fine both in man page and html format.
> '!' changed to `!` because it looks clearer in monospace.

Why not put the backslash-hash in back quotes as well to give the same 
look/feel consistency?

>
> Documentation/gitignore.txt | 7 +++++--
> 1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
> index 96639e0..8c03ed4 100644
> --- a/Documentation/gitignore.txt
> +++ b/Documentation/gitignore.txt
> @@ -74,11 +74,14 @@ PATTERN FORMAT
>    for readability.
>
>  - A line starting with # serves as a comment.

+  A line starting with `#` serves as a comment.

> +   Put a backslash in front of the first hash for the patterns
> +   that start with a hash.
>
+   Use `\#` if you need a literal `#` at the beginning of the pattern.

> - - An optional prefix '!' which negates the pattern; any
> + - An optional prefix `!` which negates the pattern; any
>    matching file excluded by a previous pattern will become
>    included again.  If a negated pattern matches, this will
> -   override lower precedence patterns sources.
> +   override lower precedence patterns sources. Use `\!` if
> +   you need a literal `!` at the beginning of the pattern.
>
>  - If the pattern ends with a slash, it is removed for the
>    purpose of the following description, but it would only find
> -- 
> 1.7.12.1.406.g6ab07c4

  reply	other threads:[~2012-10-06 11:33 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-06  8:38 [PATCH] gitignore.txt: suggestions how to get literal # or ! at the beginning Nguyễn Thái Ngọc Duy
2012-10-06 11:33 ` Philip Oakley [this message]
2012-10-06 11:43   ` Nguyen Thai Ngoc Duy
2012-10-06 13:21     ` Jeff King
2012-10-06 13:51       ` [PATCH v2] " Nguyễn Thái Ngọc Duy
2012-10-06 15:40         ` Jeff King
2012-10-06 18:25           ` Junio C Hamano
2012-10-07  3:13             ` [PATCH v3] " Nguyễn Thái Ngọc Duy

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=01ADED0717024E6F93B7FBADB1AEAE6B@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=pclouds@gmail.com \
    /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).