From: "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Taylor Blau <me@ttaylorr.com>, Junio C Hamano <gitster@pobox.com>,
Johannes Schindelin <johannes.schindelin@gmx.de>
Subject: [PATCH v2 3/5] check-docs: really look at the documented commands again
Date: Mon, 25 Mar 2019 14:41:37 -0700 (PDT) [thread overview]
Message-ID: <0dad6abd2f949b81d4d763b9d8439853a35d3eab.1553550094.git.gitgitgadget@gmail.com> (raw)
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
next prev parent reply other threads:[~2019-03-25 21:41 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-13 11:56 [PATCH 0/1] Fix make check-docs on Windows Johannes Schindelin via GitGitGadget
2019-03-13 11:56 ` [PATCH 1/1] check-docs: fix for setups where executables have an extension Johannes Schindelin via GitGitGadget
2019-03-14 1:54 ` Junio C Hamano
2019-03-22 18:43 ` Taylor Blau
2019-03-24 10:02 ` Johannes Schindelin
2019-03-24 12:54 ` Junio C Hamano
2019-03-25 21:08 ` Johannes Schindelin
2019-03-25 21:41 ` [PATCH v2 0/5] Fix make check-docs on Windows Johannes Schindelin via GitGitGadget
2019-03-25 21:41 ` [PATCH v2 1/5] docs: move gitremote-helpers into section 7 Johannes Schindelin via GitGitGadget
2019-03-25 21:41 ` [PATCH v2 2/5] docs: do not document the `git remote-testgit` command Johannes Schindelin via GitGitGadget
2019-03-26 14:39 ` Ævar Arnfjörð Bjarmason
2019-03-27 22:23 ` Johannes Schindelin
2019-03-29 14:48 ` Johannes Schindelin
2019-03-25 21:41 ` Johannes Schindelin via GitGitGadget [this message]
2019-03-25 21:41 ` [PATCH v2 4/5] check-docs: do not expect guide pages to correspond to commands Johannes Schindelin via GitGitGadget
2019-03-25 21:41 ` [PATCH v2 5/5] check-docs: fix for setups where executables have an extension Johannes Schindelin via GitGitGadget
2019-03-26 14:38 ` [PATCH v2 0/5] Fix make check-docs on Windows Johannes Schindelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0dad6abd2f949b81d4d763b9d8439853a35d3eab.1553550094.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=johannes.schindelin@gmx.de \
--cc=me@ttaylorr.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).