Skip to content

Commit

Permalink
Makefile: $(MAKE) check-docs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Junio C Hamano committed Apr 13, 2006
1 parent c16e30c commit 8c989ec
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 8c989ec

Please sign in to comment.