mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: clean up usage documentation for --no-* opts

Browse Source 
We'll be adding another option to the --no-* class of options soon.

Clean up the existing options by grouping them together in the OPTIONS
section, and adding missing ones to the SYNOPSIS.

Signed-off-by: James Liu <james@jamesliu.io>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
James Liu
2024-05-03 17:17:04 +10:00
committed by Junio C Hamano
parent d4cc1ec35f
commit 9b715ad926
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/git.txt
View File

@ -11,9 +11,9 @@ SYNOPSIS
[verse] [verse]
'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>] 'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare] [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--no-lazy-fetch]
[--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>] [--no-optional-locks] [--bare] [--git-dir=<path>] [--work-tree=<path>]
[--config-env=<name>=<envvar>] <command> [<args>] [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -186,6 +186,10 @@ If you just want to run git as if it was started in `<path>` then use
This is equivalent to setting the `GIT_NO_LAZY_FETCH` This is equivalent to setting the `GIT_NO_LAZY_FETCH`
environment variable to `1`. environment variable to `1`.
--no-optional-locks::
Do not perform optional operations that require locks. This is
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
--literal-pathspecs:: --literal-pathspecs::
Treat pathspecs literally (i.e. no globbing, no pathspec magic). Treat pathspecs literally (i.e. no globbing, no pathspec magic).
This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
@ -207,10 +211,6 @@ If you just want to run git as if it was started in `<path>` then use
Add "icase" magic to all pathspec. This is equivalent to setting Add "icase" magic to all pathspec. This is equivalent to setting
the `GIT_ICASE_PATHSPECS` environment variable to `1`. the `GIT_ICASE_PATHSPECS` environment variable to `1`.
--no-optional-locks::
Do not perform optional operations that require locks. This is
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
--list-cmds=<group>[,<group>...]:: --list-cmds=<group>[,<group>...]::
List commands by group. This is an internal/experimental List commands by group. This is an internal/experimental
option and may change or be removed in the future. Supported option and may change or be removed in the future. Supported

6
git.c
View File

@ -36,9 +36,9 @@ struct cmd_struct {
const char git_usage_string[] = const char git_usage_string[] =
N_("git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]\n" N_("git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]\n"
" [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n" " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
" [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n" " [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--no-lazy-fetch]\n"
" [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n" " [--no-optional-locks] [--bare] [--git-dir=<path>] [--work-tree=<path>]\n"
" [--config-env=<name>=<envvar>] <command> [<args>]"); " [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]");
const char git_more_info_string[] = const char git_more_info_string[] =
N_("'git help -a' and 'git help -g' list available subcommands and some\n" N_("'git help -a' and 'git help -g' list available subcommands and some\n"