public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Phillip Wood <phillip.wood123@gmail.com>
To: Patrick Steinhardt <ps@pks.im>,
	"D. Ben Knoble" <ben.knoble+github@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Evan Martin <evan.martin@gmail.com>
Subject: Re: [PATCH] meson: regenerate config-list.h when Documentation changes
Date: Wed, 11 Feb 2026 10:57:10 +0000	[thread overview]
Message-ID: <81ff4cc8-676e-43fe-8193-609887b887d6@gmail.com> (raw)
In-Reply-To: <4a566010-821b-4078-9563-9ca00ada55a0@gmail.com>

On 11/02/2026 09:44, Phillip Wood wrote:
> On 11/02/2026 07:42, Patrick Steinhardt wrote:
>> On Mon, Feb 09, 2026 at 04:50:06PM -0500, D. Ben Knoble wrote:
>>>> On Sat, Feb 07, 2026 at 04:59:17PM -0500, D. Ben Knoble wrote:
>> [snip]
>>> Only, things are behaving oddly. For example:
>>>
>>>      λ meson setup build2
>>>      λ ninja -C build2
>>>
>>> works fine, but
>>>
>>>      λ ls -l build2/config*
>>>      -rw-r--r-- 1 benknoble benknoble 17169  9 févr. 16:39 build2/ 
>>> config-list.h
>>>
>>> I don't see the dependency file.

I've just had a play with this and I don't see the dependency file 
either - I wonder if ninja deletes it after it has read it.

If I delete Documentation/config/add.adoc then config-list.h is rebuilt. 
However if I edit generate-configlist.sh it is not rebuilt - I guess we 
need to add the script to the dependency file.

Thanks

Phillip

>>> Further, re-building seems to get stuck (I get
>>> similar symptoms if I add or remove a relevant config.adoc file, but 
>>> let's keep
>>> it simple for now):
>>>
>>>      λ ninja -C build2
>>>      ninja: Entering directory `build2'
>>>      [1/28] Generating GIT-VERSION-FILE with a custom command 
>>> (wrapped by meson to set env)
>>
>> With "stuck" you mean that it doesn't do anything, or that it doesn't
>> actually rebuild?
>>
>> I guess it kind of makes sense that a new file wouldn't trigger a
>> rebuild, even though I would have expected a removed one to trigger one.
>> After all, the dependency file only tracks the set of _existing_ files
>> so that we know when to rebuild, and of course the dependency file only
>> gets regenerated in case any of those files changes.
> 
> If anyone adds a new file under Documentation/config/ they will need to 
> update Documentation/config.adoc which should then trigger the rebuild. 
> That rebuld will then add the new file to the list of dependencies. If 
> they remove a file we should pick that up with the dependencies that are 
> already listed.
> 
> Do we need to create the depfile when meson is setup? What does meson do 
> when the depfile is missing?
> 
>> The thing is that build systems like Meson really want to know the list
>> of files ahead of time so that they can have an optimal build graph. So
>> we could of course list all the files that we actually depend on. But I
>> guess that's something we want to avoid?
>>
>> There's another, alternative approach: you can have a separate build
>> step that's marked as `build_always_stale: true` that lists all the
>> config files. This step would then always run, and it would only update
>> its target file in case any of the files has changed.
> 
> It would be really nice if we can avoid regenerating the depfile with 
> every build.
> 
> Thanks
> 
> Phillip
> 
>> Combined with the depfile we'd then rebuild in all cases:
>>
>>    - When a file gets added or removed, as that would cause the
>>      `build_always_stale` target to be rewritten.
>>
>>    - When any of the files changes, because that would cause the
>>      dependencies in the depfile to change.
>>
>> Something like the attached patch (note that I don't perform the
>> necessary changes for the Makefile). I confirmed that it works for all
>> of the above cases.
>>
>> Thanks!
>>
>> Patrick
>>
>> --- >8 ---
>>
>> diff --git a/generate-configlist.sh b/generate-configlist.sh
>> index 75c39ade20..17605e6f77 100755
>> --- a/generate-configlist.sh
>> +++ b/generate-configlist.sh
>> @@ -1,13 +1,6 @@
>>   #!/bin/sh
>> -SOURCE_DIR="$1"
>> -OUTPUT="$2"
>> -
>> -if test -z "$SOURCE_DIR" || ! test -d "$SOURCE_DIR" || test -z "$OUTPUT"
>> -then
>> -    echo >&2 "USAGE: $0 <SOURCE_DIR> <OUTPUT>"
>> -    exit 1
>> -fi
>> +set -e
>>   print_config_list () {
>>       cat <<EOF
>> @@ -30,9 +23,50 @@ EOF
>>   EOF
>>   }
>> -{
>> -    echo "/* Automatically generated by generate-configlist.sh */"
>> -    echo
>> -    echo
>> -    print_config_list
>> -} >"$OUTPUT"
>> +case "$1" in
>> +generate)
>> +    SOURCE_DIR="$2"
>> +    OUTPUT="$3"
>> +    DEPFILE="$4"
>> +
>> +    if test -z "$SOURCE_DIR" || ! test -d "$SOURCE_DIR" || test -z 
>> "$OUTPUT"
>> +    then
>> +        echo >&2 "USAGE: $0 generate <SOURCE_DIR> <OUTPUT>"
>> +        exit 1
>> +    fi
>> +
>> +    if test -n "$DEPFILE"
>> +    then
>> +        printf "$OUTPUT: %s\n" "$SOURCE_DIR"/Documentation/ 
>> *config.adoc \
>> +            "$SOURCE_DIR"/Documentation/config/*.adoc >"$DEPFILE"
>> +    fi
>> +
>> +    {
>> +        echo "/* Automatically generated by generate-configlist.sh */"
>> +        echo
>> +        echo
>> +        print_config_list
>> +    } >"$OUTPUT"
>> +    ;;
>> +deps)
>> +    SOURCE_DIR="$2"
>> +    OUTPUT="$3"
>> +
>> +    if test -z "$SOURCE_DIR" || ! test -d "$SOURCE_DIR" || test -z 
>> "$OUTPUT"
>> +    then
>> +        echo >&2 "USAGE: $0 deps <SOURCE_DIR> <OUTPUT>"
>> +        exit 1
>> +    fi
>> +
>> +    TMPFILE=$(mktemp "$OUTPUT".XXXXXX)
>> +    printf "%s\n" "$SOURCE_DIR"/Documentation/*config.adoc \
>> +        "$SOURCE_DIR"/Documentation/config/*.adoc | sort >"$TMPFILE"
>> +
>> +    if ! test -f "$OUTPUT" || ! cmp "$TMPFILE" "$OUTPUT" >/dev/null
>> +    then
>> +        mv "$TMPFILE" "$OUTPUT"
>> +    else
>> +        rm "$TMPFILE"
>> +    fi
>> +    ;;
>> +esac
>> diff --git a/meson.build b/meson.build
>> index dd52efd1c8..6b9147a39a 100644
>> --- a/meson.build
>> +++ b/meson.build
>> @@ -716,14 +716,29 @@ if not get_option('breaking_changes')
>>     builtin_sources += 'builtin/pack-redundant.c'
>>   endif
>> +configlist_deps = custom_target(
>> +  output: 'config-list.h.deps',
>> +  command: [
>> +    meson.current_source_dir() + '/generate-configlist.sh',
>> +    'deps',
>> +    meson.current_source_dir(),
>> +    '@OUTPUT@',
>> +  ],
>> +  build_always_stale: true,
>> +)
>> +
>>   builtin_sources += custom_target(
>>     output: 'config-list.h',
>>     command: [
>>       shell,
>>       meson.current_source_dir() + '/generate-configlist.sh',
>> +    'generate',
>>       meson.current_source_dir(),
>>       '@OUTPUT@',
>> +    '@OUTPUT@.d',
>>     ],
>> +  depends: [ configlist_deps, ],
>> +  depfile: 'config-list.h.d',
>>     env: script_environment,
>>   )
>>
> 


  reply	other threads:[~2026-02-11 10:57 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-07 21:59 [PATCH] meson: regenerate config-list.h when Documentation changes D. Ben Knoble
2026-02-07 22:38 ` Ben Knoble
2026-02-09 15:19 ` [PATCH v2] " D. Ben Knoble
2026-02-11 23:51   ` [PATCH v3] " D. Ben Knoble
2026-02-12  8:06     ` Patrick Steinhardt
2026-02-12 10:29     ` Phillip Wood
2026-02-12 14:14       ` Phillip Wood
2026-02-12 15:56     ` Ben Knoble
2026-02-16 22:28     ` [PATCH v4] " D. Ben Knoble
2026-02-17  0:33       ` Ben Knoble
2026-02-17  7:03         ` Patrick Steinhardt
2026-02-17 13:28           ` D. Ben Knoble
2026-02-17  7:02       ` Patrick Steinhardt
2026-02-17 13:28         ` D. Ben Knoble
2026-02-17 20:24           ` Junio C Hamano
2026-02-17  9:20       ` Phillip Wood
2026-02-17 13:38         ` D. Ben Knoble
2026-02-17 15:11           ` Phillip Wood
2026-02-18 14:37       ` [PATCH v5] build: " D. Ben Knoble
2026-02-19 10:19         ` Phillip Wood
2026-02-19 13:40           ` D. Ben Knoble
2026-02-19 13:56         ` Patrick Steinhardt
2026-02-21 13:58           ` D. Ben Knoble
2026-02-19 15:10         ` Marc Branchaud
2026-02-21 13:58           ` D. Ben Knoble
2026-02-21 14:07         ` [PATCH v6] " D. Ben Knoble
2026-02-23  6:37           ` Patrick Steinhardt
2026-02-23  6:55           ` SZEDER Gábor
2026-02-23 21:41             ` Ben Knoble
2026-02-24  9:58               ` Patrick Steinhardt
2026-02-24 11:00                 ` Phillip Wood
2026-02-24 14:12                   ` D. Ben Knoble
2026-02-24 14:39           ` [PATCH v7] " D. Ben Knoble
2026-02-25 18:45             ` Junio C Hamano
2026-02-26  3:20               ` Ben Knoble
2026-02-09 15:25 ` [PATCH] meson: " Patrick Steinhardt
2026-02-09 21:50   ` D. Ben Knoble
2026-02-11  7:42     ` Patrick Steinhardt
2026-02-11  9:44       ` Phillip Wood
2026-02-11 10:57         ` Phillip Wood [this message]
2026-02-11 11:00           ` Patrick Steinhardt
2026-02-11 10:58         ` Patrick Steinhardt
2026-02-11 14:05           ` Phillip Wood
2026-02-11 20:15             ` D. Ben Knoble
2026-02-11 19:58       ` D. Ben Knoble
2026-02-12  8:10         ` 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=81ff4cc8-676e-43fe-8193-609887b887d6@gmail.com \
    --to=phillip.wood123@gmail.com \
    --cc=ben.knoble+github@gmail.com \
    --cc=evan.martin@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=phillip.wood@dunelm.org.uk \
    --cc=ps@pks.im \
    /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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox