[vim/vim] Better gitignore rule for src/auto/* (Issue #20814)

[qeatzy]

qeatzy created an issue (vim/vim#20814)

After build vim from source, there will be something remaining under directory src/auto, some of them remains even after run make clean and make distclean.

src/auto/wayland/ is one of the those directories that remain after build vim, which make commit to vim more error-prone and incur unnecessary manual intervention.

May I propose to change .gitignore rules related to src/auto?
Currently .gitignore has below lines

src/auto/if_perl.c
src/auto/gui_gtk_gresources.c
src/auto/gui_gtk_gresources.h
src/auto/os_haiku.rdef

# We do need src/auto/configure.
src/auto/config.cache
src/auto/config.h
src/auto/config.log
src/auto/config.mk
src/auto/config.status
src/auto/osdef.h
src/auto/link.log
src/auto/link.sed
src/auto/pathdef.c

It seems only src/auto/configure need to be tracked,
How about to replace above lines to below two lines?

src/auto/*
!src/auto/configure

Which provide better intention of only track src/auto/configure and ignore else under src/auto/.
Also it free developers from the burden of manual git rm src/auto/unneed-stuffs and inadvertently track unneeded files.

What do you think about above changes.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/20814@github.com>

[Christian Brabandt]

chrisbra left a comment (vim/vim#20814)

I think this makes sense. Technically, we also don't need to track auto/configure, but then you'll also need to first run make autoconf (well actually, no, make autoconf depends on auto/configure for whatever reason). Let me make the suggested change then.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/20814/5049047210@github.com>

[dezza]

dezza left a comment (vim/vim#20814)

Got an idea, satisfy both:

• contributors who don't need to change configure.ac and want clean worktree.
• contributors who need to change configure.ac and want modified src/auto/configure

You could have Makefile targets:

make gitignore-configure

git update-index --skip-worktree 'src/auto/configure' # will never commit `src/auto/configure`

make autoconf (and make gitunignore-configure)

# ensure `M src/auto/configure` is shown in git-status and tracked.
git update-index --no-skip-worktree 'src/auto/configure'

Since people always have to run make autoconf anyway on changing it - it would solve itself, if make gitignore-configure ran previously. When running that gitignore-configure make target, it should warn about which messages you see, if you attempt git rebase while this is active.

error: cannot apply patch to 'src/auto/configure' because it is locally modified.
hint: The file is marked as skip-worktree, so Git is ignoring your changes.
hint: Remove the skip-worktree bit and try again:
hint:   git update-index --no-skip-worktree src/auto/configure

Its a pretty telling message by itself, but its good to warn anyways.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/20814/5066173874@github.com>