Merge branch 'jk/check-docs-update'

Simplify "make check-docs" implementation and update its coverage.

* 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
This commit is contained in:
Junio C Hamano 2012-08-22 11:53:00 -07:00
commit cf8b350da8
6 changed files with 18 additions and 29 deletions

View File

@ -344,4 +344,7 @@ require-htmlrepo::
quick-install-html: require-htmlrepo
'$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REPO) $(DESTDIR)$(htmldir)
print-man1:
@for i in $(MAN1_TXT); do echo $$i; done
.PHONY: FORCE

View File

@ -3,7 +3,7 @@ git-credential-cache--daemon(1)
NAME
----
git-credential-cache--daemon - temporarily store user credentials in memory
git-credential-cache--daemon - Temporarily store user credentials in memory
SYNOPSIS
--------

View File

@ -3,7 +3,7 @@ git-credential-cache(1)
NAME
----
git-credential-cache - helper to temporarily store passwords in memory
git-credential-cache - Helper to temporarily store passwords in memory
SYNOPSIS
--------

View File

@ -3,7 +3,7 @@ git-credential-store(1)
NAME
----
git-credential-store - helper to store credentials on disk
git-credential-store - Helper to store credentials on disk
SYNOPSIS
--------

View File

@ -2805,8 +2805,13 @@ endif
### Check documentation
#
ALL_COMMANDS = $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS)
ALL_COMMANDS += git
ALL_COMMANDS += gitk
ALL_COMMANDS += gitweb
ALL_COMMANDS += git-gui git-citool
check-docs::
@(for v in $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS) git gitk; \
@(for v in $(ALL_COMMANDS); \
do \
case "$$v" in \
git-merge-octopus | git-merge-ours | git-merge-recursive | \
@ -2828,35 +2833,13 @@ check-docs::
sed -e '/^#/d' \
-e 's/[ ].*//' \
-e 's/^/listed /' command-list.txt; \
ls -1 Documentation/git*txt | \
$(MAKE) -C Documentation print-man1 | \
grep '\.txt$$' | \
sed -e 's|Documentation/|documented |' \
-e 's/\.txt//'; \
) | while read how cmd; \
do \
case "$$how,$$cmd" in \
*,git-citool | \
*,git-gui | \
*,git-help | \
documented,gitattributes | \
documented,gitignore | \
documented,gitmodules | \
documented,gitcli | \
documented,git-tools | \
documented,gitcore-tutorial | \
documented,gitcvs-migration | \
documented,gitdiffcore | \
documented,gitglossary | \
documented,githooks | \
documented,gitrepository-layout | \
documented,gitrevisions | \
documented,gittutorial | \
documented,gittutorial-2 | \
documented,git-bisect-lk2009 | \
documented,git-remote-helpers | \
documented,gitworkflows | \
sentinel,not,matching,is,ok ) continue ;; \
esac; \
case " $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS) git gitk " in \
case " $(ALL_COMMANDS) " in \
*" $$cmd "*) ;; \
*) echo "removed but $$how: $$cmd" ;; \
esac; \

View File

@ -26,6 +26,8 @@ git-commit-tree plumbingmanipulators
git-config ancillarymanipulators
git-count-objects ancillaryinterrogators
git-credential purehelpers
git-credential-cache purehelpers
git-credential-store purehelpers
git-cvsexportcommit foreignscminterface
git-cvsimport foreignscminterface
git-cvsserver foreignscminterface
@ -114,6 +116,7 @@ git-show mainporcelain common
git-show-branch ancillaryinterrogators
git-show-index plumbinginterrogators
git-show-ref plumbinginterrogators
git-sh-i18n purehelpers
git-sh-setup purehelpers
git-stash mainporcelain
git-status mainporcelain common