summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2006-04-13 07:17:19 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-04-13 07:21:47 (GMT)
commit8c989ec5288021e07c265882f86ac3999b44c142 (patch)
treedb99f37b7bcec951933e4b43d4e4e23fdf49f132
parentc16e30c0884549d48a73d7f2ebbbb470a0e1576b (diff)
downloadgit-8c989ec5288021e07c265882f86ac3999b44c142.zip
git-8c989ec5288021e07c265882f86ac3999b44c142.tar.gz
git-8c989ec5288021e07c265882f86ac3999b44c142.tar.bz2
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>
-rw-r--r--Makefile20
1 files changed, 20 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index e6ef41d..1130af4 100644
--- a/Makefile
+++ b/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
+