delta/git.git/Documentation/git-ls-tree.txt, branch mf/no-dashed-subcommands

Documentation: improve description for core.quotePath

2017-03-02T19:40:51+00:00

Linking the description for pathname quoting to the configuration
variable "core.quotePath" removes inconstistent and incomplete
sections while also giving two hints how to deal with it: Either with
"-c core.quotePath=false" or with "-z".

Signed-off-by: Andreas Heiduk 
Signed-off-by: Junio C Hamano

doc: typeset HEAD and variants as literal

2016-06-28T15:36:45+00:00

This is an application of the newly added CodingGuidelines to HEAD and
variants like FETCH_HEAD. It was obtained with:

  perl -pi -e "s/'([A-Z_]*HEAD)'/\`\$1\`/g" *.txt

Signed-off-by: Matthieu Moy 
Signed-off-by: Junio C Hamano

doc: typeset short command-line options as literal

2016-06-28T15:20:52+00:00

It was common in our documentation to surround short option names with
forward quotes, which renders as italic in HTML. Instead, use backquotes
which renders as monospace. This is one more step toward conformance to
Documentation/CodingGuidelines.

This was obtained with:

  perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt

Signed-off-by: Matthieu Moy 
Signed-off-by: Junio C Hamano

doc: drop author/documentation sections from most pages

2011-03-11T15:59:16+00:00

The point of these sections is generally to:

  1. Give credit where it is due.

  2. Give the reader an idea of where to ask questions or
     file bug reports.

But they don't do a good job of either case. For (1), they
are out of date and incomplete. A much more accurate answer
can be gotten through shortlog or blame.  For (2), the
correct contact point is generally git@vger, and even if you
wanted to cc the contact point, the out-of-date and
incomplete fields mean you're likely sending to somebody
useless.

So let's drop the fields entirely from all manpages except
git(1) itself. We already point people to the mailing list
for bug reports there, and we can update the Authors section
to give credit to the major contributors and point to
shortlog and blame for more information.

Each page has a "This is part of git" footer, so people can
follow that to the main git manpage.

Use angles for placeholders consistently

2010-10-08T19:29:52+00:00

Signed-off-by: Štěpán Němec 
Acked-by: Jonathan Nieder 
Signed-off-by: Junio C Hamano

Documentation: format full commands in typewriter font

2010-01-10T12:01:25+00:00

Use `code snippet` style instead of 'emphasis' for `git cmd ...`
according to the following rules:

* The SYNOPSIS sections are left untouched.

* If the intent is that the user type the command exactly as given, it
  is `code`.
  If the user is only loosely referred to a command and/or option, it
  remains 'emphasised'.

Signed-off-by: Thomas Rast

Merge branch 'maint-1.6.1' into maint-1.6.2

2009-05-14T04:06:11+00:00

* maint-1.6.1:
  ls-tree manpage: output of ls-tree is compatible with update-index
  ls-tree manpage: use "unless" instead of "when ... is not"

Merge branch 'maint-1.6.0' into maint-1.6.1

2009-05-14T04:05:59+00:00

* maint-1.6.0:
  ls-tree manpage: output of ls-tree is compatible with update-index
  ls-tree manpage: use "unless" instead of "when ... is not"

ls-tree manpage: output of ls-tree is compatible with update-index

2009-05-10T16:32:30+00:00

Such format relationships are very useful things to remember for
script writers.

Signed-off-by: Alex Riesen 
Signed-off-by: Junio C Hamano

ls-tree manpage: use "unless" instead of "when ... is not"

2009-05-10T16:32:29+00:00

Delayed negation in a statement is harder to spot and keep in mind.

Signed-off-by: Alex Riesen 
Signed-off-by: Junio C Hamano