Skip to content

Commit 946a9f2

Browse files
liambeguingitster
authored andcommitted
Documentation: move rebase.* configs to new file
Move all rebase.* configuration variables to a separate file in order to remove duplicates, and include it in config.txt and git-rebase.txt. The new descriptions are mostly taken from config.txt as they are more verbose. Signed-off-by: Liam Beguin <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1a4e40a commit 946a9f2

File tree

3 files changed

+34
-48
lines changed

3 files changed

+34
-48
lines changed

Documentation/config.txt

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2691,36 +2691,7 @@ push.recurseSubmodules::
26912691
is retained. You may override this configuration at time of push by
26922692
specifying '--recurse-submodules=check|on-demand|no'.
26932693

2694-
rebase.stat::
2695-
Whether to show a diffstat of what changed upstream since the last
2696-
rebase. False by default.
2697-
2698-
rebase.autoSquash::
2699-
If set to true enable `--autosquash` option by default.
2700-
2701-
rebase.autoStash::
2702-
When set to true, automatically create a temporary stash entry
2703-
before the operation begins, and apply it after the operation
2704-
ends. This means that you can run rebase on a dirty worktree.
2705-
However, use with care: the final stash application after a
2706-
successful rebase might result in non-trivial conflicts.
2707-
Defaults to false.
2708-
2709-
rebase.missingCommitsCheck::
2710-
If set to "warn", git rebase -i will print a warning if some
2711-
commits are removed (e.g. a line was deleted), however the
2712-
rebase will still proceed. If set to "error", it will print
2713-
the previous warning and stop the rebase, 'git rebase
2714-
--edit-todo' can then be used to correct the error. If set to
2715-
"ignore", no checking is done.
2716-
To drop a commit without warning or error, use the `drop`
2717-
command in the todo-list.
2718-
Defaults to "ignore".
2719-
2720-
rebase.instructionFormat::
2721-
A format string, as specified in linkgit:git-log[1], to be used for
2722-
the instruction list during an interactive rebase. The format will automatically
2723-
have the long commit hash prepended to the format.
2694+
include::rebase-config.txt[]
27242695

27252696
receive.advertiseAtomic::
27262697
By default, git-receive-pack will advertise the atomic push

Documentation/git-rebase.txt

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -203,24 +203,7 @@ Alternatively, you can undo the 'git rebase' with
203203
CONFIGURATION
204204
-------------
205205

206-
rebase.stat::
207-
Whether to show a diffstat of what changed upstream since the last
208-
rebase. False by default.
209-
210-
rebase.autoSquash::
211-
If set to true enable `--autosquash` option by default.
212-
213-
rebase.autoStash::
214-
If set to true enable `--autostash` option by default.
215-
216-
rebase.missingCommitsCheck::
217-
If set to "warn", print warnings about removed commits in
218-
interactive mode. If set to "error", print the warnings and
219-
stop the rebase. If set to "ignore", no checking is
220-
done. "ignore" by default.
221-
222-
rebase.instructionFormat::
223-
Custom commit list format to use during an `--interactive` rebase.
206+
include::rebase-config.txt[]
224207

225208
OPTIONS
226209
-------

Documentation/rebase-config.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
rebase.stat::
2+
Whether to show a diffstat of what changed upstream since the last
3+
rebase. False by default.
4+
5+
rebase.autoSquash::
6+
If set to true enable `--autosquash` option by default.
7+
8+
rebase.autoStash::
9+
When set to true, automatically create a temporary stash entry
10+
before the operation begins, and apply it after the operation
11+
ends. This means that you can run rebase on a dirty worktree.
12+
However, use with care: the final stash application after a
13+
successful rebase might result in non-trivial conflicts.
14+
This option can be overridden by the `--no-autostash` and
15+
`--autostash` options of linkgit:git-rebase[1].
16+
Defaults to false.
17+
18+
rebase.missingCommitsCheck::
19+
If set to "warn", git rebase -i will print a warning if some
20+
commits are removed (e.g. a line was deleted), however the
21+
rebase will still proceed. If set to "error", it will print
22+
the previous warning and stop the rebase, 'git rebase
23+
--edit-todo' can then be used to correct the error. If set to
24+
"ignore", no checking is done.
25+
To drop a commit without warning or error, use the `drop`
26+
command in the todo-list.
27+
Defaults to "ignore".
28+
29+
rebase.instructionFormat::
30+
A format string, as specified in linkgit:git-log[1], to be used for the
31+
instruction list during an interactive rebase. The format will
32+
automatically have the long commit hash prepended to the format.

0 commit comments

Comments
 (0)