mbox series

[0/5] small doc make and lint fixes

Message ID cover-0.6-00000000000-20210326T103454Z-avarab@gmail.com (mailing list archive)
Headers show
Series small doc make and lint fixes | expand

Message

Ævar Arnfjörð Bjarmason March 26, 2021, 10:36 a.m. UTC
A small stand-alone series of doc infrastructure fixes. 5/6 fixes an
interesting bug that's been missed since doc-diff was introduced.

Ævar Arnfjörð Bjarmason (5):
  Documentation/Makefile: make $(wildcard howto/*.txt) a var
  Documentation/Makefile: make $(wildcard <doc deps>) a var
  doc lint: Perl "strict" and "warnings" in lint-gitlink.perl
  doc lint: fix bugs in, simplify and improve lint script
  doc lint: lint and fix missing "GIT" end sections

 Documentation/Makefile           |  31 +++++++--
 Documentation/git-credential.txt |   4 ++
 Documentation/git-p4.txt         |   4 ++
 Documentation/gitnamespaces.txt  |   4 ++
 Documentation/lint-gitlink.perl  | 110 +++++++++++++++----------------
 Documentation/lint-man-txt.perl  |  24 +++++++
 6 files changed, 116 insertions(+), 61 deletions(-)
 create mode 100755 Documentation/lint-man-txt.perl

Comments

Jeff King March 26, 2021, 11:06 a.m. UTC | #1
On Fri, Mar 26, 2021 at 11:36:45AM +0100, Ævar Arnfjörð Bjarmason wrote:

> A small stand-alone series of doc infrastructure fixes. 5/6 fixes an
> interesting bug that's been missed since doc-diff was introduced.

I'm not sure what you mean about doc-diff here. Patch 5 (of 5?) doesn't
seem related. Patch 4 is related only tangentially, in that you might
have more stuff in your Documentation directory.

That said...

>   Documentation/Makefile: make $(wildcard howto/*.txt) a var
>   Documentation/Makefile: make $(wildcard <doc deps>) a var
>   doc lint: Perl "strict" and "warnings" in lint-gitlink.perl

These three look obviously correct.

>   doc lint: fix bugs in, simplify and improve lint script
>   doc lint: lint and fix missing "GIT" end sections

These two seem fine, though I left some comments for possible
improvements.

-Peff
Ævar Arnfjörð Bjarmason March 26, 2021, 3:18 p.m. UTC | #2
On Fri, Mar 26 2021, Jeff King wrote:

> On Fri, Mar 26, 2021 at 11:36:45AM +0100, Ævar Arnfjörð Bjarmason wrote:
>
>> A small stand-alone series of doc infrastructure fixes. 5/6 fixes an
>> interesting bug that's been missed since doc-diff was introduced.
>
> I'm not sure what you mean about doc-diff here. Patch 5 (of 5?) doesn't
> seem related. Patch 4 is related only tangentially, in that you might
> have more stuff in your Documentation directory.

That's how it's related, the lint script recursively looks for all *.txt
under Documentation/, before doc-diff we could safely assume this was
*.txt at that version of the repository, after doc-diff our recursively
search leads us to a different checkout at a different revision.

I don't think it had any practical effect, just say'n.

> That said...
>
>>   Documentation/Makefile: make $(wildcard howto/*.txt) a var
>>   Documentation/Makefile: make $(wildcard <doc deps>) a var
>>   doc lint: Perl "strict" and "warnings" in lint-gitlink.perl
>
> These three look obviously correct.
>
>>   doc lint: fix bugs in, simplify and improve lint script
>>   doc lint: lint and fix missing "GIT" end sections
>
> These two seem fine, though I left some comments for possible
> improvements.
>
> -Peff
Jeff King March 27, 2021, 9:48 a.m. UTC | #3
On Fri, Mar 26, 2021 at 04:18:50PM +0100, Ævar Arnfjörð Bjarmason wrote:

> >> A small stand-alone series of doc infrastructure fixes. 5/6 fixes an
> >> interesting bug that's been missed since doc-diff was introduced.
> >
> > I'm not sure what you mean about doc-diff here. Patch 5 (of 5?) doesn't
> > seem related. Patch 4 is related only tangentially, in that you might
> > have more stuff in your Documentation directory.
> 
> That's how it's related, the lint script recursively looks for all *.txt
> under Documentation/, before doc-diff we could safely assume this was
> *.txt at that version of the repository, after doc-diff our recursively
> search leads us to a different checkout at a different revision.
> 
> I don't think it had any practical effect, just say'n.

OK, thanks. I just wanted to make sure I wasn't missing something.

-Peff