]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/Makefile
ci: validate "linkgit:" in documentation
authorJunio C Hamano <gitster@pobox.com>
Wed, 4 May 2016 21:34:23 +0000 (14:34 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 10 May 2016 18:15:04 +0000 (11:15 -0700)
commitab81411cede9e5fe52b416c4df835e19f1048426
tree58e4c5853e7e686294ecb73e3fd8d04bb4159528
parent90f7b16b3adc78d4bbabbd426fb69aa78c714f71
ci: validate "linkgit:" in documentation

It is easy to add incorrect "linkgit:<page>[<section>]" references
to our documentation suite.  Catch these common classes of errors:

 * Referring to Documentation/<page>.txt that does not exist.

 * Referring to a <page> outside the Git suite.  In general, <page>
   must begin with "git".

 * Listing the manual <section> incorrectly.  The first line of the
   Documentation/<page>.txt must end with "(<section>)".

with a new script "ci/lint-gitlink", and drive it from "make check-docs".

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/Makefile
Documentation/lint-gitlink.perl [new file with mode: 0755]
Makefile