mirror of
https://github.com/git-for-windows/git.git
synced 2026-07-14 11:42:39 -05:00
survey: turn into a thin shim over git repo structure
`git survey` was an experimental scale-measurement tool whose
distinctive features (ref-kind filters, top-N path tables) are now
all available in `git repo structure`. With the path-level reporting
in place (commits "repo: filter the structure scope via
--ref-filter=<pattern>" and "repo: report top-N paths by count, disk,
and inflated size in structure"), there is no functionality `git
survey` provides that `git repo structure` cannot.
Replace the 764-line `git survey` implementation with a roughly
hundred-line shim that:
* Accepts the existing `git survey` command line so callers in
scripts continue to parse without changes.
* Emits a deprecation warning naming the replacement command, so
interactive users learn about the migration target.
* Translates the survey-specific knobs into the equivalent
`git repo structure` invocation and re-execs the canonical
command via `execv_git_cmd()`. Per-kind ref selectors fan out
into the corresponding `refs/heads/*`, `refs/tags/*`, etc.
`--ref-filter` patterns; `--top=<N>` is forwarded directly;
`--all-refs` becomes the absence of any `--ref-filter`.
Two survey options have no `git repo structure` counterpart:
`--verbose` controlled per-step trace output the new command does
not emit, and `--detached` selected the detached HEAD which
`git repo structure` does not enumerate separately. Both are
silently accepted and produce a single warning each, so old
invocations keep working while the absence of these knobs in `git
repo structure` is made visible.
Rewrite t8100 to assert the shim's contract: the deprecation
warning is printed, the output is byte-identical to a corresponding
`git repo structure` invocation, and the per-kind selector
translation produces the right `--ref-filter` pattern. The
preceding survey-specific output assertions (the multi-column
plaintext tables) no longer apply, since `git repo structure`'s
output format is now the canonical one and is covered by t1901.
The `survey.*` configuration keys (`survey.top`, `survey.progress`,
`survey.verbose`) are no longer honored by the shim. They were
mirrored by the preceding `repo.structure.top` work for the most
useful knob; users with `survey.top` set in config should migrate
to `repo.structure.top`. This is a backward-incompatible removal
documented by the deprecation notice in `git-survey.adoc`.
Assisted-by: Opus 4.7
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
This commit is contained in:
Johannes Schindelin
committed by
Git for Windows Build Agent
Git for Windows Build Agent
parent
cbea3d2f6b
commit
57ee9abd09
@@ -17,8 +17,8 @@ NOTE: `git survey` is being superseded by `git repo structure`. New
|
||||
deployments and new features should use `git repo structure`; its
|
||||
`--ref-filter=<pattern>` option subsumes the various `--branches`,
|
||||
`--tags`, and `--remotes` flags here, and `--top=<N>` provides the
|
||||
same detail tables. A future release will turn `git survey` into a
|
||||
thin shim over `git repo structure`. See linkgit:git-repo[1].
|
||||
same detail tables. During the deprecation phase, `git survey` is
|
||||
a thin shim over `git repo structure`. See linkgit:git-repo[1].
|
||||
|
||||
Survey the repository and measure various dimensions of scale.
|
||||
|
||||
|
||||
1003
builtin/survey.c
1003
builtin/survey.c
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
||||
#!/bin/sh
|
||||
|
||||
test_description='git survey'
|
||||
test_description='git survey (deprecated shim over `git repo structure`)'
|
||||
|
||||
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
|
||||
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
|
||||
@@ -10,9 +10,9 @@ export TEST_PASSES_SANITIZE_LEAK
|
||||
|
||||
. ./test-lib.sh
|
||||
|
||||
test_expect_success 'git survey -h shows experimental warning' '
|
||||
test_expect_success 'git survey -h shows the deprecated banner' '
|
||||
test_expect_code 129 git survey -h >usage &&
|
||||
grep "EXPERIMENTAL!" usage
|
||||
grep "DEPRECATED!" usage
|
||||
'
|
||||
|
||||
test_expect_success 'create a semi-interesting repo' '
|
||||
@@ -25,84 +25,28 @@ test_expect_success 'create a semi-interesting repo' '
|
||||
git update-ref -d refs/tags/two
|
||||
'
|
||||
|
||||
test_expect_success 'git survey --progress' '
|
||||
GIT_PROGRESS_DELAY=0 git survey --all-refs --progress >out 2>err &&
|
||||
grep "Preparing object walk" err
|
||||
test_expect_success 'survey prints a deprecation warning' '
|
||||
git survey --all-refs >out 2>err &&
|
||||
grep "is deprecated" err
|
||||
'
|
||||
|
||||
approximate_sizes() {
|
||||
# very simplistic approximate rounding
|
||||
sed -Ee "s/ *(1[0-9][0-9])( |$)/ ~0.1kB\2/g" \
|
||||
-e "s/ *(4[6-9][0-9]|5[0-6][0-9])( |$)/ ~0.5kB\2/g" \
|
||||
-e "s/ *(5[6-9][0-9]|6[0-6][0-9])( |$)/ ~0.6kB\2/g" \
|
||||
-e "s/ *1(4[89][0-9]|5[0-8][0-9])( |$)/ ~1.5kB\2/g" \
|
||||
-e "s/ *1(69[0-9]|7[0-9][0-9])( |$)/ ~1.7kB\2/g" \
|
||||
-e "s/ *1(79[0-9]|8[0-9][0-9])( |$)/ ~1.8kB\2/g" \
|
||||
-e "s/ *2(1[0-9][0-9]|20[0-1])( |$)/ ~2.1kB\2/g" \
|
||||
-e "s/ *2(3[0-9][0-9]|4[0-1][0-9])( |$)/ ~2.3kB\2/g" \
|
||||
-e "s/ *2(5[0-9][0-9]|6[0-1][0-9])( |$)/ ~2.5kB\2/g" \
|
||||
"$@"
|
||||
}
|
||||
test_expect_success 'survey forwards to git repo structure' '
|
||||
git survey --all-refs >survey-out 2>survey-err &&
|
||||
git repo structure --top=10 >structure-out 2>structure-err &&
|
||||
test_cmp structure-out survey-out
|
||||
'
|
||||
|
||||
test_expect_success 'git survey (default)' '
|
||||
git survey --all-refs >out 2>err &&
|
||||
test_line_count = 0 err &&
|
||||
test_expect_success 'survey --top is translated' '
|
||||
git survey --top=3 --all-refs >out &&
|
||||
git repo structure --top=3 >expected &&
|
||||
test_cmp expected out
|
||||
'
|
||||
|
||||
test_oid_cache <<-EOF &&
|
||||
commits_sizes sha1:~1.5kB | ~2.1kB
|
||||
commits_sizes sha256:~1.8kB | ~2.5kB
|
||||
trees_sizes sha1:~0.5kB | ~1.7kB
|
||||
trees_sizes sha256:~0.6kB | ~2.3kB
|
||||
blobs_sizes sha1:~0.1kB | ~0.1kB
|
||||
blobs_sizes sha256:~0.1kB | ~0.1kB
|
||||
tags_sizes sha1:~0.5kB | ~0.5kB
|
||||
tags_sizes sha256:~0.5kB | ~0.6kB
|
||||
EOF
|
||||
|
||||
tr , " " >expect <<-EOF &&
|
||||
GIT SURVEY for "$(pwd)"
|
||||
-----------------------------------------------------
|
||||
|
||||
REFERENCES SUMMARY
|
||||
========================
|
||||
, Ref Type | Count
|
||||
-----------------+------
|
||||
, Branches | 1
|
||||
Remote refs | 0
|
||||
Tags (all) | 2
|
||||
Tags (annotated) | 2
|
||||
|
||||
REACHABLE OBJECT SUMMARY
|
||||
========================
|
||||
Object Type | Count
|
||||
------------+------
|
||||
Tags | 4
|
||||
Commits | 10
|
||||
Trees | 10
|
||||
Blobs | 10
|
||||
|
||||
TOTAL OBJECT SIZES BY TYPE
|
||||
===============================================
|
||||
Object Type | Count | Disk Size | Inflated Size
|
||||
------------+-------+-----------+--------------
|
||||
Commits | 10 | $(test_oid commits_sizes)
|
||||
Trees | 10 | $(test_oid trees_sizes)
|
||||
Blobs | 10 | $(test_oid blobs_sizes)
|
||||
Tags | 4 | $(test_oid tags_sizes)
|
||||
EOF
|
||||
|
||||
approximate_sizes out >out-edited &&
|
||||
lines=$(wc -l <expect) &&
|
||||
head -n "$lines" <out-edited >out-trimmed &&
|
||||
test_cmp expect out-trimmed &&
|
||||
|
||||
for type in "DIRECTORIES" "FILES"
|
||||
do
|
||||
for metric in "COUNT" "DISK SIZE" "INFLATED SIZE"
|
||||
do
|
||||
grep "TOP $type BY $metric" out || return 1
|
||||
done || return 1
|
||||
done
|
||||
test_expect_success 'survey --branches translates to a refs/heads/* filter' '
|
||||
git survey --branches >out &&
|
||||
git repo structure --top=10 \
|
||||
--ref-filter="refs/heads/*" >expected &&
|
||||
test_cmp expected out
|
||||
'
|
||||
|
||||
test_done
|
||||
|
||||
Reference in New Issue
Block a user