FPhillip Wood <phillip.wood123@xxxxxxxxx> writes: > On 07/03/2025 10:32, Phillip Wood wrote: >> On 05/03/2025 15:53, Junio C Hamano wrote: >>> We correctly omit builtin/pack-objects.o from BUILTIN_OBJS, but >>> forgot to add "git pack-redundant" on the EXCLUDED_PROGRAMS list, >>> which made "make check-docs" target notice that the command has been >>> removed but still is documented. >>> >>> Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx> >>> --- >>> * The command is still listed in the resulting "git help git" >>> output, as cmd-list.perl does not yet know which commands on the >>> list are to be ignored under WITH_BREAKING_CHANGES. >> >> Good catch. It seems the meson build was also forgotten in 68f51871df8 >> (builtin/pack-redundant: remove subcommand with breaking changes, >> 2025-01-22) as we still compile builtin/pack-redundant.c and build the >> documentation. We should probably wrap the function declaration for >> cmd_pack_redundant() in builtin.h with "#ifndef WITH_BREAKING_CHANGES" >> as well though I don't think that is urgent. > > I just had a look at fixing the meson build but it seems to be tricky as > the manpage sources are stored in a meson dictionary and meson > dictionaries are immutable so I don't know how one is supposed to > conditionally add items. > But dictonaries can be combined [1]. So we could probably do something like I've added below. [1]: https://mesonbuild.com/Reference-manual_elementary_dict.html -- 8< -- diff --git a/Documentation/meson.build b/Documentation/meson.build index 0a0f2bfa14..fcfec63e9b 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -96,7 +96,6 @@ manpages = { 'git-notes.adoc' : 1, 'git-p4.adoc' : 1, 'git-pack-objects.adoc' : 1, - 'git-pack-redundant.adoc' : 1, 'git-pack-refs.adoc' : 1, 'git-patch-id.adoc' : 1, 'git-prune-packed.adoc' : 1, @@ -205,6 +204,14 @@ manpages = { 'gitworkflows.adoc' : 7, } +manpages_breaking_changes = { + 'git-pack-redundant.adoc' : 1, +} + +if not get_option('breaking_changes') + manpages += manpages_breaking_changes +endif + docs_backend = get_option('docs_backend') if docs_backend == 'auto' if find_program('asciidoc', dirs: program_path, required: false).found() @@ -475,7 +482,7 @@ endif # Sanity check that we are not missing any tests present in 't/'. This check # only runs once at configure time and is thus best-effort, only. Furthermore, # it only verifies man pages for the sake of simplicity. -configured_manpages = manpages.keys() + [ 'git-bisect-lk2009.adoc', 'git-tools.adoc' ] +configured_manpages = manpages.keys() + manpages_breaking_changes.keys() + [ 'git-bisect-lk2009.adoc', 'git-tools.adoc' ] actual_manpages = run_command(shell, '-c', 'ls git*.adoc scalar.adoc', check: true, env: script_environment,
Attachment:
signature.asc
Description: PGP signature
