summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2020-07-05 23:17:35 -0230
committerTim Oram <dev@mitmaro.ca>2020-07-06 22:49:43 -0230
commitbce966812a2d7a17a50174f800ae31f8fda069da (patch)
tree6de46edcfd84c906d3ba9f27c72802175cc5d2da /README.md
parentd2a5162ea461b5e3215f7b5d80e3449b62757d81 (diff)
Improve show commit module
This change refactors and improves the show commit module. This change added: - key bindings/help displayed on the last line - list of number of files changed as well as the number of additions and deletions - git configuration for renames, rename_limit and copies now respected - full help page This change refactored: - input handling to be specific to the show commit module - rewritten how git diff information is queried from the git2-rs bindings - new ViewDataBuilder struct for building the view lines
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index e9a477f..68ae779 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,22 @@ instead. String values are case-insensitive.
git config --global interactive-rebase-tool.foregroundColor black
```
+#### Git configuration
+
+Some values from your Git Config are directly used by this application.
+
+| Key | Description |
+| ------------------------------------- | ----------- |
+| [`core.commentChar`][coreCommentChar] | Read when reading the TODO file to excluded commented lines |
+| [`core.editor`][coreEditor] | Read when deciding what editor to open when trigger the external editor |
+| [`diff.renames`][diffRenames] | Used by show commit when generating a diff |
+| [`diff.renameLimit`][diffRenameLimit] | 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
+[diffRenames]:https://git-scm.com/docs/diff-config/#Documentation/diff-config.txt-diffrenames
+[diffRenameLimit]:https://git-scm.com/docs/diff-config/#Documentation/diff-config.txt-diffrenameLimit
+
#### General
| Key | Default | Type | Description |