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>
Junio C Hamano committed
Apr 13, 2006 at 00:17 UTC
8c989ec5288021e07c265882f86ac3999b44c142
1 file changed
+20
Makefile
+20
@@ -665,3 +665,23 @@ clean:
665
.PHONY: all install clean strip
666
.PHONY: .FORCE-GIT-VERSION-FILE TAGS tags
667
668
+### Check documentation
669
+#
670
+check-docs::
671
+ @for v in $(ALL_PROGRAMS) $(BUILT_INS) git$X gitk; \
672
+ do \
673
+ case "$$v" in \
674
+ git-annotate | git-blame | \
675
+ git-merge-octopus | git-merge-ours | git-merge-recursive | \
676
+ git-merge-resolve | git-merge-stupid | \
677
+ git-ssh-pull | git-ssh-push ) continue ;; \
678
+ esac ; \
679
+ test -f "Documentation/$$v.txt" || \
680
+ echo "no doc: $$v"; \
681
+ grep -q "^gitlink:$$v\[[0-9]\]::" Documentation/git.txt || \
682
+ case "$$v" in \
683
+ git) ;; \
684
+ *) echo "no link: $$v";; \
685
+ esac ; \
686
+ done | sort
687
+