Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 07:41:53PM -0400, Jeff King wrote: > On Wed, May 04, 2016 at 04:28:31PM -0700, Junio C Hamano wrote: > > > Junio C Hamano writes: > > > > > Gaah, the Makefile part of the final patch is wrong; we do not check > > > the included sources at all if we

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 04:28:31PM -0700, Junio C Hamano wrote: > Junio C Hamano writes: > > > Gaah, the Makefile part of the final patch is wrong; we do not check > > the included sources at all if we only passed the top-level targets' > > sources. > > I ended up queuing an

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Junio C Hamano writes: > Gaah, the Makefile part of the final patch is wrong; we do not check > the included sources at all if we only passed the top-level targets' > sources. I ended up queuing an enhanced version of File::Find based one on 'pu', but I won't be posting it

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Junio C Hamano writes: > Jeff King writes: > >> But I think the point remains, >> which is that your perl script is an implementation detail of the >> Makefile process. I thought the "ci" directory was supposed to be for >> ci-specific scripts that would be

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Jeff King writes: > But I think the point remains, > which is that your perl script is an implementation detail of the > Makefile process. I thought the "ci" directory was supposed to be for > ci-specific scripts that would be driven directly by Travis, etc. True. Documentation/

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 11:54:52PM +0200, Ævar Arnfjörð Bjarmason wrote: > > my @files = map { chomp; $_ } `git ls-files`; > > As a minor sidenote you can equivalently write that as: > > chomp(my @files = `git ls-files`); > > I.e. chomp itself when given a list will chomp each item of

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 02:52:27PM -0700, Junio C Hamano wrote: > Jeff King writes: > > > This dependency feels funny. Wouldn't CI want to invoke this as: > > > > make -C Documentation lint-docs > > I expected CI to do this instead > > make check-docs Ah, sure, that

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Ævar Arnfjörð Bjarmason
On Wed, May 4, 2016 at 10:06 PM, Jeff King wrote: > Would: > > open(my $files, '-|', qw(git ls-files)); > while (<$files>) { > chomp; > ... > } > > make sense? Or a simpler but non-streaming spelling: > > my @files = map { chomp; $_ } `git ls-files`; As a minor

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Jeff King writes: > This dependency feels funny. Wouldn't CI want to invoke this as: > > make -C Documentation lint-docs I expected CI to do this instead make check-docs -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 02:34:23PM -0700, Junio C Hamano wrote: > Third time's a charm, perhaps? > > -- >8 -- > Subject: [PATCH] ci: validate "gitlink:" in documentation > > It is easy to add incorrect "linkgit:[]" references > to our documentation suite. Catch these common classes of errors:

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Third time's a charm, perhaps? -- >8 -- Subject: [PATCH] ci: validate "gitlink:" in documentation It is easy to add incorrect "linkgit:[]" references to our documentation suite. Catch these common classes of errors: * Referring to Documentation/.txt that does not exist. * Referring to a

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 02:15:39PM -0700, Junio C Hamano wrote: > > make sense? Or a simpler but non-streaming spelling: > > > > my @files = map { chomp; $_ } `git ls-files`; > > I forgot to say that I wanted not to rely on "git" (i.e. OK to use > this on tarball extract). Oh, that's a good

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Jeff King writes: > On Wed, May 04, 2016 at 12:57:31PM -0700, Junio C Hamano wrote: > >> > Is it worth just making this a perl script, rather than a shell script >> > with a giant inline perl script? Perl is actually really good at doing >> > that "grep" as it reads the file. :)

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 12:57:31PM -0700, Junio C Hamano wrote: > > Is it worth just making this a perl script, rather than a shell script > > with a giant inline perl script? Perl is actually really good at doing > > that "grep" as it reads the file. :) > > OK. Hmm. This new version uses

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Jeff King writes: > Likewise, I think we could build the whole HTML source and then actually > just look for broken links in it. But that script would probably end up > looking similar to this one, with s/linkgit/href/. But it does more > directly measure what we want, which is

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 11:52:52AM -0700, Junio C Hamano wrote: > > I do not think there is any false positive above, so perhaps the > > checker script below can be used as the link checker we discussed? > > -- >8 -- > Subject: [PATCH] ci: validate "gitlink:" in documentation > > It is easy to

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Junio C Hamano writes: > I do not think there is any false positive above, so perhaps the > checker script below can be used as the link checker we discussed? -- >8 -- Subject: [PATCH] ci: validate "gitlink:" in documentation It is easy to add incorrect "linkgit:[]"

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Junio C Hamano writes: > So I used the script attached at the bottom to audit the whole > thing, and the result is here. > ... While I was at it, I just did this to make the documentation set lint clean. -- >8 -- There are a handful of incorrect "linkgit:[]" instances in

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Junio C Hamano
Ramsay Jones writes: >>> diff --git a/Documentation/git-check-ignore.txt >>> b/Documentation/git-check-ignore.txt >>> index e94367a..9a85998 100644 >>> --- a/Documentation/git-check-ignore.txt >>> +++ b/Documentation/git-check-ignore.txt >>> @@ -112,7 +112,7 @@ EXIT

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Ramsay Jones
On 04/05/16 09:43, Lars Schneider wrote: > > On 04 May 2016, at 10:38, larsxschnei...@gmail.com wrote: > >> From: Lars Schneider >> >> Signed-off-by: Lars Schneider >> --- >> Documentation/config.txt| 4 ++-- >>

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Jeff King
On Wed, May 04, 2016 at 10:43:04AM +0200, Lars Schneider wrote: > > diff --git a/Documentation/git-filter-branch.txt > > b/Documentation/git-filter-branch.txt > > index 73fd9e8..6538cb1 100644 > > --- a/Documentation/git-filter-branch.txt > > +++ b/Documentation/git-filter-branch.txt > > @@

Re: [PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread Lars Schneider
On 04 May 2016, at 10:38, larsxschnei...@gmail.com wrote: > From: Lars Schneider > > Signed-off-by: Lars Schneider > --- > Documentation/config.txt| 4 ++-- > Documentation/git-check-ignore.txt | 2 +- >

[PATCH v4 1/2] Documentation: fix linkgit references

2016-05-04 Thread larsxschneider
From: Lars Schneider Signed-off-by: Lars Schneider --- Documentation/config.txt| 4 ++-- Documentation/git-check-ignore.txt | 2 +- Documentation/git-filter-branch.txt | 4 ++-- Documentation/git-for-each-ref.txt | 2 +- 4 files