[PATCH 0/3] doc: unify config info on some cmds
- From
Matheus Tavares <matheus.bernardino@usp.br>
- Date
- Jul 14, 2022, 17:44 UTC
- Message-ID
- <cover.1657819649.git.matheus.bernardino@usp.br>
These three patches attempt to remove duplication between some config/*.txt and git-*.txt files, to facilitate maintenance and fix any divergences.
This series targets the most straightforward conversions, but there are also other commands whose config documentation could possibly be unified (maybe #leftoverbits):
- git-log.txt and config/log.txt have some duplications, but with different wordings, which could probably be standardized.
- git-send-email.txt has some config definitions "inlined" with the descriptions about the CLI options (e.g. sendemail.xmailer). Not sure if it is worth unifying the configs in this case.
- Some cmds like format-patch, status, and branch have some config variables defined at config/*, but not at git-*.txt. Maybe the latter could mention something like "See the full list of available <cmd>.* configuration variables at git-config(1)."
Matheus Tavares (3): doc: grep: unify configuration variables definitions doc: apply: unify configuration variables definitions doc: notes: unify configuration variables definitions
Documentation/config/apply.txt | 7 +++- Documentation/config/grep.txt | 10 ++++-- Documentation/config/notes.txt | 62 ++++++++++++++++------------------ Documentation/git-apply.txt | 9 ++--- Documentation/git-grep.txt | 37 ++++---------------- Documentation/git-notes.txt | 54 ++--------------------------- 6 files changed, 53 insertions(+), 126 deletions(-)
-- 2.37.0