delta/git.git/Documentation/git-apply.txt, branch nd/cache-tree-api-refactor

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.

Documentation: fix a typo in git-apply.txt

2011-03-04T18:05:00+00:00

git-apply accepts the --cached option, not --cache.

Signed-off-by: Michał Kiedrowicz 
Signed-off-by: Junio C Hamano

Use parentheses and `...' where appropriate

2010-10-08T19:31:07+00:00

Remove some stray usage of other bracket types and asterisks for the
same purpose.

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

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: cite git-am from git-apply

2010-08-09T16:15:41+00:00

Users reading git-apply documentation may also be interested in git-am,
especially after receiving an email created with git-format-patch.  The
documentation for git-am already references git-apply.  Add the reverse.

Signed-off-by: Brad King 
Signed-off-by: Junio C Hamano

Documentation: spell 'git cmd' without dash throughout

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

The documentation was quite inconsistent when spelling 'git cmd' if it
only refers to the program, not to some specific invocation syntax:
both 'git-cmd' and 'git cmd' spellings exist.

The current trend goes towards dashless forms, and there is precedent
in 647ac70 (git-svn.txt: stop using dash-form of commands.,
2009-07-07) to actively eliminate the dashed variants.

Replace 'git-cmd' with 'git cmd' throughout, except where git-shell,
git-cvsserver, git-upload-pack, git-receive-pack, and
git-upload-archive are concerned, because those really live in the
$PATH.

apply: Use the term "working tree" consistently

2009-11-22T20:08:08+00:00

The documentation for 'git apply' uses both the terms
"work tree" and "working tree". Since the glossary uses
the term "working tree", change all occurrences of
"work tree" to "working tree".

Signed-off-by: Björn Gustavsson 
Signed-off-by: Junio C Hamano

apply: Format all options using back-quotes

2009-11-22T20:08:07+00:00

Signed-off-by: Björn Gustavsson 
Signed-off-by: Junio C Hamano

apply: apply works outside a repository

2009-11-22T20:08:04+00:00

The documentation for 'git apply' talks about applying a
patch/diff to the index and to the working tree, which seems
to imply that it will not work outside a git repository.

Actually 'git patch' works outside a repository (which can
be useful especially for applying binary or rename patches that
the standard "patch" utility cannot handle), so the documentation
should mention it.

Thanks to Junio for suggesting better wording.

Signed-off-by: Björn Gustavsson 
Signed-off-by: Junio C Hamano

Clarify and correct -z

2009-11-22T20:08:00+00:00

The description for -z is too vague and general for the
apply, diff*, and log commands.

Change the description of -z for 'git log' to note that
commits will be separated by NULs.

Change the description of -z for 'git diff*' and 'git apply'
to note that it applies to the --numstat option, and for
'git diff*' also for --raw option.

Also correct the description of the "munging" of pathanmes that
takes place in the absence of -z for the 'git diff*' and
'git apply' commands, namely that apart from the characters mentioned,
double quotes will also be escaped and that the pathname will be
enclosed in double quotes if any characters are escaped.

Signed-off-by: Björn Gustavsson 
Signed-off-by: Junio C Hamano