advice: sort the advice related lists
Let's keep the advice related lists sorted to make them more digestible. A multi-line comment has also been changed; that produces the unexpected 'insertion != deletion' in this supposedly 'only sort lines' commit. Signed-off-by: Rubén Justo <rjusto@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Rubén Justo committed
Jan 11, 2024 at 13:40 UTC
3196029b5b6afc5bda3f5514a1ed51a7c7fb7b81
3 files changed
+88
-91
Documentation/config/advice.txt
+77
-77
@@ -4,27 +4,56 @@ advice.*::
4
can tell Git that you do not need help by setting these to 'false':
5
+
6
--
7
+ addEmbeddedRepo::
8
+ Advice on what to do when you've accidentally added one
9
+ git repo inside of another.
10
+ addEmptyPathspec::
11
+ Advice shown if a user runs the add command without providing
12
+ the pathspec parameter.
13
+ addIgnoredFile::
14
+ Advice shown if a user attempts to add an ignored file to
15
+ the index.
16
+ amWorkDir::
17
+ Advice that shows the location of the patch file when
18
+ linkgit:git-am[1] fails to apply it.
19
ambiguousFetchRefspec::
20
Advice shown when a fetch refspec for multiple remotes maps to
21
the same remote-tracking branch namespace and causes branch
22
tracking set-up to fail.
23
+ checkoutAmbiguousRemoteBranchName::
24
+ Advice shown when the argument to
25
+ linkgit:git-checkout[1] and linkgit:git-switch[1]
26
+ ambiguously resolves to a
27
+ remote tracking branch on more than one remote in
28
+ situations where an unambiguous argument would have
29
+ otherwise caused a remote-tracking branch to be
30
+ checked out. See the `checkout.defaultRemote`
31
+ configuration variable for how to set a given remote
32
+ to be used by default in some situations where this
33
+ advice would be printed.
34
+ commitBeforeMerge::
35
+ Advice shown when linkgit:git-merge[1] refuses to
36
+ merge to avoid overwriting local changes.
37
+ detachedHead::
38
+ Advice shown when you used
39
+ linkgit:git-switch[1] or linkgit:git-checkout[1]
40
+ to move to the detached HEAD state, to instruct how to
41
+ create a local branch after the fact.
42
+ diverging::
43
+ Advice shown when a fast-forward is not possible.
44
fetchShowForcedUpdates::
45
Advice shown when linkgit:git-fetch[1] takes a long time
46
to calculate forced updates after ref updates, or to warn
47
that the check is disabled.
15
- pushUpdateRejected::
16
- Set this variable to 'false' if you want to disable
17
- 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
18
- 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
19
- simultaneously.
20
- pushNonFFCurrent::
21
- Advice shown when linkgit:git-push[1] fails due to a
22
- non-fast-forward update to the current branch.
23
- pushNonFFMatching::
24
- Advice shown when you ran linkgit:git-push[1] and pushed
25
- 'matching refs' explicitly (i.e. you used ':', or
26
- specified a refspec that isn't your current branch) and
27
- it resulted in a non-fast-forward error.
48
+ ignoredHook::
49
+ Advice shown if a hook is ignored because the hook is not
50
+ set as executable.
51
+ implicitIdentity::
52
+ Advice on how to set your identity configuration when
53
+ your information is guessed from the system username and
54
+ domain name.
55
+ nestedTag::
56
+ Advice shown if a user attempts to recursively tag a tag object.
57
pushAlreadyExists::
58
Shown when linkgit:git-push[1] rejects an update that
59
does not qualify for fast-forwarding (e.g., a tag.)
@@ -37,6 +66,18 @@ advice.*::
66
tries to overwrite a remote ref that points at an
67
object that is not a commit-ish, or make the remote
68
ref point at an object that is not a commit-ish.
69
+ pushNonFFCurrent::
70
+ Advice shown when linkgit:git-push[1] fails due to a
71
+ non-fast-forward update to the current branch.
72
+ pushNonFFMatching::
73
+ Advice shown when you ran linkgit:git-push[1] and pushed
74
+ 'matching refs' explicitly (i.e. you used ':', or
75
+ specified a refspec that isn't your current branch) and
76
+ it resulted in a non-fast-forward error.
77
+ pushRefNeedsUpdate::
78
+ Shown when linkgit:git-push[1] rejects a forced update of
79
+ a branch when its remote-tracking ref has updates that we
80
+ do not have locally.
81
pushUnqualifiedRefname::
82
Shown when linkgit:git-push[1] gives up trying to
83
guess based on the source and destination refs what
@@ -44,10 +85,23 @@ advice.*::
85
we can still suggest that the user push to either
86
refs/heads/* or refs/tags/* based on the type of the
87
source object.
47
- pushRefNeedsUpdate::
48
- Shown when linkgit:git-push[1] rejects a forced update of
49
- a branch when its remote-tracking ref has updates that we
50
- do not have locally.
88
+ pushUpdateRejected::
89
+ Set this variable to 'false' if you want to disable
90
+ 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
91
+ 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
92
+ simultaneously.
93
+ resetNoRefresh::
94
+ Advice to consider using the `--no-refresh` option to
95
+ linkgit:git-reset[1] when the command takes more than 2 seconds
96
+ to refresh the index after reset.
97
+ resolveConflict::
98
+ Advice shown by various commands when conflicts
99
+ prevent the operation from being performed.
100
+ rmHints::
101
+ In case of failure in the output of linkgit:git-rm[1],
102
+ show directions on how to proceed from the current state.
103
+ sequencerInUse::
104
+ Advice shown when a sequencer command is already in progress.
105
skippedCherryPicks::
106
Shown when linkgit:git-rebase[1] skips a commit that has already
107
been cherry-picked onto the upstream branch.
@@ -68,76 +122,22 @@ advice.*::
122
Advise to consider using the `-u` option to linkgit:git-status[1]
123
when the command takes more than 2 seconds to enumerate untracked
124
files.
71
- commitBeforeMerge::
72
- Advice shown when linkgit:git-merge[1] refuses to
73
- merge to avoid overwriting local changes.
74
- resetNoRefresh::
75
- Advice to consider using the `--no-refresh` option to
76
- linkgit:git-reset[1] when the command takes more than 2 seconds
77
- to refresh the index after reset.
78
- resolveConflict::
79
- Advice shown by various commands when conflicts
80
- prevent the operation from being performed.
81
- sequencerInUse::
82
- Advice shown when a sequencer command is already in progress.
83
- implicitIdentity::
84
- Advice on how to set your identity configuration when
85
- your information is guessed from the system username and
86
- domain name.
87
- detachedHead::
88
- Advice shown when you used
89
- linkgit:git-switch[1] or linkgit:git-checkout[1]
90
- to move to the detached HEAD state, to instruct how to
91
- create a local branch after the fact.
92
- suggestDetachingHead::
93
- Advice shown when linkgit:git-switch[1] refuses to detach HEAD
94
- without the explicit `--detach` option.
95
- checkoutAmbiguousRemoteBranchName::
96
- Advice shown when the argument to
97
- linkgit:git-checkout[1] and linkgit:git-switch[1]
98
- ambiguously resolves to a
99
- remote tracking branch on more than one remote in
100
- situations where an unambiguous argument would have
101
- otherwise caused a remote-tracking branch to be
102
- checked out. See the `checkout.defaultRemote`
103
- configuration variable for how to set a given remote
104
- to be used by default in some situations where this
105
- advice would be printed.
106
- amWorkDir::
107
- Advice that shows the location of the patch file when
108
- linkgit:git-am[1] fails to apply it.
109
- rmHints::
110
- In case of failure in the output of linkgit:git-rm[1],
111
- show directions on how to proceed from the current state.
112
- addEmbeddedRepo::
113
- Advice on what to do when you've accidentally added one
114
- git repo inside of another.
115
- ignoredHook::
116
- Advice shown if a hook is ignored because the hook is not
117
- set as executable.
118
- waitingForEditor::
119
- Print a message to the terminal whenever Git is waiting for
120
- editor input from the user.
121
- nestedTag::
122
- Advice shown if a user attempts to recursively tag a tag object.
125
submoduleAlternateErrorStrategyDie::
126
Advice shown when a submodule.alternateErrorStrategy option
127
configured to "die" causes a fatal error.
128
submodulesNotUpdated::
129
Advice shown when a user runs a submodule command that fails
130
because `git submodule update --init` was not run.
129
- addIgnoredFile::
130
- Advice shown if a user attempts to add an ignored file to
131
- the index.
132
- addEmptyPathspec::
133
- Advice shown if a user runs the add command without providing
134
- the pathspec parameter.
131
+ suggestDetachingHead::
132
+ Advice shown when linkgit:git-switch[1] refuses to detach HEAD
133
+ without the explicit `--detach` option.
134
updateSparsePath::
135
Advice shown when either linkgit:git-add[1] or linkgit:git-rm[1]
136
is asked to update index entries outside the current sparse
137
checkout.
139
- diverging::
140
- Advice shown when a fast-forward is not possible.
138
+ waitingForEditor::
139
+ Print a message to the terminal whenever Git is waiting for
140
+ editor input from the user.
141
worktreeAddOrphan::
142
Advice shown when a user tries to create a worktree from an
143
invalid reference, to instruct how to create a new unborn
advice.c
+5
-8
@@ -40,12 +40,11 @@ static struct {
40
[ADVICE_ADD_EMBEDDED_REPO] = { "addEmbeddedRepo", 1 },
41
[ADVICE_ADD_EMPTY_PATHSPEC] = { "addEmptyPathspec", 1 },
42
[ADVICE_ADD_IGNORED_FILE] = { "addIgnoredFile", 1 },
43
- [ADVICE_AM_WORK_DIR] = { "amWorkDir", 1 },
43
[ADVICE_AMBIGUOUS_FETCH_REFSPEC] = { "ambiguousFetchRefspec", 1 },
44
+ [ADVICE_AM_WORK_DIR] = { "amWorkDir", 1 },
45
[ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 },
46
[ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 },
47
[ADVICE_DETACHED_HEAD] = { "detachedHead", 1 },
48
- [ADVICE_SUGGEST_DETACHING_HEAD] = { "suggestDetachingHead", 1 },
48
[ADVICE_DIVERGING] = { "diverging", 1 },
49
[ADVICE_FETCH_SHOW_FORCED_UPDATES] = { "fetchShowForcedUpdates", 1 },
50
[ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 },
@@ -56,15 +55,12 @@ static struct {
55
[ADVICE_PUSH_ALREADY_EXISTS] = { "pushAlreadyExists", 1 },
56
[ADVICE_PUSH_FETCH_FIRST] = { "pushFetchFirst", 1 },
57
[ADVICE_PUSH_NEEDS_FORCE] = { "pushNeedsForce", 1 },
59
- [ADVICE_PUSH_REF_NEEDS_UPDATE] = { "pushRefNeedsUpdate", 1 },
60
-
61
- /* make this an alias for backward compatibility */
62
- [ADVICE_PUSH_UPDATE_REJECTED_ALIAS] = { "pushNonFastForward", 1 },
63
-
58
[ADVICE_PUSH_NON_FF_CURRENT] = { "pushNonFFCurrent", 1 },
59
[ADVICE_PUSH_NON_FF_MATCHING] = { "pushNonFFMatching", 1 },
60
+ [ADVICE_PUSH_REF_NEEDS_UPDATE] = { "pushRefNeedsUpdate", 1 },
61
[ADVICE_PUSH_UNQUALIFIED_REF_NAME] = { "pushUnqualifiedRefName", 1 },
62
[ADVICE_PUSH_UPDATE_REJECTED] = { "pushUpdateRejected", 1 },
63
+ [ADVICE_PUSH_UPDATE_REJECTED_ALIAS] = { "pushNonFastForward", 1 }, /* backwards compatibility */
64
[ADVICE_RESET_NO_REFRESH_WARNING] = { "resetNoRefresh", 1 },
65
[ADVICE_RESOLVE_CONFLICT] = { "resolveConflict", 1 },
66
[ADVICE_RM_HINTS] = { "rmHints", 1 },
@@ -74,8 +70,9 @@ static struct {
70
[ADVICE_STATUS_AHEAD_BEHIND_WARNING] = { "statusAheadBehindWarning", 1 },
71
[ADVICE_STATUS_HINTS] = { "statusHints", 1 },
72
[ADVICE_STATUS_U_OPTION] = { "statusUoption", 1 },
77
- [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
73
[ADVICE_SUBMODULES_NOT_UPDATED] = { "submodulesNotUpdated", 1 },
74
+ [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
75
+ [ADVICE_SUGGEST_DETACHING_HEAD] = { "suggestDetachingHead", 1 },
76
[ADVICE_UPDATE_SPARSE_PATH] = { "updateSparsePath", 1 },
77
[ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 },
78
[ADVICE_WORKTREE_ADD_ORPHAN] = { "worktreeAddOrphan", 1 },
advice.h
+6
-6
@@ -14,13 +14,12 @@ struct string_list;
14
ADVICE_ADD_EMBEDDED_REPO,
15
ADVICE_ADD_EMPTY_PATHSPEC,
16
ADVICE_ADD_IGNORED_FILE,
17
- ADVICE_AM_WORK_DIR,
17
ADVICE_AMBIGUOUS_FETCH_REFSPEC,
18
+ ADVICE_AM_WORK_DIR,
19
ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
20
ADVICE_COMMIT_BEFORE_MERGE,
21
ADVICE_DETACHED_HEAD,
22
ADVICE_DIVERGING,
23
- ADVICE_SUGGEST_DETACHING_HEAD,
23
ADVICE_FETCH_SHOW_FORCED_UPDATES,
24
ADVICE_GRAFT_FILE_DEPRECATED,
25
ADVICE_IGNORED_HOOK,
@@ -32,23 +31,24 @@ struct string_list;
31
ADVICE_PUSH_NEEDS_FORCE,
32
ADVICE_PUSH_NON_FF_CURRENT,
33
ADVICE_PUSH_NON_FF_MATCHING,
34
+ ADVICE_PUSH_REF_NEEDS_UPDATE,
35
ADVICE_PUSH_UNQUALIFIED_REF_NAME,
36
- ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
36
ADVICE_PUSH_UPDATE_REJECTED,
38
- ADVICE_PUSH_REF_NEEDS_UPDATE,
37
+ ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
38
ADVICE_RESET_NO_REFRESH_WARNING,
39
ADVICE_RESOLVE_CONFLICT,
40
ADVICE_RM_HINTS,
41
ADVICE_SEQUENCER_IN_USE,
42
ADVICE_SET_UPSTREAM_FAILURE,
43
+ ADVICE_SKIPPED_CHERRY_PICKS,
44
ADVICE_STATUS_AHEAD_BEHIND_WARNING,
45
ADVICE_STATUS_HINTS,
46
ADVICE_STATUS_U_OPTION,
47
- ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
47
ADVICE_SUBMODULES_NOT_UPDATED,
48
+ ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
49
+ ADVICE_SUGGEST_DETACHING_HEAD,
50
ADVICE_UPDATE_SPARSE_PATH,
51
ADVICE_WAITING_FOR_EDITOR,
51
- ADVICE_SKIPPED_CHERRY_PICKS,
52
ADVICE_WORKTREE_ADD_ORPHAN,
53
};
54