mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
Makefile: $(MAKE) check-docs
This target lists undocumented commands, and/or whose document is not referenced from the main git documentation. For now, there are some exceptions I added primarily because I lack the energy to document them myself: - merge backends (we should really document them) - ssh-push/ssh-pull (does anybody still use them?) - annotate and blame (maybe after one of them eats the other ;-) Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
parent
c16e30c088
commit
8c989ec528
20
Makefile
20
Makefile
|
@ -665,3 +665,23 @@ clean:
|
|||
.PHONY: all install clean strip
|
||||
.PHONY: .FORCE-GIT-VERSION-FILE TAGS tags
|
||||
|
||||
### Check documentation
|
||||
#
|
||||
check-docs::
|
||||
@for v in $(ALL_PROGRAMS) $(BUILT_INS) git$X gitk; \
|
||||
do \
|
||||
case "$$v" in \
|
||||
git-annotate | git-blame | \
|
||||
git-merge-octopus | git-merge-ours | git-merge-recursive | \
|
||||
git-merge-resolve | git-merge-stupid | \
|
||||
git-ssh-pull | git-ssh-push ) continue ;; \
|
||||
esac ; \
|
||||
test -f "Documentation/$$v.txt" || \
|
||||
echo "no doc: $$v"; \
|
||||
grep -q "^gitlink:$$v\[[0-9]\]::" Documentation/git.txt || \
|
||||
case "$$v" in \
|
||||
git) ;; \
|
||||
*) echo "no link: $$v";; \
|
||||
esac ; \
|
||||
done | sort
|
||||
|
||||
|
|
Loading…
Reference in a new issue