Skip to content

Commit 1e51ae8

Browse files
committed
Merge branch 'jk/check-docs-update' into maint
* jk/check-docs-update: check-docs: get documented command list from Makefile check-docs: drop git-help special-case check-docs: list git-gui as a command check-docs: factor out command-list command-list: mention git-credential-* helpers command-list: add git-sh-i18n check-docs: update non-command documentation list check-docs: mention gitweb specially
2 parents 6508d03 + 5fafce0 commit 1e51ae8

File tree

6 files changed

+18
-29
lines changed

6 files changed

+18
-29
lines changed

Documentation/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,4 +344,7 @@ require-htmlrepo::
344344
quick-install-html: require-htmlrepo
345345
'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
346346

347+
print-man1:
348+
@for i in $(MAN1_TXT); do echo $$i; done
349+
347350
.PHONY: FORCE

Documentation/git-credential-cache--daemon.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-credential-cache--daemon(1)
33

44
NAME
55
----
6-
git-credential-cache--daemon - temporarily store user credentials in memory
6+
git-credential-cache--daemon - Temporarily store user credentials in memory
77

88
SYNOPSIS
99
--------

Documentation/git-credential-cache.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-credential-cache(1)
33

44
NAME
55
----
6-
git-credential-cache - helper to temporarily store passwords in memory
6+
git-credential-cache - Helper to temporarily store passwords in memory
77

88
SYNOPSIS
99
--------

Documentation/git-credential-store.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-credential-store(1)
33

44
NAME
55
----
6-
git-credential-store - helper to store credentials on disk
6+
git-credential-store - Helper to store credentials on disk
77

88
SYNOPSIS
99
--------

Makefile

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2805,8 +2805,13 @@ endif
28052805

28062806
### Check documentation
28072807
#
2808+
ALL_COMMANDS = $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS)
2809+
ALL_COMMANDS += git
2810+
ALL_COMMANDS += gitk
2811+
ALL_COMMANDS += gitweb
2812+
ALL_COMMANDS += git-gui git-citool
28082813
check-docs::
2809-
@(for v in $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS) git gitk; \
2814+
@(for v in $(ALL_COMMANDS); \
28102815
do \
28112816
case "$$v" in \
28122817
git-merge-octopus | git-merge-ours | git-merge-recursive | \
@@ -2828,35 +2833,13 @@ check-docs::
28282833
sed -e '/^#/d' \
28292834
-e 's/[ ].*//' \
28302835
-e 's/^/listed /' command-list.txt; \
2831-
ls -1 Documentation/git*txt | \
2836+
$(MAKE) -C Documentation print-man1 | \
2837+
grep '\.txt$$' | \
28322838
sed -e 's|Documentation/|documented |' \
28332839
-e 's/\.txt//'; \
28342840
) | while read how cmd; \
28352841
do \
2836-
case "$$how,$$cmd" in \
2837-
*,git-citool | \
2838-
*,git-gui | \
2839-
*,git-help | \
2840-
documented,gitattributes | \
2841-
documented,gitignore | \
2842-
documented,gitmodules | \
2843-
documented,gitcli | \
2844-
documented,git-tools | \
2845-
documented,gitcore-tutorial | \
2846-
documented,gitcvs-migration | \
2847-
documented,gitdiffcore | \
2848-
documented,gitglossary | \
2849-
documented,githooks | \
2850-
documented,gitrepository-layout | \
2851-
documented,gitrevisions | \
2852-
documented,gittutorial | \
2853-
documented,gittutorial-2 | \
2854-
documented,git-bisect-lk2009 | \
2855-
documented,git-remote-helpers | \
2856-
documented,gitworkflows | \
2857-
sentinel,not,matching,is,ok ) continue ;; \
2858-
esac; \
2859-
case " $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS) git gitk " in \
2842+
case " $(ALL_COMMANDS) " in \
28602843
*" $$cmd "*) ;; \
28612844
*) echo "removed but $$how: $$cmd" ;; \
28622845
esac; \

command-list.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ git-commit-tree plumbingmanipulators
2626
git-config ancillarymanipulators
2727
git-count-objects ancillaryinterrogators
2828
git-credential purehelpers
29+
git-credential-cache purehelpers
30+
git-credential-store purehelpers
2931
git-cvsexportcommit foreignscminterface
3032
git-cvsimport foreignscminterface
3133
git-cvsserver foreignscminterface
@@ -114,6 +116,7 @@ git-show mainporcelain common
114116
git-show-branch ancillaryinterrogators
115117
git-show-index plumbinginterrogators
116118
git-show-ref plumbinginterrogators
119+
git-sh-i18n purehelpers
117120
git-sh-setup purehelpers
118121
git-stash mainporcelain
119122
git-status mainporcelain common

0 commit comments

Comments
 (0)