summaryrefslogtreecommitdiff
path: root/Documentation/Makefile
diff options
context:
space:
mode:
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>2022-08-04 16:28:33 (GMT)
committerJunio C Hamano <gitster@pobox.com>2022-08-04 21:12:23 (GMT)
commitd976c5100fb5f55f648d8b400bcbda1116b82dec (patch)
treeee65ead55c91dbbd75b44b52c9cf3ce0a6dce9af /Documentation/Makefile
parentdba1e5392f431e57d6a8daacf879a255b49d57fb (diff)
downloadgit-d976c5100fb5f55f648d8b400bcbda1116b82dec.zip
git-d976c5100fb5f55f648d8b400bcbda1116b82dec.tar.gz
git-d976c5100fb5f55f648d8b400bcbda1116b82dec.tar.bz2
git docs: add a category for user-facing file, repo and command UX
Create a new "Repository, command and file interfaces" section in the main "git help git" manual page. Move things that belong under this new criteria from the generic "Guides" section. The "Guides" section was added in f442f28a81b (git.txt: add list of guides, 2020-08-05). It makes sense to have e.g. "giteveryday(7)" and "gitfaq(7)" listed under "Guides". But placing e.g. "gitignore(5)" in it is stretching the meaning of what a "guide" is, ideally that section should list things similar to "giteveryday(7)" and "gitcore-tutorial(7)". An alternate name that was considered for this new section was "User formats", for consistency with the nomenclature used for man section 5 in general. My man(1) lists it as "File formats and conventions, e.g. /etc/passwd". So calling this "git help --formats" or "git help --user-formats" would make sense for e.g. gitignore(5), but would be stretching it somewhat for githooks(5), and would seem really suspect for the likes of gitcli(7). Let's instead pick a name that's closer to the generic term "User interface", which is really what this documentation discusses: General user-interface documentation that doesn't obviously belong elsewhere. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/Makefile')
-rw-r--r--Documentation/Makefile1
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 4f801f4..28eb940 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -290,6 +290,7 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
cmds-synchingrepositories.txt \
cmds-synchelpers.txt \
cmds-guide.txt \
+ cmds-userinterfaces.txt \
cmds-purehelpers.txt \
cmds-foreignscminterface.txt