From 946a9f20b46b6cf8fbfbcc69ed97182f8696bb8d Mon Sep 17 00:00:00 2001 From: Liam Beguin Date: Sun, 3 Dec 2017 17:17:13 -0500 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/config.txt | 31 +------------------------------ Documentation/git-rebase.txt | 19 +------------------ Documentation/rebase-config.txt | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 34 insertions(+), 48 deletions(-) create mode 100644 Documentation/rebase-config.txt (limited to 'Documentation') diff --git a/Documentation/config.txt b/Documentation/config.txt index 531649cb4..e424b7de9 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2691,36 +2691,7 @@ push.recurseSubmodules:: is retained. You may override this configuration at time of push by specifying '--recurse-submodules=check|on-demand|no'. -rebase.stat:: - Whether to show a diffstat of what changed upstream since the last - rebase. False by default. - -rebase.autoSquash:: - If set to true enable `--autosquash` option by default. - -rebase.autoStash:: - When set to true, automatically create a temporary stash entry - before the operation begins, and apply it after the operation - ends. This means that you can run rebase on a dirty worktree. - However, use with care: the final stash application after a - successful rebase might result in non-trivial conflicts. - Defaults to false. - -rebase.missingCommitsCheck:: - If set to "warn", git rebase -i will print a warning if some - commits are removed (e.g. a line was deleted), however the - rebase will still proceed. If set to "error", it will print - the previous warning and stop the rebase, 'git rebase - --edit-todo' can then be used to correct the error. If set to - "ignore", no checking is done. - To drop a commit without warning or error, use the `drop` - command in the todo-list. - Defaults to "ignore". - -rebase.instructionFormat:: - A format string, as specified in linkgit:git-log[1], to be used for - the instruction list during an interactive rebase. The format will automatically - have the long commit hash prepended to the format. +include::rebase-config.txt[] receive.advertiseAtomic:: By default, git-receive-pack will advertise the atomic push diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 3cedfb0fd..8a861c1e0 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -203,24 +203,7 @@ Alternatively, you can undo the 'git rebase' with CONFIGURATION ------------- -rebase.stat:: - Whether to show a diffstat of what changed upstream since the last - rebase. False by default. - -rebase.autoSquash:: - If set to true enable `--autosquash` option by default. - -rebase.autoStash:: - If set to true enable `--autostash` option by default. - -rebase.missingCommitsCheck:: - If set to "warn", print warnings about removed commits in - interactive mode. If set to "error", print the warnings and - stop the rebase. If set to "ignore", no checking is - done. "ignore" by default. - -rebase.instructionFormat:: - Custom commit list format to use during an `--interactive` rebase. +include::rebase-config.txt[] OPTIONS ------- diff --git a/Documentation/rebase-config.txt b/Documentation/rebase-config.txt new file mode 100644 index 000000000..dba088d7c --- /dev/null +++ b/Documentation/rebase-config.txt @@ -0,0 +1,32 @@ +rebase.stat:: + Whether to show a diffstat of what changed upstream since the last + rebase. False by default. + +rebase.autoSquash:: + If set to true enable `--autosquash` option by default. + +rebase.autoStash:: + When set to true, automatically create a temporary stash entry + before the operation begins, and apply it after the operation + ends. This means that you can run rebase on a dirty worktree. + However, use with care: the final stash application after a + successful rebase might result in non-trivial conflicts. + This option can be overridden by the `--no-autostash` and + `--autostash` options of linkgit:git-rebase[1]. + Defaults to false. + +rebase.missingCommitsCheck:: + If set to "warn", git rebase -i will print a warning if some + commits are removed (e.g. a line was deleted), however the + rebase will still proceed. If set to "error", it will print + the previous warning and stop the rebase, 'git rebase + --edit-todo' can then be used to correct the error. If set to + "ignore", no checking is done. + To drop a commit without warning or error, use the `drop` + command in the todo-list. + Defaults to "ignore". + +rebase.instructionFormat:: + A format string, as specified in linkgit:git-log[1], to be used for the + instruction list during an interactive rebase. The format will + automatically have the long commit hash prepended to the format. -- cgit v1.2.1 From f3b633dad4cc54c7cdaa007e97d00b2c935c9a90 Mon Sep 17 00:00:00 2001 From: Liam Beguin Date: Sun, 3 Dec 2017 17:17:14 -0500 Subject: Documentation: use preferred name for the 'todo list' script Use "todo list" instead of "instruction list" or "todo-list" to reduce further confusion regarding the name of this script. Signed-off-by: Liam Beguin Signed-off-by: Junio C Hamano --- Documentation/rebase-config.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/rebase-config.txt b/Documentation/rebase-config.txt index dba088d7c..30ae08cb5 100644 --- a/Documentation/rebase-config.txt +++ b/Documentation/rebase-config.txt @@ -23,10 +23,10 @@ rebase.missingCommitsCheck:: --edit-todo' can then be used to correct the error. If set to "ignore", no checking is done. To drop a commit without warning or error, use the `drop` - command in the todo-list. + command in the todo list. Defaults to "ignore". rebase.instructionFormat:: A format string, as specified in linkgit:git-log[1], to be used for the - instruction list during an interactive rebase. The format will + todo list during an interactive rebase. The format will automatically have the long commit hash prepended to the format. -- cgit v1.2.1 From d8ae6c84da52a210e84b3734bb93c575638236d3 Mon Sep 17 00:00:00 2001 From: Liam Beguin Date: Tue, 5 Dec 2017 12:52:34 -0500 Subject: rebase -i: learn to abbreviate command names `git rebase -i` already know how to interpret single-letter command names. Teach it to generate the todo list with these same abbreviated names. Based-on-patch-by: Johannes Schindelin Signed-off-by: Liam Beguin Signed-off-by: Junio C Hamano --- Documentation/rebase-config.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'Documentation') diff --git a/Documentation/rebase-config.txt b/Documentation/rebase-config.txt index 30ae08cb5..42e1ba757 100644 --- a/Documentation/rebase-config.txt +++ b/Documentation/rebase-config.txt @@ -30,3 +30,23 @@ rebase.instructionFormat:: A format string, as specified in linkgit:git-log[1], to be used for the todo list during an interactive rebase. The format will automatically have the long commit hash prepended to the format. + +rebase.abbreviateCommands:: + If set to true, `git rebase` will use abbreviated command names in the + todo list resulting in something like this: ++ +------------------------------------------- + p deadbee The oneline of the commit + p fa1afe1 The oneline of the next commit + ... +------------------------------------------- ++ +instead of: ++ +------------------------------------------- + pick deadbee The oneline of the commit + pick fa1afe1 The oneline of the next commit + ... +------------------------------------------- ++ +Defaults to false. -- cgit v1.2.1