From: Patrick Steinhardt <ps@pks•im>
To: Junio C Hamano <gitster@pobox•com>
Cc: git@vger•kernel.org
Subject: Re: [RFC] doc: check-docs and WITH_BREAKING_CHANGES
Date: Tue, 23 Sep 2025 10:03:31 +0200 [thread overview]
Message-ID: <aNJUUxfhM7QYDQGj@pks.im> (raw)
In-Reply-To: <xmqqjz1u161e.fsf@gitster.g>
On Fri, Sep 19, 2025 at 02:33:33PM -0700, Junio C Hamano wrote:
> Shouldn't we do something like this for breaking builds?
>
> Documentation/Makefile pays attention to EXCLUDED_PROGRAMS to
> pretend that the git-$deprecated.adoc files do not exist
>
> -include GIT-EXCLUDED-PROGRAMS
>
> MAN1_TXT += $(filter-out \
> $(patsubst %,%.adoc,$(EXCLUDED_PROGRAMS)) \
> $(addsuffix .adoc, $(ARTICLES) $(SP_ARTICLES)), \
> $(wildcard git-*.adoc))
>
> but nobody seems to put the removed programs on the list.
>
> The dependencies around Documentation/GIT-EXCLUDED-PROGRAMS is still
> screwed up, I think, but this may be a good first step to straighten
> it out. If "make -C Documentation" runs lint-docs by default, for
> example, we may want to tweak the Makefile down there to make
> link-docs target depend on the GIT-EXCLUDED-PROGRAMS perhaps.
>
> diff --git i/Makefile w/Makefile
> index 893070be76..711cade8fd 100644
> --- i/Makefile
> +++ w/Makefile
Curious, but what's up with the "i" and "w" prefixes here? :)
> @@ -892,6 +892,8 @@ BUILT_INS += git-switch$X
> BUILT_INS += git-version$X
> ifndef WITH_BREAKING_CHANGES
> BUILT_INS += git-whatchanged$X
> +else
> +EXCLUDED_PROGRAMS += git-whatchanged
> endif
>
> # what 'all' will build but not install in gitexecdir
I think this change makes sense indeed. It means that we stop linting
the docs, which is a bit of a weird side effect that may or may not be
sensible. But in any case, we should probably stop installing these man
pages.
I say "probably" because this got me thinking: we could keep the man
page for a while, but completely replace their its with a notice saying
that the command got removed. Even better, we could even tell users what
the replacement is.
Patrick
next prev parent reply other threads:[~2025-09-23 8:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-19 21:33 [RFC] doc: check-docs and WITH_BREAKING_CHANGES Junio C Hamano
2025-09-23 8:03 ` Patrick Steinhardt [this message]
2025-09-23 13:30 ` Ben Knoble
2025-09-23 13:58 ` Patrick Steinhardt
2025-09-23 14:43 ` Junio C Hamano
2025-09-23 14:50 ` Patrick Steinhardt
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aNJUUxfhM7QYDQGj@pks.im \
--to=ps@pks$(echo .)im \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox