diff options
| author |  Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2021-04-09 17:02:49 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-04-10 23:36:34 -0700 |
| commit | ea8b9271b17e64502dc80981cf09cec42739dce7 (patch) | |
| tree | 7660e38921c7d2d36df523bbefdbfbff260e9869 /Documentation/Makefile | |
| parent | doc lint: lint and fix missing "GIT" end sections (diff) | |
| download | tgif-ea8b9271b17e64502dc80981cf09cec42739dce7.tar.xz | |
doc lint: lint relative section order
Add a linting script to check the relative order of the sections in
the documentation. We should have NAME, then SYNOPSIS, DESCRIPTION,
OPTIONS etc. in that order.
That holds true throughout our documentation, except for a few
exceptions which are hardcoded in the linting script.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 34b4f5716a..5e0828869b 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -483,7 +483,8 @@ lint-docs:: --section=1 $(MAN1_TXT) \ --section=5 $(MAN5_TXT) \ --section=7 $(MAN7_TXT); \ - $(PERL_PATH) lint-man-end-blurb.perl $(MAN_TXT) + $(PERL_PATH) lint-man-end-blurb.perl $(MAN_TXT); \ + $(PERL_PATH) lint-man-section-order.perl $(MAN_TXT); ifeq ($(wildcard po/Makefile),po/Makefile) doc-l10n install-l10n:: |