Skip to content

Commit be75d12

Browse files
committed
Merge branch 'ah/misc-doc-updates'
Misc doc fixes. * ah/misc-doc-updates: doc: normalize [--options] to [options] in git-diff doc: add note about shell quoting to revision.txt git-svn: remove ''--add-author-from' for 'commit-diff' doc: add '-d' and '-o' for 'git push' doc: clarify ignore rules for git ls-files doc: align 'diff --no-index' in text and synopsis doc: improve formatting in githooks.txt
2 parents fda537a + 5356a3c commit be75d12

File tree

6 files changed

+77
-68
lines changed

6 files changed

+77
-68
lines changed

Documentation/git-diff.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ SYNOPSIS
1313
'git diff' [options] --cached [<commit>] [--] [<path>...]
1414
'git diff' [options] <commit> <commit> [--] [<path>...]
1515
'git diff' [options] <blob> <blob>
16-
'git diff' [options] [--no-index] [--] <path> <path>
16+
'git diff' [options] --no-index [--] <path> <path>
1717

1818
DESCRIPTION
1919
-----------
2020
Show changes between the working tree and the index or a tree, changes
2121
between the index and a tree, changes between two trees, changes between
2222
two blob objects, or changes between two files on disk.
2323

24-
'git diff' [--options] [--] [<path>...]::
24+
'git diff' [options] [--] [<path>...]::
2525

2626
This form is to view the changes you made relative to
2727
the index (staging area for the next commit). In other
2828
words, the differences are what you _could_ tell Git to
2929
further add to the index but you still haven't. You can
3030
stage these changes by using linkgit:git-add[1].
3131

32-
'git diff' --no-index [--options] [--] [<path>...]::
32+
'git diff' [options] --no-index [--] <path> <path>::
3333

3434
This form is to compare the given two paths on the
3535
filesystem. You can omit the `--no-index` option when
@@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
3838
or when running the command outside a working tree
3939
controlled by Git.
4040

41-
'git diff' [--options] --cached [<commit>] [--] [<path>...]::
41+
'git diff' [options] --cached [<commit>] [--] [<path>...]::
4242

4343
This form is to view the changes you staged for the next
4444
commit relative to the named <commit>. Typically you
@@ -48,26 +48,26 @@ two blob objects, or changes between two files on disk.
4848
<commit> is not given, it shows all staged changes.
4949
--staged is a synonym of --cached.
5050

51-
'git diff' [--options] <commit> [--] [<path>...]::
51+
'git diff' [options] <commit> [--] [<path>...]::
5252

5353
This form is to view the changes you have in your
5454
working tree relative to the named <commit>. You can
5555
use HEAD to compare it with the latest commit, or a
5656
branch name to compare with the tip of a different
5757
branch.
5858

59-
'git diff' [--options] <commit> <commit> [--] [<path>...]::
59+
'git diff' [options] <commit> <commit> [--] [<path>...]::
6060

6161
This is to view the changes between two arbitrary
6262
<commit>.
6363

64-
'git diff' [--options] <commit>..<commit> [--] [<path>...]::
64+
'git diff' [options] <commit>..<commit> [--] [<path>...]::
6565

6666
This is synonymous to the previous form. If <commit> on
6767
one side is omitted, it will have the same effect as
6868
using HEAD instead.
6969

70-
'git diff' [--options] <commit>\...<commit> [--] [<path>...]::
70+
'git diff' [options] <commit>\...<commit> [--] [<path>...]::
7171

7272
This form is to view the changes on the branch containing
7373
and up to the second <commit>, starting at a common ancestor

Documentation/git-ls-files.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ OPTIONS
5353
Show only ignored files in the output. When showing files in the
5454
index, print only those matched by an exclude pattern. When
5555
showing "other" files, show only those matched by an exclude
56-
pattern.
56+
pattern. Standard ignore rules are not automatically activated,
57+
therefore at least one of the `--exclude*` options is required.
5758

5859
-s::
5960
--stage::

Documentation/git-push.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SYNOPSIS
1111
[verse]
1212
'git push' [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
1313
[--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose]
14-
[-u | --set-upstream] [--push-option=<string>]
14+
[-u | --set-upstream] [-o <string> | --push-option=<string>]
1515
[--[no-]signed|--signed=(true|false|if-asked)]
1616
[--force-with-lease[=<refname>[:<expect>]]]
1717
[--no-verify] [<repository> [<refspec>...]]
@@ -123,6 +123,7 @@ already exists on the remote side.
123123
will be tab-separated and sent to stdout instead of stderr. The full
124124
symbolic names of the refs will be given.
125125

126+
-d::
126127
--delete::
127128
All listed refs are deleted from the remote repository. This is
128129
the same as prefixing all refs with a colon.

Documentation/git-svn.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ creating the branch or tag.
707707
config key: svn.useLogAuthor
708708

709709
--add-author-from::
710-
When committing to svn from Git (as part of 'commit-diff', 'set-tree' or 'dcommit'
710+
When committing to svn from Git (as part of 'set-tree' or 'dcommit'
711711
operations), if the existing log message doesn't already have a
712712
`From:` or `Signed-off-by:` line, append a `From:` line based on the
713713
Git commit's author string. If you use this, then `--use-log-author`

0 commit comments

Comments
 (0)