pr-1485/newren/header-cleanups-v2
tagged this
24 Feb 00:09
Maintainer note: This series cleanly merges with next, but has TWO minor
conflicts with ed/fsmonitor-inotify. The correct resolution is to take
ed/fsmonitor-inotify's copy of both compat/fsmonitor/fsm-settings-darwin.c
and compat/fsmonitor/fsm-ipc-darwin.c, but to add a #include
"git-compat-util.h" line at the top of compat/fsmonitor/fsm-settings-unix.c
and a #include "hex.h" somewhere near the top of
compat/fsmonitor/fsm-ipc-unix.c
Changes since v1:
* Fixed a bad squash; moved the changes to the right commit
* More thorough justification in the commit message for the 2nd commit
* Removed an accidental added include of gettext.h (the file was used, but
it makes it harder to review that patch)
* Add some explanation of surprising changes to commit messages
* Add a new commit which removes the include of hex.h from cache.h, and
instead makes C files include it directly, as suggested by Stolee
This series cleans up headers a bit, trying to remove excessive dependency
on "cache.h". I created this series a while ago, but decided to clean it up
and submit it due to Emily's recent thread and suggestion that this might be
helpful to their efforts[1].
There are many more cleanups I could do in this area, but the series is
already a good size.
Notes:
* Big props to Dscho for gitgitgadget; being able to test on a bunch of
platforms with a variety of configurations easily is a big win in general
but especially for series like this one.
* I used the scripts at
https://github.com/newren/git/commit/db81c8d7fb554b3edf04320e218bddeb98bb6194,
and some tweaks thereof, repeatedly while making this series (though they
are prone to produce both false positive and false negatives, so if you
use them, only use them to generate hints about which files to look at).
[1] Search for "Extremely yes" in
https://lore.kernel.org/git/CAJoAoZm+TkCL0Jpg_qFgKottxbtiG2QOiY0qGrz3-uQy+=waPg@mail.gmail.com/
Elijah Newren (17):
treewide: ensure one of the appropriate headers is sourced first
treewide: remove unnecessary git-compat-util.h includes in headers
treewide: remove unnecessary cache.h includes
treewide: remove unnecessary cache.h includes in source files
alloc.h: move ALLOC_GROW() functions from cache.h
hash.h: move some oid-related declarations from cache.h
hex.h: move some hex-related declarations from cache.h
cache.h: remove dependence on hex.h; make other files include it
explicitly
pretty.h: move has_non_ascii() declaration from commit.h
ident.h: move ident-related declarations out of cache.h
object.h: stop depending on cache.h; make cache.h depend on object.h
dir.h: refactor to no longer need to include cache.h
object-store.h: move struct object_info from cache.h
replace-object.h: move read_replace_refs declaration from cache.h to
here
treewide: replace cache.h with more direct headers, where possible
Remove unnecessary includes of builtin.h
diff.h: remove unnecessary include of object.h
Documentation/CodingGuidelines | 8 +-
add-interactive.c | 1 +
add-patch.c | 1 +
advice.c | 4 +-
advice.h | 2 -
alias.c | 4 +-
alloc.c | 2 +-
alloc.h | 75 +++++
apply.c | 2 +
archive-tar.c | 4 +-
archive-zip.c | 1 +
archive.c | 4 +-
attr.c | 1 +
bisect.c | 1 +
blame.c | 1 +
blame.h | 1 -
blob.c | 2 +-
branch.c | 1 +
builtin/am.c | 1 +
builtin/bisect.c | 1 +
builtin/blame.c | 4 +-
builtin/cat-file.c | 4 +
builtin/check-mailmap.c | 1 +
builtin/checkout--worker.c | 1 +
builtin/checkout.c | 1 +
builtin/clone.c | 1 +
builtin/commit-graph.c | 2 +
builtin/commit-tree.c | 1 +
builtin/config.c | 3 +-
builtin/credential-cache--daemon.c | 1 +
builtin/describe.c | 1 +
builtin/diff-tree.c | 1 +
builtin/difftool.c | 1 +
builtin/fast-export.c | 1 +
builtin/fast-import.c | 1 +
builtin/fetch-pack.c | 2 +
builtin/fetch.c | 1 +
builtin/fsck.c | 2 +
builtin/fsmonitor--daemon.c | 1 +
builtin/gc.c | 1 +
builtin/grep.c | 2 +
builtin/hash-object.c | 1 +
builtin/index-pack.c | 3 +
builtin/log.c | 4 +-
builtin/ls-remote.c | 1 +
builtin/ls-tree.c | 1 +
builtin/merge-base.c | 1 +
builtin/merge-index.c | 1 +
builtin/merge-tree.c | 1 +
builtin/merge.c | 2 +
builtin/mktag.c | 1 +
builtin/mktree.c | 2 +
builtin/mv.c | 1 +
builtin/name-rev.c | 3 +-
builtin/notes.c | 1 +
builtin/pack-objects.c | 4 +-
builtin/pack-redundant.c | 1 +
builtin/patch-id.c | 1 +
builtin/prune.c | 2 +
builtin/pull.c | 1 +
builtin/read-tree.c | 1 +
builtin/rebase.c | 1 +
builtin/receive-pack.c | 1 +
builtin/repack.c | 3 +-
builtin/replace.c | 2 +
builtin/reset.c | 1 +
builtin/rev-list.c | 1 +
builtin/rev-parse.c | 2 +
builtin/revert.c | 3 +-
builtin/rm.c | 1 +
builtin/send-pack.c | 1 +
builtin/show-branch.c | 1 +
builtin/show-index.c | 1 +
builtin/show-ref.c | 1 +
builtin/stash.c | 1 +
builtin/submodule--helper.c | 2 +
builtin/tag.c | 1 +
builtin/unpack-file.c | 1 +
builtin/unpack-objects.c | 2 +
builtin/update-index.c | 1 +
builtin/upload-pack.c | 1 +
builtin/var.c | 1 +
builtin/worktree.c | 1 +
builtin/write-tree.c | 1 +
bulk-checkin.c | 4 +-
bundle.c | 1 +
cache-tree.c | 4 +-
cache-tree.h | 1 -
cache.h | 305 +------------------
cbtree.c | 1 +
cbtree.h | 2 -
checkout.h | 2 +-
chunk-format.c | 3 +-
chunk-format.h | 1 -
color.c | 1 +
combine-diff.c | 1 +
commit-graph.c | 1 +
commit-graph.h | 1 -
commit-reach.c | 4 +-
commit-slab-impl.h | 2 -
commit.c | 1 +
commit.h | 1 -
compat/fsmonitor/fsm-ipc-darwin.c | 1 +
compat/fsmonitor/fsm-ipc-win32.c | 1 +
compat/fsmonitor/fsm-settings-darwin.c | 1 +
compat/mingw.c | 1 +
config.c | 5 +-
connect.c | 1 +
connected.c | 1 +
convert.c | 1 +
daemon.c | 1 +
decorate.c | 3 +-
delta-islands.c | 4 +-
diagnose.c | 1 +
diff-lib.c | 1 +
diff-merges.c | 2 +
diff-no-index.c | 1 -
diff.c | 2 +
diff.h | 3 +-
diffcore-delta.c | 2 +-
diffcore-order.c | 3 +-
diffcore-pickaxe.c | 4 +-
diffcore-rename.c | 7 +-
diffcore-rotate.c | 3 +-
diffcore.h | 4 +-
dir-iterator.c | 3 +-
dir.c | 3 +-
dir.h | 16 +-
entry.c | 1 +
entry.h | 4 +-
environment.c | 1 +
ewah/bitmap.c | 3 +-
ewah/ewah_bitmap.c | 2 +-
fetch-pack.c | 4 +-
fmt-merge-msg.c | 3 +
fsck.c | 4 +-
fsck.h | 1 +
fsmonitor-settings.c | 3 +-
git-compat-util.h | 1 +
git.c | 1 +
gpg-interface.c | 1 +
graph.c | 3 +-
grep.c | 1 +
hash.h | 35 ++-
hashmap.c | 2 +-
help.c | 4 +-
hex.c | 3 +-
hex.h | 84 +++++
hook.c | 5 +-
http-backend.c | 4 +-
http-fetch.c | 1 +
http-push.c | 1 +
http-walker.c | 1 +
http.c | 1 +
ident.c | 5 +-
ident.h | 67 ++++
imap-send.c | 2 +-
json-writer.c | 2 +-
khash.h | 1 -
kwset.c | 2 +-
levenshtein.c | 2 +-
line-log.c | 2 +
line-log.h | 1 +
linear-assignment.c | 2 +-
list-objects-filter-options.c | 4 +-
list-objects-filter-options.h | 3 +-
list-objects-filter.c | 2 +
list-objects.c | 1 +
log-tree.c | 2 +
ls-refs.c | 1 +
mailinfo.c | 4 +-
match-trees.c | 1 +
mem-pool.c | 2 +-
merge-blobs.c | 2 +-
merge-ort.c | 1 +
merge-recursive.c | 2 +-
merge.c | 1 +
midx.c | 4 +-
negotiator/noop.c | 2 +-
negotiator/skipping.c | 1 +
notes-merge.c | 1 +
notes.c | 1 +
object-file.c | 4 +-
object-name.c | 1 +
object-store.h | 128 ++++----
object.c | 1 +
object.h | 22 +-
oid-array.c | 3 +-
oidmap.c | 2 +-
oidmap.h | 1 -
oidset.c | 4 +-
oidtree.c | 1 +
oss-fuzz/fuzz-commit-graph.c | 1 +
oss-fuzz/fuzz-pack-headers.c | 1 +
oss-fuzz/fuzz-pack-idx.c | 1 +
pack-bitmap-write.c | 4 +-
pack-bitmap.c | 4 +-
pack-check.c | 1 +
pack-mtimes.h | 2 -
pack-objects.c | 3 +-
pack-write.c | 1 +
packfile.c | 4 +-
parallel-checkout.c | 2 +
patch-ids.c | 1 +
path.c | 1 +
pathspec.h | 5 +
pkt-line.c | 1 +
pkt-line.h | 1 -
pretty.c | 2 +
pretty.h | 4 +-
prio-queue.c | 3 +-
promisor-remote.c | 1 +
protocol-caps.c | 2 +
prune-packed.c | 1 +
quote.c | 2 +
reachable.c | 1 +
read-cache.c | 2 +
rebase.c | 1 +
ref-filter.c | 6 +-
reflog-walk.c | 3 +-
reflog-walk.h | 2 -
refs.c | 4 +-
refs/debug.c | 3 +-
refs/files-backend.c | 2 +
refs/packed-backend.c | 4 +-
refs/ref-cache.c | 3 +-
refs/refs-internal.h | 1 -
refspec.c | 4 +-
remote-curl.c | 4 +-
remote.c | 4 +-
remote.h | 1 -
replace-object.c | 1 +
replace-object.h | 8 +
repo-settings.c | 2 +-
repository.h | 1 -
rerere.c | 4 +-
reset.c | 1 +
revision.c | 4 +-
revision.h | 1 +
send-pack.c | 3 +-
sequencer.c | 2 +
sequencer.h | 2 +-
serve.c | 3 +-
server-info.c | 4 +-
sha1dc_git.c | 4 +-
shallow.c | 4 +-
shallow.h | 2 +
shell.c | 2 +-
sigchain.c | 3 +-
sparse-index.c | 1 +
split-index.c | 1 +
statinfo.h | 24 ++
strbuf.c | 4 +-
string-list.c | 3 +-
strvec.c | 4 +-
sub-process.c | 1 +
sub-process.h | 1 -
submodule-config.c | 2 +
submodule-config.h | 1 -
submodule.c | 5 +-
t/helper/test-bloom.c | 3 +-
t/helper/test-cache-tree.c | 1 +
t/helper/test-crontab.c | 1 -
t/helper/test-ctype.c | 1 -
t/helper/test-dump-cache-tree.c | 1 +
t/helper/test-dump-split-index.c | 1 +
t/helper/test-dump-untracked-cache.c | 1 +
t/helper/test-example-decorate.c | 2 +-
t/helper/test-fast-rebase.c | 1 +
t/helper/test-hash.c | 1 +
t/helper/test-json-writer.c | 1 -
t/helper/test-match-trees.c | 1 +
t/helper/test-oid-array.c | 1 +
t/helper/test-oidmap.c | 1 +
t/helper/test-oidtree.c | 1 +
t/helper/test-pack-mtimes.c | 1 +
t/helper/test-partial-clone.c | 1 +
t/helper/test-pcre2-config.c | 1 -
t/helper/test-prio-queue.c | 1 -
t/helper/test-proc-receive.c | 1 +
t/helper/test-reach.c | 3 +-
t/helper/test-read-midx.c | 1 +
t/helper/test-ref-store.c | 1 +
t/helper/test-repository.c | 1 +
t/helper/test-run-command.c | 2 -
t/helper/test-sigchain.c | 1 -
t/helper/test-simple-ipc.c | 3 +-
t/helper/test-submodule-nested-repo-config.c | 1 +
t/helper/test-wildmatch.c | 1 -
tag.c | 1 +
thread-utils.c | 2 +-
trace.h | 1 -
trace2.c | 3 +-
trace2/tr2_ctr.c | 2 +-
trace2/tr2_sid.c | 1 +
trace2/tr2_sysenv.c | 2 +-
trace2/tr2_tbuf.c | 2 +-
trace2/tr2_tgt_event.c | 2 +-
trace2/tr2_tgt_normal.c | 2 +-
trace2/tr2_tgt_perf.c | 2 +-
trace2/tr2_tls.c | 4 +-
trace2/tr2_tmr.c | 3 +-
trailer.c | 1 +
transport-helper.c | 1 +
transport.c | 5 +-
tree-walk.c | 2 +
tree-walk.h | 4 +-
tree.c | 1 +
unix-socket.c | 3 +-
unix-stream-server.c | 2 +-
unpack-trees.c | 1 +
upload-pack.c | 1 +
url.c | 4 +-
urlmatch.c | 5 +-
userdiff.c | 4 +-
walker.c | 1 +
wildmatch.c | 2 +-
worktree.c | 3 +-
worktree.h | 1 -
wt-status.c | 1 +
xdiff-interface.c | 1 +
xdiff-interface.h | 2 +-
322 files changed, 858 insertions(+), 529 deletions(-)
create mode 100644 hex.h
create mode 100644 ident.h
create mode 100644 statinfo.h
base-commit: 06dd2baa8da4a73421b959ec026a43711b9d77f9
Submitted-As: https://lore.kernel.org/git/pull.1485.v2.git.1677197376.gitgitgadget@gmail.com
In-Reply-To: https://lore.kernel.org/git/pull.1485.git.1677139521.gitgitgadget@gmail.com
Assets 2
-
2023-02-24T00:09:38Z -
2023-02-24T00:09:38Z -