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

[PATCH v2 3/5] check-docs: really look at the documented commands again

From
Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>
Date
Mar 25, 2019, 21:41 UTC
Message-ID
<0dad6abd2f949b81d4d763b9d8439853a35d3eab.1553550094.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.162.v2.git.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>

As part of the `check-docs` target, we verify that commands that are documented are actually in the current list of commands to be built.

However, this logic broke in 5fafce0b78 (check-docs: get documented command list from Makefile, 2012-08-08), when we tried to make the logic safer by not looking at the files in the worktree, but at the list of files to be generated in `Documentation/Makefile`. While this was the right thing to do, it failed to accommodate for the fact that `make -C Documentation/ print-man1`, unlike `ls Documentation/*.txt`, would *not* print lines starting with the prefix `Documentation/`.

At long last, let's fix this.
Note: This went undetected due to a funny side effect of the
`ALL_PROGRAMS` variable starting with a space. That space, together with
the extra space we inserted before `$(ALL_PROGRAMS)` in the
	case " $(ALL_PROGRAMS)" in
	*" $$cmd ")
		[...]

construct, is responsible that this case arm is used when `cmd` is empty (which was clearly not intended to be the case).

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 537493822b..76904f07fe 100644
--- a/Makefile
+++ b/Makefile
@@ -3099,7 +3099,7 @@ check-docs::
 		    -e 's/^/listed /' command-list.txt; \
 		$(MAKE) -C Documentation print-man1 | \
 		grep '\.txt$$' | \
-		sed -e 's|Documentation/|documented |' \
+		sed -e 's|^|documented |' \
 		    -e 's/\.txt//'; \
 	) | while read how cmd; \
 	do \
-- 
gitgitgadget
Previous: Johannes Schindelin via GitGitGadgetNext: Johannes Schindelin via GitGitGadget
Message 9 of 17 in “Fix make check-docs on Windows”
  1. 0/1 Fix make check-docs on WindowsJohannes Schindelin via GitGitGadget, Mar 13, 2019
  2. 1/1 check-docs: fix for setups where executables have an extensionJohannes Schindelin via GitGitGadget, Mar 13, 2019
  3. Junio C HamanoMar 14, 2019
  4. Taylor BlauMar 22, 2019
  5. Johannes SchindelinMar 24, 2019
  6. Junio C HamanoMar 24, 2019
  7. Johannes SchindelinMar 25, 2019
  8. 0/5 Fix make check-docs on WindowsJohannes Schindelin via GitGitGadget, Mar 25, 2019
  9. 3/5 check-docs: really look at the documented commands againJohannes Schindelin via GitGitGadget, Mar 25, 2019
  10. 5/5 check-docs: fix for setups where executables have an extensionJohannes Schindelin via GitGitGadget, Mar 25, 2019
  11. 2/5 docs: do not document the `git remote-testgit` commandJohannes Schindelin via GitGitGadget, Mar 25, 2019
  12. Ævar Arnfjörð BjarmasonMar 26, 2019
  13. Johannes SchindelinMar 27, 2019
  14. Johannes SchindelinMar 29, 2019
  15. 1/5 docs: move gitremote-helpers into section 7Johannes Schindelin via GitGitGadget, Mar 25, 2019
  16. 4/5 check-docs: do not expect guide pages to correspond to commandsJohannes Schindelin via GitGitGadget, Mar 25, 2019
  17. Johannes SchindelinMar 26, 2019

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.