Skip to content

doc: unify config info on some cmds

Matheus Tavares git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 7 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3doc: grep: unify configuration variables definitionsDocumentation/config/grep.txt Documentation/git-grep.txt+14 -331 reply
2/3doc: apply: unify configuration variables definitionsDocumentation/config/apply.txt Documentation/git-apply.txt+8 -81 reply
3/3doc: notes: unify configuration variables definitionsDocumentation/config/notes.txt Documentation/git-notes.txt+31 -851 reply

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/3] doc: unify config info on some cmds

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(-)
Signature · 1 line
2.37.0