From de613050efec781e8380a0267879a25b2d489513 Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Thu, 24 May 2018 16:11:39 -0400 Subject: Use proper syntax for replaceables in command docs The standard for command documentation synopses appears to be: [...] means optional <...> means replaceable [<...>] means both optional and replaceable So fix a number of doc pages that use incorrect variations of the above. Signed-off-by: Robert P. J. Day Signed-off-by: Junio C Hamano --- Documentation/git-diff.txt | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'Documentation/git-diff.txt') diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 7c2c442700..b180f1fa5b 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -9,11 +9,11 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- [verse] -'git diff' [options] [] [--] [...] -'git diff' [options] --cached [] [--] [...] -'git diff' [options] [--] [...] -'git diff' [options] -'git diff' [options] --no-index [--] +'git diff' [] [] [--] [...] +'git diff' [] --cached [] [--] [...] +'git diff' [] [--] [...] +'git diff' [] +'git diff' [] --no-index [--] DESCRIPTION ----------- @@ -21,7 +21,7 @@ Show changes between the working tree and the index or a tree, changes between the index and a tree, changes between two trees, changes between two blob objects, or changes between two files on disk. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This form is to view the changes you made relative to the index (staging area for the next commit). In other @@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk. further add to the index but you still haven't. You can stage these changes by using linkgit:git-add[1]. -'git diff' [options] --no-index [--] :: +'git diff' [] --no-index [--] :: This form is to compare the given two paths on the filesystem. You can omit the `--no-index` option when @@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk. or when running the command outside a working tree controlled by Git. -'git diff' [options] --cached [] [--] [...]:: +'git diff' [] --cached [] [--] [...]:: This form is to view the changes you staged for the next commit relative to the named . Typically you @@ -48,7 +48,7 @@ two blob objects, or changes between two files on disk. is not given, it shows all staged changes. --staged is a synonym of --cached. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This form is to view the changes you have in your working tree relative to the named . You can @@ -56,18 +56,18 @@ two blob objects, or changes between two files on disk. branch name to compare with the tip of a different branch. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This is to view the changes between two arbitrary . -'git diff' [options] .. [--] [...]:: +'git diff' [] .. [--] [...]:: This is synonymous to the previous form. If on one side is omitted, it will have the same effect as using HEAD instead. -'git diff' [options] \... [--] [...]:: +'git diff' [] \... [--] [...]:: This form is to view the changes on the branch containing and up to the second , starting at a common ancestor @@ -87,7 +87,7 @@ and the range notations (".." and "\...") do not mean a range as defined in the "SPECIFYING RANGES" section in linkgit:gitrevisions[7]. -'git diff' [options] :: +'git diff' [] :: This form is to view the differences between the raw contents of two blob objects. -- cgit v1.3