[PATCH] doc: mention GIT_SEQUENCE_EDITOR and 'sequence.editor' more

Philippe Blain via GitGitGadget· Aug 31, 2020, 03:40 UTC · lore

From: Philippe Blain <levraiphilippeblain@gmail.com>

The environment variable `GIT_SEQUENCE_EDITOR`, and the configuration variable 'sequence.editor', which were added in 821881d88d ("rebase -i": support special-purpose editor to edit insn sheet, 2011-10-17), are mentioned in the `git config` man page but not anywhere else.

Include `config/sequencer.txt` in `git-rebase.txt`, so that both the environment variable and the configuration setting are mentioned there.

Also, add `GIT_SEQUENCE_EDITOR` to the list of environment variables in `git(1)`.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
    doc: mention GIT_SEQUENCE_EDITOR and 'sequence.editor' more

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-716%2Fphil-blain%2Fdoc-mention-sequence-editor-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-716/phil-blain/doc-mention-sequence-editor-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/716

 Documentation/git-rebase.txt | 1 +
 Documentation/git.txt        | 6 ++++++
 2 files changed, 7 insertions(+)

Show changes to 2 files +7 −0

Documentation/git-rebase.txt, Documentation/git.txt

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 374d2486f7..9e2f9576c3 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -204,6 +204,7 @@ CONFIGURATION
 -------------
 
 include::config/rebase.txt[]
+include::config/sequencer.txt[]
 
 OPTIONS
 -------
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 2fc92586b5..0bb1cfb239 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -605,6 +605,12 @@ other
 	an editor is to be launched. See also linkgit:git-var[1]
 	and the `core.editor` option in linkgit:git-config[1].
 
+`GIT_SEQUENCE_EDITOR`::
+	This environment variable overrides the configured Git editor
+	when editing the todo list of an interactive rebase. See also
+	linkit::git-rebase[1] and the `sequence.editor` option in
+	linkit::git-config[1].
+
 `GIT_SSH`::
 `GIT_SSH_COMMAND`::
 	If either of these environment variables is set then 'git fetch'

base-commit: d9cd4331470f4d9d78677f12dc79063dab832f53

-- 
gitgitgadget

patchdoc: mention GIT_SEQUENCE_EDITOR and 'sequence.editor' more