From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: "Matthias Aßhauer via GitGitGadget" <gitgitgadget@gmail.com>,
git@vger.kernel.org, "Eric Sunshine" <sunshine@sunshineco.com>,
"Matthias Aßhauer" <mha1993@live.de>,
"Lars Schneider" <larsxschneider@gmail.com>
Subject: Re: Is "make check-docs" useful anymore?
Date: Fri, 24 Sep 2021 10:59:07 -0700 [thread overview]
Message-ID: <xmqqpmsxvor8.fsf@gitster.g> (raw)
In-Reply-To: <87o88i2keu.fsf@evledraar.gmail.com> ("Ævar Arnfjörð Bjarmason"'s message of "Fri, 24 Sep 2021 15:00:42 +0200")
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
> I didn't notice until after it hit master that this caused a regression
> in "make check-docs":
>
> $ make -s check-docs
> removed but documented: git-version
>
> The "fix" is rather easy, i.e. adding "git-version" to the whitelist.
>
> But I wondered about $subject, i.e. we want to run the "lint" part, but
> do we really need something reminding us that there isn't a mapping
> between Documentation/*.txt and *.o files present at the top-level?
There were multiple things check-docs wanted to catch originally.
- commands not referred to from the main page
- a new command added without documentation
- an old command removed while leaving documentation
It may be that we no longer remove commands, so the last check may
be less useful.
> If we're going to keep it in pretty much its current form then the CI
> integration added in b98712b9aa9 (travis-ci: build documentation,
> 2016-05-04) seems rather useless when it comes to this, i.e. we should
> either adjust it to exit non-zero,...
Yes, that is a good thing to do.
Thanks.
prev parent reply other threads:[~2021-09-24 17:59 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-13 11:06 [PATCH 0/2] documentation: handle non-existing html pages and document 'git version' Matthias Aßhauer via GitGitGadget
2021-09-13 11:06 ` [PATCH 1/2] help: make sure local html page exists before calling external processes Matthias Aßhauer via GitGitGadget
2021-09-13 15:59 ` Eric Sunshine
2021-09-13 16:17 ` Matthias Aßhauer
2021-09-13 19:25 ` Junio C Hamano
2021-09-13 11:06 ` [PATCH 2/2] documentation: add documentation for 'git version' Matthias Aßhauer via GitGitGadget
2021-09-13 11:19 ` Ævar Arnfjörð Bjarmason
2021-09-13 11:46 ` Matthias Aßhauer
2021-09-13 19:43 ` Junio C Hamano
2021-09-14 13:27 ` [PATCH v2 0/2] documentation: handle non-existing html pages and document " Matthias Aßhauer via GitGitGadget
2021-09-14 13:27 ` [PATCH v2 1/2] help: make sure local html page exists before calling external processes Matthias Aßhauer via GitGitGadget
2021-09-14 13:27 ` [PATCH v2 2/2] documentation: add documentation for 'git version' Matthias Aßhauer via GitGitGadget
2021-09-24 13:00 ` Is "make check-docs" useful anymore? Ævar Arnfjörð Bjarmason
2021-09-24 17:59 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqpmsxvor8.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=larsxschneider@gmail.com \
--cc=mha1993@live.de \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).