{"thread":{"id":"50727","subject":"[PATCH 0/1] Fix make check-docs on Windows","startedAt":"2019-03-13T11:56:56Z","lastAt":"2019-03-29T14:48:37Z","messageCount":17,"participants":["Johannes Schindelin via GitGitGadget","Junio C Hamano","Taylor Blau","Johannes Schindelin","Ævar Arnfjörð Bjarmason"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"371350","messageId":"pull.162.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":null,"subject":"[PATCH 0/1] Fix make check-docs on Windows","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-13T11:56:52Z","receivedAt":"2019-03-13T11:56:56Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"I stumbled across this when investigating one of Duy's bugs in the CI\nbuilds.\n\nJohannes Schindelin (1):\n check-docs: fix for setups where executables have an extension\n\n Makefile | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\n\nbase-commit: e902e9bcae2010bc42648c80ab6adc6c5a16a4a5\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-162%2Fdscho%2Fcheck-docs-on-windows-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-162/dscho/check-docs-on-windows-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/162\n-- \ngitgitgadget\n"},{"id":"371351","messageId":"f06126c3a11119bf6e2a830bbac312f65582387f.1552478212.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.git.gitgitgadget@gmail.com","subject":"[PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-13T11:56:53Z","receivedAt":"2019-03-13T11:56:57Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nOn Windows, for example, executables (must) have the extension `.exe`.\nOur `check-docs` target was not prepared for that.\n\nSigned-off-by: Johannes Schindelin \n---\n Makefile | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Makefile b/Makefile\nindex 537493822b..df56bf0cd1 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -3074,7 +3074,7 @@ ALL_COMMANDS += git-gui git-citool\n .PHONY: check-docs\n check-docs::\n \t$(MAKE) -C Documentation lint-docs\n-\t@(for v in $(ALL_COMMANDS); \\\n+\t@(for v in $(patsubst %$X,%,$(ALL_COMMANDS)); \\\n \tdo \\\n \t\tcase \"$$v\" in \\\n \t\tgit-merge-octopus | git-merge-ours | git-merge-recursive | \\\n@@ -3103,7 +3103,7 @@ check-docs::\n \t\t -e 's/\\.txt//'; \\\n \t) | while read how cmd; \\\n \tdo \\\n-\t\tcase \" $(ALL_COMMANDS) \" in \\\n+\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n \t\t*\" $$cmd \"*)\t;; \\\n \t\t*) echo \"removed but $$how: $$cmd\" ;; \\\n \t\tesac; \\\n-- \ngitgitgadget\n"},{"id":"371442","messageId":"xmqq5zsmcjaf.fsf@gitster-ct.c.googlers.com","threadId":"50727","inReplyTo":"f06126c3a11119bf6e2a830bbac312f65582387f.1552478212.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-03-14T01:54:32Z","receivedAt":"2019-03-14T01:54:36Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Johannes Schindelin via GitGitGadget\" \nwrites:\n\n> From: Johannes Schindelin \n>\n> On Windows, for example, executables (must) have the extension `.exe`.\n> Our `check-docs` target was not prepared for that.\n>\n> Signed-off-by: Johannes Schindelin \n> ---\n\nMy writing this loop certainly predates increased upstream\nactivities for Windows port we see recently, and we saw little\nupdates ever since the loop was written; I am kind of surprised it\ntook this long for us to find the missing .exe support here.\n\nThanks.\n\n> Makefile | 4 ++--\n> 1 file changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Makefile b/Makefile\n> index 537493822b..df56bf0cd1 100644\n> --- a/Makefile\n> +++ b/Makefile\n> @@ -3074,7 +3074,7 @@ ALL_COMMANDS += git-gui git-citool\n> .PHONY: check-docs\n> check-docs::\n> \t$(MAKE) -C Documentation lint-docs\n> -\t@(for v in $(ALL_COMMANDS); \\\n> +\t@(for v in $(patsubst %$X,%,$(ALL_COMMANDS)); \\\n> \tdo \\\n> \t\tcase \"$$v\" in \\\n> \t\tgit-merge-octopus | git-merge-ours | git-merge-recursive | \\\n> @@ -3103,7 +3103,7 @@ check-docs::\n> \t\t -e 's/\\.txt//'; \\\n> \t) | while read how cmd; \\\n> \tdo \\\n> -\t\tcase \" $(ALL_COMMANDS) \" in \\\n> +\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n> \t\t*\" $$cmd \"*)\t;; \\\n> \t\t*) echo \"removed but $$how: $$cmd\" ;; \\\n> \t\tesac; \\\n"},{"id":"372268","messageId":"20190322184347.GC12155@Taylors-MacBook-Pro.local","threadId":"50727","inReplyTo":"f06126c3a11119bf6e2a830bbac312f65582387f.1552478212.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2019-03-22T18:43:47Z","receivedAt":"2019-03-22T18:43:51Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"Hi Johannes,\n\nOn Wed, Mar 13, 2019 at 04:56:53AM -0700, Johannes Schindelin via GitGitGadget wrote:\n> From: Johannes Schindelin \n>\n> On Windows, for example, executables (must) have the extension `.exe`.\n> Our `check-docs` target was not prepared for that.\n>\n> Signed-off-by: Johannes Schindelin \n> ---\n> Makefile | 4 ++--\n> 1 file changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Makefile b/Makefile\n> index 537493822b..df56bf0cd1 100644\n> --- a/Makefile\n> +++ b/Makefile\n> @@ -3074,7 +3074,7 @@ ALL_COMMANDS += git-gui git-citool\n> .PHONY: check-docs\n> check-docs::\n> \t$(MAKE) -C Documentation lint-docs\n> -\t@(for v in $(ALL_COMMANDS); \\\n> +\t@(for v in $(patsubst %$X,%,$(ALL_COMMANDS)); \\\n> \tdo \\\n> \t\tcase \"$$v\" in \\\n> \t\tgit-merge-octopus | git-merge-ours | git-merge-recursive | \\\n> @@ -3103,7 +3103,7 @@ check-docs::\n> \t\t -e 's/\\.txt//'; \\\n> \t) | while read how cmd; \\\n> \tdo \\\n> -\t\tcase \" $(ALL_COMMANDS) \" in \\\n> +\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n\nI'm a little late to reading this thread, but I was curious why there\nare now two spaces around the patsubst as opposed to the one around\nALL_COMMANDS?\n\n> \t\t*\" $$cmd \"*)\t;; \\\n> \t\t*) echo \"removed but $$how: $$cmd\" ;; \\\n> \t\tesac; \\\n> --\n> gitgitgadget\n\nThanks,\nTaylor\n"},{"id":"372348","messageId":"nycvar.QRO.7.76.6.1903241055230.45@tvgsbejvaqbjf.bet","threadId":"50727","inReplyTo":"20190322184347.GC12155@Taylors-MacBook-Pro.local","subject":"Re: [PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-03-24T10:02:27Z","receivedAt":"2019-03-24T10:02:36Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Taylor,\n\nOn Fri, 22 Mar 2019, Taylor Blau wrote:\n\n> On Wed, Mar 13, 2019 at 04:56:53AM -0700, Johannes Schindelin via GitGitGadget wrote:\n> > From: Johannes Schindelin \n> >\n> > On Windows, for example, executables (must) have the extension `.exe`.\n> > Our `check-docs` target was not prepared for that.\n> >\n> > Signed-off-by: Johannes Schindelin \n> > ---\n> > Makefile | 4 ++--\n> > 1 file changed, 2 insertions(+), 2 deletions(-)\n> >\n> > diff --git a/Makefile b/Makefile\n> > index 537493822b..df56bf0cd1 100644\n> > --- a/Makefile\n> > +++ b/Makefile\n> > @@ -3074,7 +3074,7 @@ ALL_COMMANDS += git-gui git-citool\n> > .PHONY: check-docs\n> > check-docs::\n> > \t$(MAKE) -C Documentation lint-docs\n> > -\t@(for v in $(ALL_COMMANDS); \\\n> > +\t@(for v in $(patsubst %$X,%,$(ALL_COMMANDS)); \\\n> > \tdo \\\n> > \t\tcase \"$$v\" in \\\n> > \t\tgit-merge-octopus | git-merge-ours | git-merge-recursive | \\\n> > @@ -3103,7 +3103,7 @@ check-docs::\n> > \t\t -e 's/\\.txt//'; \\\n> > \t) | while read how cmd; \\\n> > \tdo \\\n> > -\t\tcase \" $(ALL_COMMANDS) \" in \\\n> > +\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n>\n> I'm a little late to reading this thread, but I was curious why there\n> are now two spaces around the patsubst as opposed to the one around\n> ALL_COMMANDS?\n\nSharp eyes, and a *very* good point. The double space is actually required\nfor this patch to work as intended. I added the following explanation to\nthe commit message:\n\n Note that `$(ALL_COMMANDS)` starts with a space, and that is rather\n crucial for the `while read how cmd` loop: some of the input lines do\n not actually have the form ` `, but only ``, therefore\n `$cmd` evaluates to the empty string, and when we are looking for\n `* $cmd *` in ` $(ALL_COMMANDS)`, we do find it because the latter\n starts with a double space.\n\n In other words, the double space helps us skip the lines that list\n only a command.\n\n But in this patch, we want to transform `$(ALL_COMMANDS)` via\n `$(patsubst ...)` which swallows that double space. To help that, we\n prefix the result with *two* spaces instead of just one.\n\nDo you think that is good enough?\n\nOh, and can I ask you to review *all* of my patches in the future?\n\nThanks,\nDscho\n"},{"id":"372359","messageId":"xmqqbm20ph45.fsf@gitster-ct.c.googlers.com","threadId":"50727","inReplyTo":"nycvar.QRO.7.76.6.1903241055230.45@tvgsbejvaqbjf.bet","subject":"Re: [PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-03-24T12:54:50Z","receivedAt":"2019-03-24T12:58:26Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Johannes Schindelin writes:\n\n> Sharp eyes, and a *very* good point. The double space is actually required\n> for this patch to work as intended. I added the following explanation to\n> the commit message:\n>\n> Note that `$(ALL_COMMANDS)` starts with a space, and that is rather\n> crucial for the `while read how cmd` loop: some of the input lines do\n> not actually have the form ` `, but only ``, therefore\n> `$cmd` evaluates to the empty string, and when we are looking for\n> `* $cmd *` in ` $(ALL_COMMANDS)`, we do find it because the latter\n> starts with a double space.\n> In other words, the double space helps us skip the lines that list\n> only a command.\n\nThat sounds more like a bug in the existing set-up even before your\npatch (in fact, these lines are probably from 2007 or so, long\nbefore you started touching our top-level Makefile heavily). If we\nwant to ignore lines with only one token, I'd rather see it\nexplicitly done, e.g.\n\n\t... generate data ... |\n\twhile read how cmd\n\tdo\n\t\t# skip a line with a single token\n\t\tcase \"$cmd\" in \"\") continue ;; esac\n\n\t\t# is $cmd part of the known command list?\n\t\tcase \" $(ALL_COMMANDS) \" in\n\t\t*\" $cmd \"*)\t;; # skip\n\t\t*)\techo ... warning ... ;;\n\t\tesac\n\tdone\n\ninstead of relying on \"if $cmd is empty, then SP + $cmd + SP makes\ndouble space, so let's have double space somewhere in the list of\nknown commands\" cuteness.\n\nThanks.\n\n"},{"id":"372471","messageId":"nycvar.QRO.7.76.6.1903252206201.41@tvgsbejvaqbjf.bet","threadId":"50727","inReplyTo":"xmqqbm20ph45.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH 1/1] check-docs: fix for setups where executables have an extension","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-03-25T21:08:35Z","receivedAt":"2019-03-25T21:08:59Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Junio,\n\nOn Sun, 24 Mar 2019, Junio C Hamano wrote:\n\n> Johannes Schindelin writes:\n>\n> > Sharp eyes, and a *very* good point. The double space is actually required\n> > for this patch to work as intended. I added the following explanation to\n> > the commit message:\n> >\n> > Note that `$(ALL_COMMANDS)` starts with a space, and that is rather\n> > crucial for the `while read how cmd` loop: some of the input lines do\n> > not actually have the form ` `, but only ``, therefore\n> > `$cmd` evaluates to the empty string, and when we are looking for\n> > `* $cmd *` in ` $(ALL_COMMANDS)`, we do find it because the latter\n> > starts with a double space.\n> > In other words, the double space helps us skip the lines that list\n> > only a command.\n>\n> That sounds more like a bug in the existing set-up even before your\n> patch (in fact, these lines are probably from 2007 or so, long\n> before you started touching our top-level Makefile heavily). If we\n> want to ignore lines with only one token, I'd rather see it\n> explicitly done, e.g.\n>\n> \t... generate data ... |\n> \twhile read how cmd\n> \tdo\n> \t\t# skip a line with a single token\n> \t\tcase \"$cmd\" in \"\") continue ;; esac\n>\n> \t\t# is $cmd part of the known command list?\n> \t\tcase \" $(ALL_COMMANDS) \" in\n> \t\t*\" $cmd \"*)\t;; # skip\n> \t\t*)\techo ... warning ... ;;\n> \t\tesac\n> \tdone\n>\n> instead of relying on \"if $cmd is empty, then SP + $cmd + SP makes\n> double space, so let's have double space somewhere in the list of\n> known commands\" cuteness.\n\nYou are right, I should have root-caused it, it had a funny smell to it.\n\nTurns out that we should not just skip those lines with a single token,\nbut instead fix the bug that prevents the `how` variable to be set to\n`documented` in those cases, as had been intended all along.\n\nI fixed the commit, and accompanied it with a bug fix for this, plus for\nthe fall-out bugs that had been hidden by this bug.\n\nCiao,\nDscho\n"},{"id":"372476","messageId":"pull.162.v2.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.git.gitgitgadget@gmail.com","subject":"[PATCH v2 0/5] Fix make check-docs on Windows","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:35Z","receivedAt":"2019-03-25T21:41:38Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"I stumbled across this when investigating one of Duy's bugs in the CI\nbuilds.\n\nChanges since v1:\n\n * We no longer add an extra space in front of the $(patsubst ...) in the\n second loop, but fix the underlying bug that prevented check-docs' part\n from working where it discovered documented commands that are actually\n not installed.\n * As a fall-out, the gitremote-helpers page, which does not refer to a\n command, but to a concept, was moved from section 1 to section 7.\n * As a second fall-out, the documentation for git remote-testgit, which is \n a command, but not installed, was removed.\n * As a \"while at it\" patch, the part of the check-docs target that tried to\n identify commands that are listed in the help, but not implemented, was\n fixed to no longer mistake guides like gitattributes and gitcli for\n commands.\n\nJohannes Schindelin (5):\n docs: move gitremote-helpers into section 7\n docs: do not document the `git remote-testgit` command\n check-docs: really look at the documented commands again\n check-docs: do not expect guide pages to correspond to commands\n check-docs: fix for setups where executables have an extension\n\n Documentation/Makefile | 2 +-\n Documentation/git-remote-ext.txt | 2 +-\n Documentation/git-remote-fd.txt | 2 +-\n Documentation/git-remote-helpers.txto | 2 +-\n Documentation/git-remote-testgit.txt | 30 ---------------------------\n Documentation/gitremote-helpers.txt | 4 +---\n Documentation/urls.txt | 2 +-\n Makefile | 7 ++++---\n 8 files changed, 10 insertions(+), 41 deletions(-)\n delete mode 100644 Documentation/git-remote-testgit.txt\n\n\nbase-commit: e902e9bcae2010bc42648c80ab6adc6c5a16a4a5\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-162%2Fdscho%2Fcheck-docs-on-windows-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-162/dscho/check-docs-on-windows-v2\nPull-Request: https://github.com/gitgitgadget/git/pull/162\n\nRange-diff vs v1:\n\n -: ---------- > 1: 0ad38649c0 docs: move gitremote-helpers into section 7\n -: ---------- > 2: 810d2c5a94 docs: do not document the `git remote-testgit` command\n -: ---------- > 3: 0dad6abd2f check-docs: really look at the documented commands again\n -: ---------- > 4: 1097be7678 check-docs: do not expect guide pages to correspond to commands\n 1: f06126c3a1 ! 5: b26aa40c61 check-docs: fix for setups where executables have an extension\n @@ -24,7 +24,7 @@\n \t) | while read how cmd; \\\n \tdo \\\n -\t\tcase \" $(ALL_COMMANDS) \" in \\\n -+\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n ++\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n \t\t*\" $$cmd \"*)\t;; \\\n \t\t*) echo \"removed but $$how: $$cmd\" ;; \\\n \t\tesac; \\\n\n-- \ngitgitgadget\n"},{"id":"372477","messageId":"0dad6abd2f949b81d4d763b9d8439853a35d3eab.1553550094.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 3/5] check-docs: really look at the documented commands again","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:37Z","receivedAt":"2019-03-25T21:41:41Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nAs part of the `check-docs` target, we verify that commands that are\ndocumented are actually in the current list of commands to be built.\n\nHowever, this logic broke in 5fafce0b78 (check-docs: get documented\ncommand list from Makefile, 2012-08-08), when we tried to make the logic\nsafer by not looking at the files in the worktree, but at the list of\nfiles to be generated in `Documentation/Makefile`. While this was the\nright thing to do, it failed to accommodate for the fact that `make -C\nDocumentation/ print-man1`, unlike `ls Documentation/*.txt`, would *not*\nprint lines starting with the prefix `Documentation/`.\n\nAt long last, let's fix this.\n\nNote: This went undetected due to a funny side effect of the\n`ALL_PROGRAMS` variable starting with a space. That space, together with\nthe extra space we inserted before `$(ALL_PROGRAMS)` in the\n\n\tcase \" $(ALL_PROGRAMS)\" in\n\t*\" $$cmd \")\n\t\t[...]\n\nconstruct, is responsible that this case arm is used when `cmd` is empty\n(which was clearly not intended to be the case).\n\nSigned-off-by: Johannes Schindelin \n---\n Makefile | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Makefile b/Makefile\nindex 537493822b..76904f07fe 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -3099,7 +3099,7 @@ check-docs::\n \t\t -e 's/^/listed /' command-list.txt; \\\n \t\t$(MAKE) -C Documentation print-man1 | \\\n \t\tgrep '\\.txt$$' | \\\n-\t\tsed -e 's|Documentation/|documented |' \\\n+\t\tsed -e 's|^|documented |' \\\n \t\t -e 's/\\.txt//'; \\\n \t) | while read how cmd; \\\n \tdo \\\n-- \ngitgitgadget\n\n"},{"id":"372478","messageId":"b26aa40c618842a1a7ba41108104084f61db9b6b.1553550094.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 5/5] check-docs: fix for setups where executables have an extension","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:39Z","receivedAt":"2019-03-25T21:41:43Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nOn Windows, for example, executables (must) have the extension `.exe`.\nOur `check-docs` target was not prepared for that.\n\nSigned-off-by: Johannes Schindelin \n---\n Makefile | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Makefile b/Makefile\nindex c7b884cd38..2cd650e7b9 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -3074,7 +3074,7 @@ ALL_COMMANDS += git-gui git-citool\n .PHONY: check-docs\n check-docs::\n \t$(MAKE) -C Documentation lint-docs\n-\t@(for v in $(ALL_COMMANDS); \\\n+\t@(for v in $(patsubst %$X,%,$(ALL_COMMANDS)); \\\n \tdo \\\n \t\tcase \"$$v\" in \\\n \t\tgit-merge-octopus | git-merge-ours | git-merge-recursive | \\\n@@ -3104,7 +3104,7 @@ check-docs::\n \t\t -e 's/\\.txt//'; \\\n \t) | while read how cmd; \\\n \tdo \\\n-\t\tcase \" $(ALL_COMMANDS) \" in \\\n+\t\tcase \" $(patsubst %$X,%,$(ALL_COMMANDS)) \" in \\\n \t\t*\" $$cmd \"*)\t;; \\\n \t\t*) echo \"removed but $$how: $$cmd\" ;; \\\n \t\tesac; \\\n-- \ngitgitgadget\n"},{"id":"372479","messageId":"810d2c5a94b40544652c97ffa644b29e0db8af82.1553550094.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 2/5] docs: do not document the `git remote-testgit` command","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:37Z","receivedAt":"2019-03-25T21:41:44Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nSince 7ded055401 (build: do not install git-remote-testgit, 2013-06-07),\nwe do not install it. Therefore it makes no sense to document it,\neither.\n\nSigned-off-by: Johannes Schindelin \n---\n Documentation/git-remote-testgit.txt | 30 ----------------------------\n Documentation/gitremote-helpers.txt | 2 --\n 2 files changed, 32 deletions(-)\n delete mode 100644 Documentation/git-remote-testgit.txt\n\ndiff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt\ndeleted file mode 100644\nindex b45bfebba5..0000000000\n--- a/Documentation/git-remote-testgit.txt\n+++ /dev/null\n@@ -1,30 +0,0 @@\n-git-remote-testgit(1)\n-=====================\n-\n-NAME\n-----\n-git-remote-testgit - Example remote-helper\n-\n-\n-SYNOPSIS\n---------\n-[verse]\n-git clone testgit:: []\n-\n-DESCRIPTION\n------------\n-\n-This command is a simple remote-helper, that is used both as a\n-testcase for the remote-helper functionality, and as an example to\n-show remote-helper authors one possible implementation.\n-\n-The best way to learn more is to read the comments and source code in\n-'git-remote-testgit'.\n-\n-SEE ALSO\n---------\n-linkgit:gitremote-helpers[7]\n-\n-GIT\n----\n-Part of the linkgit:git[1] suite\ndiff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\nindex 34a3e60d08..2fc4007525 100644\n--- a/Documentation/gitremote-helpers.txt\n+++ b/Documentation/gitremote-helpers.txt\n@@ -513,8 +513,6 @@ linkgit:git-remote-ext[1]\n \n linkgit:git-remote-fd[1]\n \n-linkgit:git-remote-testgit[1]\n-\n linkgit:git-fast-import[1]\n \n GIT\n-- \ngitgitgadget\n\n"},{"id":"372480","messageId":"0ad38649c0f30c980074a817bdfeab18ff5648c7.1553550094.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 1/5] docs: move gitremote-helpers into section 7","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:36Z","receivedAt":"2019-03-25T21:41:45Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nIt is currently in section 1, but that section is intended for\n\"Executable programs or shell commands\".\n\nA more appropriate place is section 7: \"Miscellaneous (including macro\npackages and conventions), e.g. man(7), groff(7)\".\n\nThis issue should have been detected earlier by `make check-docs`, but\nwas missed due to a bug in that Makefile target (that we are about to\nfix).\n\nSigned-off-by: Johannes Schindelin \n---\n Documentation/Makefile | 2 +-\n Documentation/git-remote-ext.txt | 2 +-\n Documentation/git-remote-fd.txt | 2 +-\n Documentation/git-remote-helpers.txto | 2 +-\n Documentation/git-remote-testgit.txt | 2 +-\n Documentation/gitremote-helpers.txt | 2 +-\n Documentation/urls.txt | 2 +-\n 7 files changed, 7 insertions(+), 7 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 26a2342bea..af0e2cf11a 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -12,7 +12,6 @@ MAN1_TXT += $(filter-out \\\n \t\t$(wildcard git-*.txt))\n MAN1_TXT += git.txt\n MAN1_TXT += gitk.txt\n-MAN1_TXT += gitremote-helpers.txt\n MAN1_TXT += gitweb.txt\n \n MAN5_TXT += gitattributes.txt\n@@ -30,6 +29,7 @@ MAN7_TXT += gitdiffcore.txt\n MAN7_TXT += giteveryday.txt\n MAN7_TXT += gitglossary.txt\n MAN7_TXT += gitnamespaces.txt\n+MAN7_TXT += gitremote-helpers.txt\n MAN7_TXT += gitrevisions.txt\n MAN7_TXT += gitsubmodules.txt\n MAN7_TXT += gittutorial-2.txt\ndiff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt\nindex 3fc5d94336..790e2ca3fe 100644\n--- a/Documentation/git-remote-ext.txt\n+++ b/Documentation/git-remote-ext.txt\n@@ -118,7 +118,7 @@ begins with `ext::`. Examples:\n \n SEE ALSO\n --------\n-linkgit:gitremote-helpers[1]\n+linkgit:gitremote-helpers[7]\n \n GIT\n ---\ndiff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt\nindex 80afca866c..0451ceb8a2 100644\n--- a/Documentation/git-remote-fd.txt\n+++ b/Documentation/git-remote-fd.txt\n@@ -52,7 +52,7 @@ EXAMPLES\n \n SEE ALSO\n --------\n-linkgit:gitremote-helpers[1]\n+linkgit:gitremote-helpers[7]\n \n GIT\n ---\ndiff --git a/Documentation/git-remote-helpers.txto b/Documentation/git-remote-helpers.txto\nindex 49233f5d26..6f353ebfd3 100644\n--- a/Documentation/git-remote-helpers.txto\n+++ b/Documentation/git-remote-helpers.txto\n@@ -1,7 +1,7 @@\n git-remote-helpers\n ==================\n \n-This document has been moved to linkgit:gitremote-helpers[1].\n+This document has been moved to linkgit:gitremote-helpers[7].\n \n Please let the owners of the referring site know so that they can update the\n link you clicked to get here.\ndiff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt\nindex f791d73c05..b45bfebba5 100644\n--- a/Documentation/git-remote-testgit.txt\n+++ b/Documentation/git-remote-testgit.txt\n@@ -23,7 +23,7 @@ The best way to learn more is to read the comments and source code in\n \n SEE ALSO\n --------\n-linkgit:gitremote-helpers[1]\n+linkgit:gitremote-helpers[7]\n \n GIT\n ---\ndiff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\nindex 9d1459aac6..34a3e60d08 100644\n--- a/Documentation/gitremote-helpers.txt\n+++ b/Documentation/gitremote-helpers.txt\n@@ -1,4 +1,4 @@\n-gitremote-helpers(1)\n+gitremote-helpers(7)\n ====================\n \n NAME\ndiff --git a/Documentation/urls.txt b/Documentation/urls.txt\nindex b05da95788..bc354fe2dc 100644\n--- a/Documentation/urls.txt\n+++ b/Documentation/urls.txt\n@@ -62,7 +62,7 @@ may be used:\n \n where
may be a path, a server and path, or an arbitrary\n URL-like string recognized by the specific remote helper being\n-invoked. See linkgit:gitremote-helpers[1] for details.\n+invoked. See linkgit:gitremote-helpers[7] for details.\n \n If there are a large number of similarly-named remote repositories and\n you want to use a different format for them (such that the URLs you\n-- \ngitgitgadget\n\n"},{"id":"372481","messageId":"1097be76787a9c73e82000dd7939580c5d980d70.1553550094.git.gitgitgadget@gmail.com","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"[PATCH v2 4/5] check-docs: do not expect guide pages to correspond to commands","fromName":"Johannes Schindelin via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-03-25T21:41:38Z","receivedAt":"2019-03-25T21:41:46Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"From: Johannes Schindelin \n\nWhen we want to see what commands are listed in `command-list.txt` but\nnot installed, we currently include lines that refer to guides, e.g.\n`gitattributes` or `gitcli`.\n\nLet's not include those lines, as they are not referring to commands.\n\nSigned-off-by: Johannes Schindelin \n---\n Makefile | 1 +\n 1 file changed, 1 insertion(+)\n\ndiff --git a/Makefile b/Makefile\nindex 76904f07fe..c7b884cd38 100644\n--- a/Makefile\n+++ b/Makefile\n@@ -3095,6 +3095,7 @@ check-docs::\n \t( \\\n \t\tsed -e '1,/^### command list/d' \\\n \t\t -e '/^#/d' \\\n+\t\t -e '/guide$$/d' \\\n \t\t -e 's/[ \t].*//' \\\n \t\t -e 's/^/listed /' command-list.txt; \\\n \t\t$(MAKE) -C Documentation print-man1 | \\\n-- \ngitgitgadget\n\n"},{"id":"372520","messageId":"nycvar.QRO.7.76.6.1903261509080.41@tvgsbejvaqbjf.bet","threadId":"50727","inReplyTo":"pull.162.v2.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 0/5] Fix make check-docs on Windows","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-03-26T14:38:09Z","receivedAt":"2019-03-26T14:38:33Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nOn Mon, 25 Mar 2019, Johannes Schindelin via GitGitGadget wrote:\n\n> Johannes Schindelin (5):\n> docs: move gitremote-helpers into section 7\n> docs: do not document the `git remote-testgit` command\n> check-docs: really look at the documented commands again\n> check-docs: do not expect guide pages to correspond to commands\n> check-docs: fix for setups where executables have an extension\n\nFWIW I am also working on a follow-up patch series [*1*] that resolves all\nissues reported by `make check-docs` on Windows, but I do not want to make\nthis here patch series even bigger (from an initial single, relatively\nsmall patch).\n\nCiao,\nJohannes\n\nFoontote *1*: Tracked here: https://github.com/gitgitgadget/git/pull/168\n"},{"id":"372521","messageId":"87a7hhbszc.fsf@evledraar.gmail.com","threadId":"50727","inReplyTo":"810d2c5a94b40544652c97ffa644b29e0db8af82.1553550094.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 2/5] docs: do not document the `git remote-testgit` command","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2019-03-26T14:39:03Z","receivedAt":"2019-03-26T14:39:09Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"\nOn Mon, Mar 25 2019, Johannes Schindelin via GitGitGadget wrote:\n\n> From: Johannes Schindelin \n>\n> Since 7ded055401 (build: do not install git-remote-testgit, 2013-06-07),\n> we do not install it. Therefore it makes no sense to document it,\n> either.\n>\n> Signed-off-by: Johannes Schindelin \n> ---\n> Documentation/git-remote-testgit.txt | 30 ----------------------------\n> Documentation/gitremote-helpers.txt | 2 --\n> 2 files changed, 32 deletions(-)\n> delete mode 100644 Documentation/git-remote-testgit.txt\n>\n> diff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt\n> deleted file mode 100644\n> index b45bfebba5..0000000000\n> --- a/Documentation/git-remote-testgit.txt\n> +++ /dev/null\n> @@ -1,30 +0,0 @@\n> -git-remote-testgit(1)\n> -=====================\n> -\n> -NAME\n> -----\n> -git-remote-testgit - Example remote-helper\n> -\n> -\n> -SYNOPSIS\n> ---------\n> -[verse]\n> -git clone testgit:: []\n> -\n> -DESCRIPTION\n> ------------\n> -\n> -This command is a simple remote-helper, that is used both as a\n> -testcase for the remote-helper functionality, and as an example to\n> -show remote-helper authors one possible implementation.\n> -\n> -The best way to learn more is to read the comments and source code in\n> -'git-remote-testgit'.\n> -\n> -SEE ALSO\n> ---------\n> -linkgit:gitremote-helpers[7]\n> -\n> -GIT\n> ----\n> -Part of the linkgit:git[1] suite\n> diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\n> index 34a3e60d08..2fc4007525 100644\n> --- a/Documentation/gitremote-helpers.txt\n> +++ b/Documentation/gitremote-helpers.txt\n> @@ -513,8 +513,6 @@ linkgit:git-remote-ext[1]\n>\n> linkgit:git-remote-fd[1]\n>\n> -linkgit:git-remote-testgit[1]\n> -\n> linkgit:git-fast-import[1]\n\nI wonder if it should be moved into e.g. t/helper or somesuch at this\npoint...\n"},{"id":"372591","messageId":"nycvar.QRO.7.76.6.1903272317550.41@tvgsbejvaqbjf.bet","threadId":"50727","inReplyTo":"87a7hhbszc.fsf@evledraar.gmail.com","subject":"Re: [PATCH v2 2/5] docs: do not document the `git remote-testgit` command","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-03-27T22:23:08Z","receivedAt":"2019-03-27T22:23:19Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Ævar,\n\nOn Tue, 26 Mar 2019, Ævar Arnfjörð Bjarmason wrote:\n\n>\n> On Mon, Mar 25 2019, Johannes Schindelin via GitGitGadget wrote:\n>\n> > From: Johannes Schindelin \n> >\n> > Since 7ded055401 (build: do not install git-remote-testgit, 2013-06-07),\n> > we do not install it. Therefore it makes no sense to document it,\n> > either.\n> >\n> > Signed-off-by: Johannes Schindelin \n> > ---\n> > Documentation/git-remote-testgit.txt | 30 ----------------------------\n> > Documentation/gitremote-helpers.txt | 2 --\n> > 2 files changed, 32 deletions(-)\n> > delete mode 100644 Documentation/git-remote-testgit.txt\n> >\n> > diff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt\n> > deleted file mode 100644\n> > index b45bfebba5..0000000000\n> > --- a/Documentation/git-remote-testgit.txt\n> > +++ /dev/null\n> > @@ -1,30 +0,0 @@\n> > -git-remote-testgit(1)\n> > -=====================\n> > -\n> > -NAME\n> > -----\n> > -git-remote-testgit - Example remote-helper\n> > -\n> > -\n> > -SYNOPSIS\n> > ---------\n> > -[verse]\n> > -git clone testgit:: []\n> > -\n> > -DESCRIPTION\n> > ------------\n> > -\n> > -This command is a simple remote-helper, that is used both as a\n> > -testcase for the remote-helper functionality, and as an example to\n> > -show remote-helper authors one possible implementation.\n> > -\n> > -The best way to learn more is to read the comments and source code in\n> > -'git-remote-testgit'.\n> > -\n> > -SEE ALSO\n> > ---------\n> > -linkgit:gitremote-helpers[7]\n> > -\n> > -GIT\n> > ----\n> > -Part of the linkgit:git[1] suite\n> > diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\n> > index 34a3e60d08..2fc4007525 100644\n> > --- a/Documentation/gitremote-helpers.txt\n> > +++ b/Documentation/gitremote-helpers.txt\n> > @@ -513,8 +513,6 @@ linkgit:git-remote-ext[1]\n> >\n> > linkgit:git-remote-fd[1]\n> >\n> > -linkgit:git-remote-testgit[1]\n> > -\n> > linkgit:git-fast-import[1]\n>\n> I wonder if it should be moved into e.g. t/helper or somesuch at this\n> point...\n\nSure.\n\nOne thing to keep in mind is that we cannot change the actual name of the\nexecutable, as it needs to have the format `git-remote-*`, and cannot\nrequire a first argument `testgit`, to be able to perform its purpose.\n\nWe do have a precedent for that kind of scenario: `test-fake-ssh`. It is\nalso not folded into `test-tool`, and it is copied while changing the name\nto `ssh`, as required to fulfill its mission.\n\nI am not totally enthusiastic about this because this is what prevents\nGit's test suite from running in a RAM disk on Windows, IIRC: I have not\nbeen able to convince my RAM disk provider to allow executables stored on\nit to be executed.\n\nCiao,\nDscho\n"},{"id":"372705","messageId":"nycvar.QRO.7.76.6.1903291546010.41@tvgsbejvaqbjf.bet","threadId":"50727","inReplyTo":"nycvar.QRO.7.76.6.1903272317550.41@tvgsbejvaqbjf.bet","subject":"Re: [PATCH v2 2/5] docs: do not document the `git remote-testgit` command","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2019-03-29T14:48:28Z","receivedAt":"2019-03-29T14:48:37Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi Ævar,\n\nOn Wed, 27 Mar 2019, Johannes Schindelin wrote:\n\n> On Tue, 26 Mar 2019, Ævar Arnfjörð Bjarmason wrote:\n>\n> > On Mon, Mar 25 2019, Johannes Schindelin via GitGitGadget wrote:\n> >\n> > > From: Johannes Schindelin \n> > >\n> > > Since 7ded055401 (build: do not install git-remote-testgit, 2013-06-07),\n> > > we do not install it. Therefore it makes no sense to document it,\n> > > either.\n> > >\n> > > Signed-off-by: Johannes Schindelin \n> > > ---\n> > > Documentation/git-remote-testgit.txt | 30 ----------------------------\n> > > Documentation/gitremote-helpers.txt | 2 --\n> > > 2 files changed, 32 deletions(-)\n> > > delete mode 100644 Documentation/git-remote-testgit.txt\n> > >\n> > > diff --git a/Documentation/git-remote-testgit.txt b/Documentation/git-remote-testgit.txt\n> > > deleted file mode 100644\n> > > index b45bfebba5..0000000000\n> > > --- a/Documentation/git-remote-testgit.txt\n> > > +++ /dev/null\n> > > @@ -1,30 +0,0 @@\n> > > -git-remote-testgit(1)\n> > > -=====================\n> > > -\n> > > -NAME\n> > > -----\n> > > -git-remote-testgit - Example remote-helper\n> > > -\n> > > -\n> > > -SYNOPSIS\n> > > ---------\n> > > -[verse]\n> > > -git clone testgit:: []\n> > > -\n> > > -DESCRIPTION\n> > > ------------\n> > > -\n> > > -This command is a simple remote-helper, that is used both as a\n> > > -testcase for the remote-helper functionality, and as an example to\n> > > -show remote-helper authors one possible implementation.\n> > > -\n> > > -The best way to learn more is to read the comments and source code in\n> > > -'git-remote-testgit'.\n> > > -\n> > > -SEE ALSO\n> > > ---------\n> > > -linkgit:gitremote-helpers[7]\n> > > -\n> > > -GIT\n> > > ----\n> > > -Part of the linkgit:git[1] suite\n> > > diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\n> > > index 34a3e60d08..2fc4007525 100644\n> > > --- a/Documentation/gitremote-helpers.txt\n> > > +++ b/Documentation/gitremote-helpers.txt\n> > > @@ -513,8 +513,6 @@ linkgit:git-remote-ext[1]\n> > >\n> > > linkgit:git-remote-fd[1]\n> > >\n> > > -linkgit:git-remote-testgit[1]\n> > > -\n> > > linkgit:git-fast-import[1]\n> >\n> > I wonder if it should be moved into e.g. t/helper or somesuch at this\n> > point...\n>\n> Sure.\n>\n> One thing to keep in mind is that we cannot change the actual name of the\n> executable, as it needs to have the format `git-remote-*`, and cannot\n> require a first argument `testgit`, to be able to perform its purpose.\n>\n> We do have a precedent for that kind of scenario: `test-fake-ssh`. It is\n> also not folded into `test-tool`, and it is copied while changing the name\n> to `ssh`, as required to fulfill its mission.\n>\n> I am not totally enthusiastic about this because this is what prevents\n> Git's test suite from running in a RAM disk on Windows, IIRC: I have not\n> been able to convince my RAM disk provider to allow executables stored on\n> it to be executed.\n\nOh you know what? `git-remote-testgit` is a *shell script*.\n\nSo that one was easy...\n\nNow, the question is really, should I just add this patch *here*, or to\nthe non-Windows-related docs fixes I have lined up?\n\nDecisions, decisions.\n\nCiao,\nDscho\n"}]}