Skip to content

Fix make check-docs on Windows

Johannes Schindelin via GitGitGadget git 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest5 patches 4 repliesIn review
  2. v11 patch 5 repliesSuperseded

Changes in v2 from the cover letter

* We no longer add an extra space in front of the $(patsubst ...) in the second loop, but fix the underlying bug that prevented check-docs' part from working where it discovered documented commands that are actually not installed.
* As a fall-out, the gitremote-helpers page, which does not refer to a command, but to a concept, was moved from section 1 to section 7.
* As a second fall-out, the documentation for git remote-testgit, which is a command, but not installed, was removed.
* As a "while at it" patch, the part of the check-docs target that tried to identify commands that are listed in the help, but not implemented, was fixed to no longer mistake guides like gitattributes and gitcli for commands.

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5docs: move gitremote-helpers into section 7Documentation/Makefile Documentation/git-remote-ext.txt Documentation/git-remote-fd.txt +4 more+7 -70 replies
2/5docs: do not document the `git remote-testgit` commandDocumentation/git-remote-testgit.txt Documentation/gitremote-helpers.txt+0 -323 replies
3/5check-docs: really look at the documented commands againMakefile+1 -10 replies
4/5check-docs: do not expect guide pages to correspond to commandsMakefile+1 -00 replies
5/5check-docs: fix for setups where executables have an extensionMakefile+2 -20 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCH v2 0/5] Fix make check-docs on Windows

I stumbled across this when investigating one of Duy's bugs in the CI builds.

Changes since v1:

* We no longer add an extra space in front of the $(patsubst ...) in the second loop, but fix the underlying bug that prevented check-docs' part from working where it discovered documented commands that are actually not installed.
* As a fall-out, the gitremote-helpers page, which does not refer to a command, but to a concept, was moved from section 1 to section 7.
* As a second fall-out, the documentation for git remote-testgit, which is a command, but not installed, was removed.
* As a "while at it" patch, the part of the check-docs target that tried to identify commands that are listed in the help, but not implemented, was fixed to no longer mistake guides like gitattributes and gitcli for commands.

Johannes Schindelin (5):
docs: move gitremote-helpers into section 7
docs: do not document the git remote-testgit command
check-docs: really look at the documented commands again
check-docs: do not expect guide pages to correspond to commands
check-docs: fix for setups where executables have an extension

 Documentation/Makefile                |  2 +-
 Documentation/git-remote-ext.txt      |  2 +-
 Documentation/git-remote-fd.txt       |  2 +-
 Documentation/git-remote-helpers.txto |  2 +-
 Documentation/git-remote-testgit.txt  | 30 ---------------------------
 Documentation/gitremote-helpers.txt   |  4 +---
 Documentation/urls.txt                |  2 +-
 Makefile                              |  7 ++++---
 8 files changed, 10 insertions(+), 41 deletions(-)
 delete mode 100644 Documentation/git-remote-testgit.txt

base-commit: e902e9bcae2010bc42648c80ab6adc6c5a16a4a5
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-162%2Fdscho%2Fcheck-docs-on-windows-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-162/dscho/check-docs-on-windows-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/162

Range-diff vs v1:

 -:  ---------- > 1:  0ad38649c0 docs: move gitremote-helpers into section 7
 -:  ---------- > 2:  810d2c5a94 docs: do not document the `git remote-testgit` command
 -:  ---------- > 3:  0dad6abd2f check-docs: really look at the documented commands again
 -:  ---------- > 4:  1097be7678 check-docs: do not expect guide pages to correspond to commands
 1:  f06126c3a1 ! 5:  b26aa40c61 check-docs: fix for setups where executables have an extension
     @@ -24,7 +24,7 @@
       	) | while read how cmd; \
       	do \
      -		case " $(ALL_COMMANDS) " in \
     -+		case "  $(patsubst %$X,%,$(ALL_COMMANDS)) " in \
     ++		case " $(patsubst %$X,%,$(ALL_COMMANDS)) " in \
       		*" $$cmd "*)	;; \
       		*) echo "removed but $$how: $$cmd" ;; \
       		esac; \
Signature · 1 line
gitgitgadget