threads / discuss / 27878

Command-line options that lack documentation

Subject: Command-line options that lack documentation

## tl;dr

4 messages between Jul 21, 2011 and Jul 21, 2011.

replies: 3people: 3as markdown or json

Nikolai Weibull· Jul 21, 2011, 12:07 UTC · lore
Hi!
The following options lack (full) documentation in the manual pages:
git-am:
  --patch-format
  --rerere-autoupdate
git-bisect:
  next subcommand
git-commit:
  --null
  --interactive
git-notes copy:
  --for-rewrite
git-submodule update:
  --init
git-config:
  --local
git-reflog expire:
  -n, --dry-run
git-reflog delete:
  -n, --dry-run
git-repack:
  --quiet
git-cherry:
  --abbrev
git-fsck:
  -v
git-rerere:
  --rerere-autoupdate
git-verify-tag:
  -v, --verbose
git-svn init | fetch | clone | rebase | dcommit:
  --no-auth-cache
  --config-dir
git-svn fetch | clone | rebase | dcommit:
  --noMetadata
  --useSvmProps
  --useSvnsyncProps
  --log-window-size
  --no-checkout
git-svn fetch | rebase | dcommit:
  --fetch-all, --all
git-svn dcommit:
  -C, --copy-similarity
git-svn log:
  --color
  --pager
  --non-recursive
git-svn show-ignore | mkdirs:
  -r, --revision
git-svn commit-diff:
  -m, --message
  -F, --file
  -r, --revision
git-index-pack:
  --pack_header
git-merge-file:
  --marker-size
  --diff3
git-pack-objects:
  --reflog
  --keep-unreachable
  --unpack-unreachable
git-ls-files:
  --resolve-undo
git-send-pack:
  --mirror
  --stateless-rpc
  --helper-status
git-receive-pack:
  --advertise-refs
  --stateless-rpc
git-upload-pack:
  --advertise-refs
  --stateless-rpc
git-mailinfo:
  --no-inbody-headers

Furthermore, the fact that most commands take -h and --help is undocumented, but perhaps not of any real importance.

I would provide patches to the documentation, but most of these options are beyond my grasp of Git.

Thomas Rast· Jul 21, 2011, 12:34 UTC · re: Nikolai Weibull · lore

Re: Command-line options that lack documentation

Nikolai Weibull wrote:
> 
> The following options lack (full) documentation in the manual pages:
[...]
> git-notes copy:
>   --for-rewrite

Intentional, cf. 6956f85 (notes: implement helpers needed for note copying during rewrite, 2010-03-12).

> Furthermore, the fact that most commands take -h and --help is
> undocumented, but perhaps not of any real importance.
It's actually in gitcli(7).
-- 
Thomas Rast
trast@{inf,student}.ethz.ch
Jens Lehmann· Jul 21, 2011, 20:18 UTC · re: Nikolai Weibull · lore

Re: Command-line options that lack documentation

Am 21.07.2011 14:07, schrieb Nikolai Weibull:
> Hi!
> 
> The following options lack (full) documentation in the manual pages:
<snip>
> git-submodule update:
>   --init

"--init" is documented in the synopsis and under the "init" and "update" commands. The only shortcoming is that the "--init" option isn't quoted properly and thus doesn't get decorated like other options in the html pages, is that what you mean?

Nikolai Weibull· Jul 21, 2011, 21:09 UTC · re: Jens Lehmann · lore

Re: Command-line options that lack documentation

On Thu, Jul 21, 2011 at 22:18, Jens Lehmann <Jens.Lehmann@web.de> wrote:
> Am 21.07.2011 14:07, schrieb Nikolai Weibull:
>> The following options lack (full) documentation in the manual pages:
>> git-submodule update:
>>   --init
> "--init" is documented in the synopsis and under the "init" and "update"
> commands.
While that’s true, It’s not documented under the OPTIONS header.

← back to recent threads