From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Matheus Tavares" <matheus.bernardino@usp.br>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v4 0/9] docs: de-duplicate sections, add more CONFIGURATION sections
Date: Wed, 7 Sep 2022 10:26:56 +0200 [thread overview]
Message-ID: <cover-v4-0.9-00000000000-20220907T082419Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-v3-0.9-00000000000-20220831T083759Z-avarab@gmail.com>
This series:
* De-duplicates and combines configuration discussion that was split
or spread across Documentation/config/*.txt and
Documentation/git-*.txt, moving it to Documentation/config/*.txt.
* Includes that relevant Documentation/config/*.txt in the
Documentation/git-*.txt files.
* Introduces and uses included prose for those "CONFIGURATION"
sections in various Documentation/git-*.txt files, informing the
reader that what they see there is included from "git-config(1)".
This v4 addresses the feedback from Matheus Tavares on v3 (thanks for
the review!): A hunk belonged in 9/9, not 8/9 (init's config is used
by e.g. "clone" too). The end-state at the end of this series is
exactly the same.
1. https://lore.kernel.org/git/CAHd-oW4QpPBUqo5ToWXtBg7-LHbEam7aqSALSrwaA3OABma8ng@mail.gmail.com/
Ævar Arnfjörð Bjarmason (9):
docs: add and use include template for config/* includes
grep docs: de-duplicate configuration sections
send-email docs: de-duplicate configuration sections
apply docs: de-duplicate configuration sections
notes docs: de-duplicate and combine configuration sections
difftool docs: de-duplicate configuration sections
log docs: de-duplicate configuration sections
docs: add CONFIGURATION sections that map to a built-in
docs: add CONFIGURATION sections that fuzzy map to built-ins
Documentation/Makefile | 1 +
Documentation/config/diff.txt | 15 -----
Documentation/config/difftool.txt | 28 +++++++++-
Documentation/config/grep.txt | 7 ++-
Documentation/config/log.txt | 4 ++
Documentation/config/notes.txt | 43 +++++++++------
Documentation/config/sendemail.txt | 40 +++++++++++++-
Documentation/git-add.txt | 7 +++
Documentation/git-am.txt | 7 +++
Documentation/git-apply.txt | 10 +---
Documentation/git-blame.txt | 6 ++
Documentation/git-branch.txt | 4 ++
Documentation/git-checkout.txt | 7 +++
Documentation/git-clean.txt | 7 +++
Documentation/git-clone.txt | 9 +++
Documentation/git-column.txt | 7 +++
Documentation/git-commit-graph.txt | 7 +++
Documentation/git-commit.txt | 4 ++
Documentation/git-diff.txt | 7 +++
Documentation/git-difftool.txt | 27 ++-------
Documentation/git-fast-import.txt | 7 +++
Documentation/git-fetch.txt | 7 +++
Documentation/git-fsck.txt | 2 +
Documentation/git-gc.txt | 3 +-
Documentation/git-grep.txt | 29 +---------
Documentation/git-imap-send.txt | 2 +
Documentation/git-init.txt | 7 +++
Documentation/git-log.txt | 46 ++--------------
Documentation/git-mailinfo.txt | 7 +++
Documentation/git-maintenance.txt | 7 +++
Documentation/git-merge.txt | 5 +-
Documentation/git-mergetool.txt | 3 +
Documentation/git-notes.txt | 55 ++-----------------
Documentation/git-push.txt | 7 +++
Documentation/git-rebase.txt | 2 +
Documentation/git-revert.txt | 7 +++
Documentation/git-send-email.txt | 36 +-----------
Documentation/git-show-branch.txt | 7 +++
Documentation/git-stash.txt | 7 +++
Documentation/git-switch.txt | 7 +++
.../includes/cmd-config-section-all.txt | 3 +
.../includes/cmd-config-section-rest.txt | 3 +
42 files changed, 280 insertions(+), 226 deletions(-)
create mode 100644 Documentation/includes/cmd-config-section-all.txt
create mode 100644 Documentation/includes/cmd-config-section-rest.txt
Range-diff against v3:
1: da21c19978c = 1: ddcae390002 docs: add and use include template for config/* includes
2: d16e927caa2 = 2: e5ad838e1d7 grep docs: de-duplicate configuration sections
3: c36feb6f35a = 3: f73c148a06e send-email docs: de-duplicate configuration sections
4: 5707c9dd635 = 4: 5523095fe7e apply docs: de-duplicate configuration sections
5: 5b0ea00aa33 = 5: 9f1b90298d8 notes docs: de-duplicate and combine configuration sections
6: c4c3fa14190 = 6: 73e6804db13 difftool docs: de-duplicate configuration sections
7: e07585ba085 = 7: 6465a98ec0a log docs: de-duplicate configuration sections
8: af912e9ca65 ! 8: 929fd693bdf docs: add CONFIGURATION sections that map to a built-in
@@ Documentation/git-fast-import.txt: operator can use this facility to peek at the
--------
linkgit:git-fast-export[1]
- ## Documentation/git-init.txt ##
-@@ Documentation/git-init.txt: $ git commit <3>
- <2> Add all existing files to the index.
- <3> Record the pristine state as the first commit in the history.
-
-+CONFIGURATION
-+-------------
-+
-+include::includes/cmd-config-section-all.txt[]
-+
-+include::config/init.txt[]
-+
- GIT
- ---
- Part of the linkgit:git[1] suite
-
## Documentation/git-mailinfo.txt ##
@@ Documentation/git-mailinfo.txt: If no such configuration option has been set, `warn` will be used.
<patch>::
9: 5ef36654bba ! 9: 738ee46512d docs: add CONFIGURATION sections that fuzzy map to built-ins
@@ Documentation/git-fetch.txt: linkgit:git-gc[1]).
----
Using --recurse-submodules can only fetch new commits in submodules that are
+ ## Documentation/git-init.txt ##
+@@ Documentation/git-init.txt: $ git commit <3>
+ <2> Add all existing files to the index.
+ <3> Record the pristine state as the first commit in the history.
+
++CONFIGURATION
++-------------
++
++include::includes/cmd-config-section-all.txt[]
++
++include::config/init.txt[]
++
+ GIT
+ ---
+ Part of the linkgit:git[1] suite
+
## Documentation/git-switch.txt ##
@@ Documentation/git-switch.txt: always create a new name for it (without switching away):
$ git switch -c good-surprises
--
2.37.3.1490.g9adf4224da0
next prev parent reply other threads:[~2022-09-07 8:27 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-14 17:44 [PATCH 0/3] doc: unify config info on some cmds Matheus Tavares
2022-07-14 17:44 ` [PATCH 1/3] doc: grep: unify configuration variables definitions Matheus Tavares
2022-07-14 18:46 ` Junio C Hamano
2022-07-14 17:44 ` [PATCH 2/3] doc: apply: " Matheus Tavares
2022-07-14 18:48 ` Junio C Hamano
2022-07-14 17:44 ` [PATCH 3/3] doc: notes: " Matheus Tavares
2022-07-14 19:45 ` Junio C Hamano
2022-07-14 21:17 ` [PATCH 0/3] doc: unify config info on some cmds Ævar Arnfjörð Bjarmason
2022-07-15 19:58 ` Matheus Tavares
2022-07-16 7:53 ` Ævar Arnfjörð Bjarmason
2022-07-17 17:13 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Ævar Arnfjörð Bjarmason
2022-07-29 8:25 ` [PATCH v2 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-07-30 13:29 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-07-30 13:31 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-07-30 13:45 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 4/9] apply " Ævar Arnfjörð Bjarmason
2022-07-30 13:50 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 5/9] notes " Ævar Arnfjörð Bjarmason
2022-07-30 20:02 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 6/9] difftool " Ævar Arnfjörð Bjarmason
2022-07-30 14:09 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 7/9] log " Ævar Arnfjörð Bjarmason
2022-07-30 18:52 ` Matheus Tavares
2022-07-29 8:25 ` [PATCH v2 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-07-29 21:58 ` Junio C Hamano
2022-07-29 8:25 ` [PATCH v2 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-07-29 22:03 ` Junio C Hamano
2022-07-30 19:08 ` Matheus Tavares
2022-07-30 20:44 ` Junio C Hamano
2022-07-30 20:05 ` [PATCH v2 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-08-31 8:41 ` [PATCH v3 " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 4/9] apply " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 5/9] notes docs: de-duplicate and combine " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 6/9] difftool docs: de-duplicate " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 7/9] log " Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-08-31 8:41 ` [PATCH v3 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-09-03 13:29 ` [PATCH v3 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-09-07 8:26 ` Ævar Arnfjörð Bjarmason [this message]
2022-09-07 8:26 ` [PATCH v4 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-09-07 8:26 ` [PATCH v4 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-09-07 8:26 ` [PATCH v4 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 4/9] apply " Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 5/9] notes docs: de-duplicate and combine " Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 6/9] difftool docs: de-duplicate " Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 7/9] log " Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-09-07 8:27 ` [PATCH v4 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-09-07 11:51 ` [PATCH v4 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-09-07 16:45 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover-v4-0.9-00000000000-20220907T082419Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=matheus.bernardino@usp.br \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).