Skip to content

Commit 9ca17c4

Browse files
committed
doc: git-add: remove options from SYNOPSIS
Motivations for this change: 1. Listing a huge number of options is visually overwhelming when opening a man page for an unfamiliar command. It makes it harder to understand the command's core syntax, like `git add <filename>` 2. For options which can be passed independently of any other options, including them in the SYNOPSIS does not add any information which you can't already get from reading the OPTIONS section. `git add` has some mutually exclusive options, namely: [--[no-]all | -A | --[no-]ignore-removal | [--update | -u]] but personally I already find that line so hard to parse that removing it doesn't remove a lot of information 3. Some man pages already take this approach, like `git rebase` and `git status`
1 parent 2c2ba49 commit 9ca17c4

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

Documentation/git-add.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ git-add - Add file contents to the index
88
SYNOPSIS
99
--------
1010
[synopsis]
11-
git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
12-
[--edit | -e] [--[no-]all | -A | --[no-]ignore-removal | [--update | -u]] [--sparse]
13-
[--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
14-
[--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]]
15-
[--] [<pathspec>...]
11+
git add [<options>] [--] [<pathspec>...]
1612

1713
DESCRIPTION
1814
-----------

0 commit comments

Comments
 (0)