summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2022-04-21 09:46:37 -0230
committerTim Oram <dev@mitmaro.ca>2022-04-21 09:58:23 -0230
commit7d02adfe2105950b0300282675370fd3d828f5bb (patch)
treefd9d2e13cd50d0b160fd0d05d3d551d12ffe3535
parente89af69d580cdd850c3747a1ebe4f80ee6a7408d (diff)
Fix documentation issues
-rw-r--r--readme/customization.md185
1 files changed, 98 insertions, 87 deletions
diff --git a/readme/customization.md b/readme/customization.md
index d006892..8a7e73d 100644
--- a/readme/customization.md
+++ b/readme/customization.md
@@ -21,14 +21,14 @@ The tool can be customized using the [git config](https://git-scm.com/docs/git-c
Some values from your Git Config are directly used by this application.
-| Key | Description |
-| -------------------------------------------- | ----------- |
-| [`core.commentChar`][coreCommentChar] | Used when reading the TODO file to excluded commented lines |
+| Key | Description |
+| -------------------------------------------- |-------------------------------------------------------------------------|
+| [`core.commentChar`][coreCommentChar] | Used when reading the TODO file to excluded commented lines |
| [`core.editor`][coreEditor] | Used when deciding what editor to open when trigger the external editor |
-| [`diff.context`][diffContext] | Used by show commit when generating a diff |
-| [`diff.interhunk_lines`][diffInterhunkLines] | Used by show commit when generating a diff |
-| [`diff.renameLimit`][diffRenameLimit] | Used by show commit when generating a diff |
-| [`diff.renames`][diffRenames] | Used by show commit when generating a diff |
+| [`diff.context`][diffContext] | Used by show commit when generating a diff |
+| [`diff.interHunkContext`][diffInterhunkLines] | Used by show commit when generating a diff |
+| [`diff.renameLimit`][diffRenameLimit] | Used by show commit when generating a diff |
+| [`diff.renames`][diffRenames] | Used by show commit when generating a diff |
[coreCommentChar]:https://git-scm.com/docs/git-config#Documentation/git-config.txt-corecommentChar
[coreEditor]:https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreeditor
@@ -39,16 +39,16 @@ Some values from your Git Config are directly used by this application.
## General
-| Key | Default | Type | Description |
-| -------------------------- | ------- | ------- | ----------- |
-| `autoSelectNext` | false | bool | If true, auto select the next line after action modification |
-| `diffIgnoreWhitespace` | none | String¹ | The width of the tab character |
-| `diffShowWhitespace` | both | String² | The width of the tab character |
+| Key | Default | Type | Description |
+| -------------------------- | ------- | ------- |---------------------------------------------------------------------------------------------|
+| `autoSelectNext` | false | bool | If true, auto select the next line after action modification |
+| `diffIgnoreWhitespace` | none | String¹ | If and how to ignore whitespace during diff. |
+| `diffShowWhitespace` | both | String² | If and how to show whitespace during diff. |
| `diffSpaceSymbol` | · | String | The visible symbol for the space character. Only used when `diffShowWhitespace` is enabled. |
-| `diffTabSymbol` | → | String | The visible symbol for the tab character. Only used when `diffShowWhitespace` is enabled. |
-| `diffTabWidth` | 4 | Integer | The width of the tab character |
-| `undoLimit` | 5000 | Integer | Number of undo operations to store. |
-| `verticalSpacingCharacter` | ~ | String | Vertical spacing character. Can be set to an empty string. |
+| `diffTabSymbol` | → | String | The visible symbol for the tab character. Only used when `diffShowWhitespace` is enabled. |
+| `diffTabWidth` | 4 | Integer | The width of the tab character |
+| `undoLimit` | 5000 | Integer | Number of undo operations to store. |
+| `verticalSpacingCharacter` | ~ | String | Vertical spacing character. Can be set to an empty string. |
¹ Ignore whitespace can be:
- `change` to ignore changed whitespace in diffs, same as the [`--ignore-space-change`][diffIgnoreSpaceChange] flag
@@ -70,93 +70,104 @@ The valid colors are the [eight original 8 ANSI colors][ANSIColors]. They are `b
[ANSIColors]:https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit
-| Key | Default | Type | Description |
-| ------------------------- | ----------- | ----- | ----------- |
-| `breakColor` | white | Color | Color used for the break action |
-| `diffAddColor` | green | Color | Color used for lines and files added in a diff |
-| `diffChangeColor` | yellow | Color | Color used for lines and files changed in a diff |
-| `diffRemoveColor` | red | Color | Color used for lines and files removed in a diff |
-| `diffContextColor` | white | Color | Color used for lines and files removed in a diff |
-| `diffWhitespace` | black | Color | Color used for lines and files removed in a diff |
-| `dropColor` | red | Color | Color used for the drop action |
-| `editColor` | blue | Color | Color used for the edit action |
-| `fixupColor` | magenta | Color | Color used for the fixup action |
-| `foregroundColor` | white | Color | Color used for most text and the UI |
-| `indicatorColor` | cyan | Color | Color used for text the indicates or needs to standout |
-| `pickColor` | green | Color | Color used for the pick action |
-| `rewordColor` | yellow | Color | Color used for the reword action |
+| Key | Default | Type | Description |
+| ------------------------- | ----------- | ----- |----------------------------------------------------------|
+| `breakColor` | white | Color | Color used for the break action |
+| `diffAddColor` | green | Color | Color used for lines and files added in a diff |
+| `diffChangeColor` | yellow | Color | Color used for lines and files changed in a diff |
+| `diffRemoveColor` | red | Color | Color used for lines and files removed in a diff |
+| `diffContextColor` | white | Color | Color used for lines and files removed in a diff |
+| `diffWhitespace` | black | Color | Color used for lines and files removed in a diff |
+| `dropColor` | red | Color | Color used for the drop action |
+| `editColor` | blue | Color | Color used for the edit action |
+| `fixupColor` | magenta | Color | Color used for the fixup action |
+| `foregroundColor` | white | Color | Color used for most text and the UI |
+| `indicatorColor` | cyan | Color | Color used for text the indicates or needs to standout |
+| `pickColor` | green | Color | Color used for the pick action |
+| `rewordColor` | yellow | Color | Color used for the reword action |
| `selectedBackgroundColor` | 35,35,40 | Color | Color used as the background color for the selected line |
-| `squashColor` | cyan | Color | Color used for the squash action |
-| `labelColor` | dark yellow | Color | Color used for the squash action |
-| `resetColor` | dark yellow | Color | Color used for the squash action |
-| `mergeColor` | dark yellow | Color | Color used for the squash action |
+| `squashColor` | cyan | Color | Color used for the squash action |
+| `labelColor` | dark yellow | Color | Color used for the squash action |
+| `resetColor` | dark yellow | Color | Color used for the squash action |
+| `mergeColor` | dark yellow | Color | Color used for the squash action |
## Key Bindings
Most keys can be changed to any printable character or supported special character. It is possible to provide conflicting bindings, which will result in undefined behaviour. The `inputConfirmYes` binding has a special behaviour in that it responds to both the uppercase and lowercase letter of the value set, if the variant exist.
-| Key | Default | Type | Description |
-| -------------------------- | -------- | ------ | ----------- |
-| `inputAbort` | q | String | Key for abort rebase with prompt |
-| `inputActionBreak` | b | String | Key for setting action to rebase |
-| `inputActionDrop` | d | String | Key for setting action to drop |
-| `inputActionEdit` | e | String | Key for setting action to edit |
-| `inputActionFixup` | f | String | Key for setting action to fixup |
-| `inputActionPick` | p | String | Key for setting action to pick |
-| `inputActionReword` | r | String | Key for setting action to reword |
-| `inputActionSquash` | s | String | Key for setting action to squash |
-| `inputConfirmNo` | n | String | Key for rejecting a confirmation |
-| `inputConfirmYes` | y | String | Key for confirming a confirmation |
-| `inputEdit` | E | String | Key for entering edit mode |
-| `inputForceAbort` | Q | String | Key for forcing an abort of the rebase |
-| `inputForceRebase` | W | String | Key for forcing a rebase |
-| `inputHelp` | ? | String | Key for showing the help |
-| `inputInsertLine` | I | String | Key for inserting a new line |
-| `inputMoveDown` | Down | String | Key for moving the cursor down |
-| `inputMoveEnd` | End | String | Key for moving the cursor to the end of the list |
-| `inputMoveHome` | Home | String | Key for moving the cursor to the top of the list |
-| `inputMoveLeft` | Left | String | Key for moving the cursor left |
-| `inputMoveRight` | Right | String | Key for moving the cursor right |
-| `inputMoveSelectionDown` | j | String | Key for moving the selected line(s) down |
-| `inputMoveSelectionUp` | k | String | Key for moving the selected line(s) up |
-| `inputMoveStepDown` | PageDown | String | Key for moving the cursor down by a large step |
-| `inputMoveStepUp` | PageUp | String | Key for moving the cursor up by a large step|
-| `inputMoveUp` | Up | String | Key for moving the cursor up |
-| `inputOpenInExternalEditor`| ! | String | Key for opening the external editor |
-| `inputRebase` | w | String | Key for rebasing with confirmation |
-| `inputRedo` | Control+y| String | Key for redoing the previous undone change |
-| `inputRemoveLine` | Delete | String | Key for removing selected commits |
-| `inputShowCommit` | c | String | Key for showing the overview of the selected commit |
-| `inputShowDiff` | d | String | Key for showing the diff of the selected commit |
-| `inputToggleVisualMode` | v | String | Key for toggling visual mode |
-| `inputUndo` | Control+z| String | Key for undoing the previous change |
+| Key | Default | Type | Description |
+|-----------------------------|-----------|--------|-----------------------------------------------------|
+| `inputAbort` | q | String | Key for abort rebase with prompt |
+| `inputActionBreak` | b | String | Key for setting action to rebase |
+| `inputActionDrop` | d | String | Key for setting action to drop |
+| `inputActionEdit` | e | String | Key for setting action to edit |
+| `inputActionFixup` | f | String | Key for setting action to fixup |
+| `inputActionPick` | p | String | Key for setting action to pick |
+| `inputActionReword` | r | String | Key for setting action to reword |
+| `inputActionSquash` | s | String | Key for setting action to squash |
+| `inputConfirmNo` | n | String | Key for rejecting a confirmation |
+| `inputConfirmYes` | y | String | Key for confirming a confirmation |
+| `inputEdit` | E | String | Key for entering edit mode |
+| `inputForceAbort` | Q | String | Key for forcing an abort of the rebase |
+| `inputForceRebase` | W | String | Key for forcing a rebase |
+| `inputHelp` | ? | String | Key for showing the help |
+| `inputInsertLine` | I | String | Key for inserting a new line |
+| `inputMoveDown` | Down | String | Key for moving the cursor down |
+| `inputMoveEnd` | End | String | Key for moving the cursor to the end of the list |
+| `inputMoveHome` | Home | String | Key for moving the cursor to the top of the list |
+| `inputMoveLeft` | Left | String | Key for moving the cursor left |
+| `inputMoveRight` | Right | String | Key for moving the cursor right |
+| `inputMoveSelectionDown` | j | String | Key for moving the selected line(s) down |
+| `inputMoveSelectionUp` | k | String | Key for moving the selected line(s) up |
+| `inputMoveStepDown` | PageDown | String | Key for moving the cursor down by a large step |
+| `inputMoveStepUp` | PageUp | String | Key for moving the cursor up by a large step |
+| `inputMoveUp` | Up | String | Key for moving the cursor up |
+| `inputOpenInExternalEditor` | ! | String | Key for opening the external editor |
+| `inputRebase` | w | String | Key for rebasing with confirmation |
+| `inputRedo` | Control+y | String | Key for redoing the previous undone change |
+| `inputScrollDown` | Down | String | Key for scrolling the view down |
+| `inputScrollEnd` | End | String | Key for scrolling the view to the bottom |
+| `inputScrollHome` | Home | String | Key for scrolling the view to the top |
+| `inputScrollLeft` | Left | String | Key for scrolling the view to the left |
+| `inputScrollRight` | Right | String | Key for scrolling the view to the right |
+| `inputScrollUp` | Up | String | Key for scrolling the view to the up |
+| `inputScrollStepDown` | PageDown | String | Key for scrolling the view one step down |
+| `inputScrollStepUp` | PageUp | String | Key for scrolling the view one step up |
+| `inputRemoveLine` | Delete | String | Key for removing selected commits |
+| `inputShowCommit` | c | String | Key for showing the overview of the selected commit |
+| `inputShowDiff` | d | String | Key for showing the diff of the selected commit |
+| `inputToggleVisualMode` | v | String | Key for toggling visual mode |
+| `inputUndo` | Control+z | String | Key for undoing the previous change |
### Example
+ # single value
git config --global interactive-rebase-tool.inputRebase S
+ # multiple values
+ git config --global interactive-rebase-tool.inputRebase "S L K"
### Supported Special Keys
Keys that do not have easily printable characters, such as the arrow keys, are set using the special values defined in the table below. Some special keys do not work correctly on some setups.
-| Key | Description |
-| ------------------ | ----------- |
-| `Backspace` | Backspace key |
-| `BackTab` | Back tab key |
-| `Delete` | Delete key
-| `Down` | Down arrow key |
-| `End` | End key |
-| `Enter` | Enter key |
-| `Esc` | Escape key |
-| `F{1..255}` | Function X key |
-| `Home` | Home key |
-| `Insert` | Insert key |
-| `Left` | Left arrow key |
-| `PageDown` | Page down key |
-| `PageUp` | Page up key |
+| Key | Description |
+| ------------------ |-----------------|
+| `Backspace` | Backspace key |
+| `BackTab` | Back tab key |
+| `Delete` | Delete key |
+| `Down` | Down arrow key |
+| `End` | End key |
+| `Enter` | Enter key |
+| `Esc` | Escape key |
+| `F{1..255}` | Function X key |
+| `Home` | Home key |
+| `Insert` | Insert key |
+| `Left` | Left arrow key |
+| `PageDown` | Page down key |
+| `PageUp` | Page up key |
| `Right` | Right arrow key |
-| `Tab` | Tab key |
-| `Up` | Up arrow key |
+| `Tab` | Tab key |
+| `Up` | Up arrow key |
### Modifier Keys