Re: [PATCH] gitignore.txt: suggestions how to get literal # or ! at the beginning

2012-10-06 Thread Jeff King
On Sat, Oct 06, 2012 at 06:43:50PM +0700, Nguyen Thai Ngoc Duy wrote:

> On Sat, Oct 6, 2012 at 6:33 PM, Philip Oakley  wrote:
> >> 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?
> 
> Because asciidoc does not like \#, '\#' nor `\#`. It just shows \
> without # and I don't want to master asciidoc just to make it show \#.

It works fine for me with asciidoc 8.6.7. 

I would think the "inline literal" syntax started in 8.2.5 would take
care of it; maybe there were some bug fixes, considering how new it was
in your version.

I also think switching "!" to `!` is a slight regression; it will change
fonts in the HTML version, but usually not in the manpage, and the loss
of the quotes makes things harder to read. I would use both, and it does
not hurt to also spell out the name of the punctuation.

So this:

diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 96639e0..c0a5851 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -73,12 +73,15 @@ PATTERN FORMAT
  - A blank line matches no files, so it can serve as a separator
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 (i.e., "`\#`").
 
- - 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

renders to:

   ·   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 (i.e., "\#").

   ·   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. Use "\!" if you
   need a literal "!" at the beginning of the pattern.

-Peff
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] gitignore.txt: suggestions how to get literal # or ! at the beginning

2012-10-06 Thread Nguyen Thai Ngoc Duy
On Sat, Oct 6, 2012 at 6:33 PM, Philip Oakley  wrote:
>> 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?

Because asciidoc does not like \#, '\#' nor `\#`. It just shows \
without # and I don't want to master asciidoc just to make it show \#.
-- 
Duy
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] gitignore.txt: suggestions how to get literal # or ! at the beginning

2012-10-06 Thread Philip Oakley

From: "Nguyễn Thái Ngọc Duy" 

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 
---
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


--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html