git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/4] check-docs: update non-command documentation list

From
Jeff King <peff@peff.net>
Date
Aug 8, 2012, 18:34 UTC
Message-ID
<20120808183433.GB24574@sigill.intra.peff.net>
In-Reply-To
<20120808183132.GA24550@sigill.intra.peff.net>

The check-docs target looks at Documentation/git*txt and complains if any entry does not have a matching command. Therefore we need to explicitly ignore any entries which are not meant to describe a command (like gitattributes.txt). This list has grown stale over time, so let's bring it up to date.

Signed-off-by: Jeff King <peff@peff.net>
---
I really wonder if we would do better to match git-*.txt, since most of
the ignores are gitfoo(7) types of pages. We'd probably want to add back
in "git", "gitweb" and "gitk" explicitly, but they are already handled
specially above and below.
 Makefile | 3 +++
 1 file changed, 3 insertions(+)
diff --git a/Makefile b/Makefile
index 5e773cd..41d9db8 100644
--- a/Makefile
+++ b/Makefile
@@ -2853,6 +2853,9 @@ check-docs::
 		documented,git-bisect-lk2009 | \
 		documented,git-remote-helpers | \
 		documented,gitworkflows | \
+		documented,gitcredentials | \
+		documented,gitnamespaces | \
+		documented,gitweb.conf | \
 		sentinel,not,matching,is,ok ) continue ;; \
 		esac; \
 		case " $(ALL_PROGRAMS) $(SCRIPT_LIB) $(BUILT_INS) git gitk gitweb " in \
-- 
1.7.12.rc2.2.g584e0d9
Previous: Jeff KingNext: Junio C Hamano
Message 6 of 21 in “Documentation: list git-credential in plumbing commands”
  1. Documentation: list git-credential in plumbing commandsMatthieu Moy, Aug 8, 2012
  2. Junio C HamanoAug 8, 2012
  3. Documentation: list git-credential in plumbing commandsMatthieu Moy, Aug 8, 2012
  4. 0/4 update "make check-docs"Jeff King, Aug 8, 2012
  5. 1/4 check-docs: mention gitweb speciallyJeff King, Aug 8, 2012
  6. 2/4 check-docs: update non-command documentation listJeff King, Aug 8, 2012
  7. Junio C HamanoAug 8, 2012
  8. Jeff KingAug 8, 2012
  9. 5/4 check-docs: factor out command-listJeff King, Aug 8, 2012
  10. 6/4 check-docs: list git-gui as a commandJeff King, Aug 8, 2012
  11. 7/4 check-docs: drop git-help special-caseJeff King, Aug 8, 2012
  12. 8/4 check-docs: get documented command list from MakefileJeff King, Aug 8, 2012
  13. Junio C HamanoAug 8, 2012
  14. Philip OakleyAug 8, 2012
  15. Junio C HamanoAug 8, 2012
  16. Philip OakleyAug 9, 2012
  17. 3/4 command-list: add git-sh-i18nJeff King, Aug 8, 2012
  18. 4/4 command-list: mention git-credential-* helpersJeff King, Aug 8, 2012
  19. Matthieu MoyAug 9, 2012
  20. Junio C HamanoAug 8, 2012
  21. Jeff KingAug 8, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.