diff options
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/buildsystems/CMakeLists.txt | 17 | ||||
| -rw-r--r-- | contrib/coccinelle/array.cocci | 82 | ||||
| -rw-r--r-- | contrib/coccinelle/tests/free.c | 11 | ||||
| -rw-r--r-- | contrib/coccinelle/tests/free.res | 9 | ||||
| -rw-r--r-- | contrib/coccinelle/tests/unused.c | 82 | ||||
| -rw-r--r-- | contrib/coccinelle/tests/unused.res | 45 | ||||
| -rw-r--r-- | contrib/coccinelle/unused.cocci | 43 | ||||
| -rw-r--r-- | contrib/completion/git-prompt.sh | 12 | ||||
| -rwxr-xr-x | contrib/credential/netrc/git-credential-netrc.perl | 5 | ||||
| -rwxr-xr-x | contrib/credential/netrc/t-git-credential-netrc.sh | 18 | ||||
| -rw-r--r-- | contrib/credential/osxkeychain/git-credential-osxkeychain.c | 5 | ||||
| -rw-r--r-- | contrib/credential/wincred/git-credential-wincred.c | 7 | ||||
| -rw-r--r-- | contrib/scalar/.gitignore | 2 | ||||
| -rw-r--r-- | contrib/scalar/Makefile | 35 | ||||
| -rw-r--r-- | contrib/scalar/README.md | 82 | ||||
| -rw-r--r-- | contrib/scalar/scalar.c | 1133 | ||||
| -rw-r--r-- | contrib/scalar/scalar.txt | 167 | ||||
| -rw-r--r-- | contrib/scalar/t/Makefile | 81 | ||||
| -rwxr-xr-x | contrib/scalar/t/t9099-scalar.sh | 123 | ||||
| -rwxr-xr-x | contrib/subtree/git-subtree.sh | 15 | ||||
| -rw-r--r-- | contrib/subtree/t/Makefile | 3 |
21 files changed, 285 insertions, 1692 deletions
diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt index b1306f9525..3957e4cf8c 100644 --- a/contrib/buildsystems/CMakeLists.txt +++ b/contrib/buildsystems/CMakeLists.txt @@ -77,7 +77,7 @@ if(USE_VCPKG) set(CMAKE_TOOLCHAIN_FILE ${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake CACHE STRING "Vcpkg toolchain file") endif() -find_program(SH_EXE sh PATHS "C:/Program Files/Git/bin") +find_program(SH_EXE sh PATHS "C:/Program Files/Git/bin" "$ENV{LOCALAPPDATA}/Programs/Git/bin") if(NOT SH_EXE) message(FATAL_ERROR "sh: shell interpreter was not found in your path, please install one." "On Windows, you can get it as part of 'Git for Windows' install at https://gitforwindows.org/") @@ -308,6 +308,8 @@ if(SUPPORTS_SIMPLE_IPC) add_compile_definitions(HAVE_FSMONITOR_DAEMON_BACKEND) list(APPEND compat_SOURCES compat/fsmonitor/fsm-listen-win32.c) list(APPEND compat_SOURCES compat/fsmonitor/fsm-health-win32.c) + list(APPEND compat_SOURCES compat/fsmonitor/fsm-ipc-win32.c) + list(APPEND compat_SOURCES compat/fsmonitor/fsm-path-utils-win32.c) add_compile_definitions(HAVE_FSMONITOR_OS_SETTINGS) list(APPEND compat_SOURCES compat/fsmonitor/fsm-settings-win32.c) @@ -315,6 +317,8 @@ if(SUPPORTS_SIMPLE_IPC) add_compile_definitions(HAVE_FSMONITOR_DAEMON_BACKEND) list(APPEND compat_SOURCES compat/fsmonitor/fsm-listen-darwin.c) list(APPEND compat_SOURCES compat/fsmonitor/fsm-health-darwin.c) + list(APPEND compat_SOURCES compat/fsmonitor/fsm-ipc-darwin.c) + list(APPEND compat_SOURCES compat/fsmonitor/fsm-path-utils-darwin.c) add_compile_definitions(HAVE_FSMONITOR_OS_SETTINGS) list(APPEND compat_SOURCES compat/fsmonitor/fsm-settings-darwin.c) @@ -610,7 +614,7 @@ unset(CMAKE_REQUIRED_INCLUDES) #programs set(PROGRAMS_BUILT git git-daemon git-http-backend git-sh-i18n--envsubst - git-shell) + git-shell scalar) if(NOT CURL_FOUND) list(APPEND excluded_progs git-http-fetch git-http-push) @@ -757,6 +761,9 @@ target_link_libraries(git-sh-i18n--envsubst common-main) add_executable(git-shell ${CMAKE_SOURCE_DIR}/shell.c) target_link_libraries(git-shell common-main) +add_executable(scalar ${CMAKE_SOURCE_DIR}/scalar.c) +target_link_libraries(scalar common-main) + if(CURL_FOUND) add_library(http_obj OBJECT ${CMAKE_SOURCE_DIR}/http.c) @@ -903,7 +910,7 @@ list(TRANSFORM git_perl_scripts PREPEND "${CMAKE_BINARY_DIR}/") #install foreach(program ${PROGRAMS_BUILT}) -if(program STREQUAL "git" OR program STREQUAL "git-shell") +if(program MATCHES "^(git|git-shell|scalar)$") install(TARGETS ${program} RUNTIME DESTINATION bin) else() @@ -977,7 +984,7 @@ endif() #wrapper scripts set(wrapper_scripts - git git-upload-pack git-receive-pack git-upload-archive git-shell git-remote-ext) + git git-upload-pack git-receive-pack git-upload-archive git-shell git-remote-ext scalar) set(wrapper_test_scripts test-fake-ssh test-tool) @@ -1071,7 +1078,7 @@ if(NOT ${CMAKE_BINARY_DIR}/CMakeCache.txt STREQUAL ${CACHE_PATH}) file(WRITE ${CMAKE_BINARY_DIR}/CTestCustom.cmake "file(WRITE ${CMAKE_SOURCE_DIR}/GIT-BUILD-DIR \"${CMAKE_BINARY_DIR}\")") #misc copies - file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.sed DESTINATION ${CMAKE_BINARY_DIR}/t/) + file(COPY ${CMAKE_SOURCE_DIR}/t/chainlint.pl DESTINATION ${CMAKE_BINARY_DIR}/t/) file(COPY ${CMAKE_SOURCE_DIR}/po/is.po DESTINATION ${CMAKE_BINARY_DIR}/po/) file(GLOB mergetools "${CMAKE_SOURCE_DIR}/mergetools/*") file(COPY ${mergetools} DESTINATION ${CMAKE_BINARY_DIR}/mergetools/) diff --git a/contrib/coccinelle/array.cocci b/contrib/coccinelle/array.cocci index 9a4f00cb1b..aa75937950 100644 --- a/contrib/coccinelle/array.cocci +++ b/contrib/coccinelle/array.cocci @@ -1,60 +1,58 @@ @@ -expression dst, src, n, E; +type T; +T *dst_ptr; +T *src_ptr; +expression n; @@ - memcpy(dst, src, n * sizeof( -- E[...] -+ *(E) - )) +- memcpy(dst_ptr, src_ptr, (n) * \( sizeof(T) +- \| sizeof(*(dst_ptr)) +- \| sizeof(*(src_ptr)) +- \| sizeof(dst_ptr[...]) +- \| sizeof(src_ptr[...]) +- \) ) ++ COPY_ARRAY(dst_ptr, src_ptr, n) @@ type T; -T *ptr; -T[] arr; -expression E, n; +T *dst_ptr; +T[] src_arr; +expression n; @@ -( - memcpy(ptr, E, -- n * sizeof(*(ptr)) -+ n * sizeof(T) - ) -| - memcpy(arr, E, -- n * sizeof(*(arr)) -+ n * sizeof(T) - ) -| - memcpy(E, ptr, -- n * sizeof(*(ptr)) -+ n * sizeof(T) - ) -| - memcpy(E, arr, -- n * sizeof(*(arr)) -+ n * sizeof(T) - ) -) +- memcpy(dst_ptr, src_arr, (n) * \( sizeof(T) +- \| sizeof(*(dst_ptr)) +- \| sizeof(*(src_arr)) +- \| sizeof(dst_ptr[...]) +- \| sizeof(src_arr[...]) +- \) ) ++ COPY_ARRAY(dst_ptr, src_arr, n) @@ type T; -T *dst_ptr; +T[] dst_arr; T *src_ptr; +expression n; +@@ +- memcpy(dst_arr, src_ptr, (n) * \( sizeof(T) +- \| sizeof(*(dst_arr)) +- \| sizeof(*(src_ptr)) +- \| sizeof(dst_arr[...]) +- \| sizeof(src_ptr[...]) +- \) ) ++ COPY_ARRAY(dst_arr, src_ptr, n) + +@@ +type T; T[] dst_arr; T[] src_arr; expression n; @@ -( -- memcpy(dst_ptr, src_ptr, (n) * sizeof(T)) -+ COPY_ARRAY(dst_ptr, src_ptr, n) -| -- memcpy(dst_ptr, src_arr, (n) * sizeof(T)) -+ COPY_ARRAY(dst_ptr, src_arr, n) -| -- memcpy(dst_arr, src_ptr, (n) * sizeof(T)) -+ COPY_ARRAY(dst_arr, src_ptr, n) -| -- memcpy(dst_arr, src_arr, (n) * sizeof(T)) +- memcpy(dst_arr, src_arr, (n) * \( sizeof(T) +- \| sizeof(*(dst_arr)) +- \| sizeof(*(src_arr)) +- \| sizeof(dst_arr[...]) +- \| sizeof(src_arr[...]) +- \) ) + COPY_ARRAY(dst_arr, src_arr, n) -) @@ type T; diff --git a/contrib/coccinelle/tests/free.c b/contrib/coccinelle/tests/free.c new file mode 100644 index 0000000000..96d4abc0c7 --- /dev/null +++ b/contrib/coccinelle/tests/free.c @@ -0,0 +1,11 @@ +int use_FREE_AND_NULL(int *v) +{ + free(*v); + *v = NULL; +} + +int need_no_if(int *v) +{ + if (v) + free(v); +} diff --git a/contrib/coccinelle/tests/free.res b/contrib/coccinelle/tests/free.res new file mode 100644 index 0000000000..f90fd9f48e --- /dev/null +++ b/contrib/coccinelle/tests/free.res @@ -0,0 +1,9 @@ +int use_FREE_AND_NULL(int *v) +{ + FREE_AND_NULL(*v); +} + +int need_no_if(int *v) +{ + free(v); +} diff --git a/contrib/coccinelle/tests/unused.c b/contrib/coccinelle/tests/unused.c new file mode 100644 index 0000000000..8294d734ba --- /dev/null +++ b/contrib/coccinelle/tests/unused.c @@ -0,0 +1,82 @@ +void test_strbuf(void) +{ + struct strbuf sb1 = STRBUF_INIT; + struct strbuf sb2 = STRBUF_INIT; + struct strbuf sb3 = STRBUF_INIT; + struct strbuf sb4 = STRBUF_INIT; + struct strbuf sb5; + struct strbuf sb6 = { 0 }; + struct strbuf sb7 = STRBUF_INIT; + struct strbuf sb8 = STRBUF_INIT; + struct strbuf *sp1; + struct strbuf *sp2; + struct strbuf *sp3; + struct strbuf *sp4 = xmalloc(sizeof(struct strbuf)); + struct strbuf *sp5 = xmalloc(sizeof(struct strbuf)); + struct strbuf *sp6 = xmalloc(sizeof(struct strbuf)); + struct strbuf *sp7; + + strbuf_init(&sb5, 0); + strbuf_init(sp1, 0); + strbuf_init(sp2, 0); + strbuf_init(sp3, 0); + strbuf_init(sp4, 0); + strbuf_init(sp5, 0); + strbuf_init(sp6, 0); + strbuf_init(sp7, 0); + sp7 = xmalloc(sizeof(struct strbuf)); + + use_before(&sb3); + use_as_str("%s", sb7.buf); + use_as_str("%s", sp1->buf); + use_as_str("%s", sp6->buf); + pass_pp(&sp3); + + strbuf_release(&sb1); + strbuf_reset(&sb2); + strbuf_release(&sb3); + strbuf_release(&sb4); + strbuf_release(&sb5); + strbuf_release(&sb6); + strbuf_release(&sb7); + strbuf_release(sp1); + strbuf_release(sp2); + strbuf_release(sp3); + strbuf_release(sp4); + strbuf_release(sp5); + strbuf_release(sp6); + strbuf_release(sp7); + + use_after(&sb4); + + if (when_strict()) + return; + strbuf_release(&sb8); +} + +void test_other(void) +{ + struct string_list l = STRING_LIST_INIT_DUP; + struct strbuf sb = STRBUF_INIT; + + string_list_clear(&l, 0); + string_list_clear(&sb, 0); +} + +void test_worktrees(void) +{ + struct worktree **w1 = get_worktrees(); + struct worktree **w2 = get_worktrees(); + struct worktree **w3; + struct worktree **w4; + + w3 = get_worktrees(); + w4 = get_worktrees(); + + use_it(w4); + + free_worktrees(w1); + free_worktrees(w2); + free_worktrees(w3); + free_worktrees(w4); +} diff --git a/contrib/coccinelle/tests/unused.res b/contrib/coccinelle/tests/unused.res new file mode 100644 index 0000000000..6d3e745683 --- /dev/null +++ b/contrib/coccinelle/tests/unused.res @@ -0,0 +1,45 @@ +void test_strbuf(void) +{ + struct strbuf sb3 = STRBUF_INIT; + struct strbuf sb4 = STRBUF_INIT; + struct strbuf sb7 = STRBUF_INIT; + struct strbuf *sp1; + struct strbuf *sp3; + struct strbuf *sp6 = xmalloc(sizeof(struct strbuf)); + strbuf_init(sp1, 0); + strbuf_init(sp3, 0); + strbuf_init(sp6, 0); + + use_before(&sb3); + use_as_str("%s", sb7.buf); + use_as_str("%s", sp1->buf); + use_as_str("%s", sp6->buf); + pass_pp(&sp3); + + strbuf_release(&sb3); + strbuf_release(&sb4); + strbuf_release(&sb7); + strbuf_release(sp1); + strbuf_release(sp3); + strbuf_release(sp6); + + use_after(&sb4); + + if (when_strict()) + return; +} + +void test_other(void) +{ +} + +void test_worktrees(void) +{ + struct worktree **w4; + + w4 = get_worktrees(); + + use_it(w4); + + free_worktrees(w4); +} diff --git a/contrib/coccinelle/unused.cocci b/contrib/coccinelle/unused.cocci new file mode 100644 index 0000000000..d84046f82e --- /dev/null +++ b/contrib/coccinelle/unused.cocci @@ -0,0 +1,43 @@ +// This rule finds sequences of "unused" declerations and uses of a +// variable, where "unused" is defined to include only calling the +// equivalent of alloc, init & free functions on the variable. +@@ +type T; +identifier I; +// STRBUF_INIT, but also e.g. STRING_LIST_INIT_DUP (so no anchoring) +constant INIT_MACRO =~ "_INIT"; +identifier MALLOC1 =~ "^x?[mc]alloc$"; +identifier INIT_ASSIGN1 =~ "^get_worktrees$"; +identifier INIT_CALL1 =~ "^[a-z_]*_init$"; +identifier REL1 =~ "^[a-z_]*_(release|reset|clear|free)$"; +identifier REL2 =~ "^(release|clear|free)_[a-z_]*$"; +@@ + +( +- T I; +| +- T I = { 0 }; +| +- T I = INIT_MACRO; +| +- T I = MALLOC1(...); +| +- T I = INIT_ASSIGN1(...); +) + +<... when != \( I \| &I \) +( +- \( INIT_CALL1 \)( \( I \| &I \), ...); +| +- I = \( INIT_ASSIGN1 \)(...); +| +- I = MALLOC1(...); +) +...> + +( +- \( REL1 \| REL2 \)( \( I \| &I \), ...); +| +- \( REL1 \| REL2 \)( \( &I \| I \) ); +) + ... when != \( I \| &I \) diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh index 1435548e00..57972c2845 100644 --- a/contrib/completion/git-prompt.sh +++ b/contrib/completion/git-prompt.sh @@ -84,6 +84,10 @@ # single '?' character by setting GIT_PS1_COMPRESSSPARSESTATE, or omitted # by setting GIT_PS1_OMITSPARSESTATE. # +# If you would like to see a notification on the prompt when there are +# unresolved conflicts, set GIT_PS1_SHOWCONFLICTSTATE to "yes". The +# prompt will include "|CONFLICT". +# # If you would like to see more information about the identity of # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE # to one of these values: @@ -508,6 +512,12 @@ __git_ps1 () r="$r $step/$total" fi + local conflict="" # state indicator for unresolved conflicts + if [[ "${GIT_PS1_SHOWCONFLICTSTATE}" == "yes" ]] && + [[ $(git ls-files --unmerged 2>/dev/null) ]]; then + conflict="|CONFLICT" + fi + local w="" local i="" local s="" @@ -572,7 +582,7 @@ __git_ps1 () fi local f="$h$w$i$s$u$p" - local gitstring="$c$b${f:+$z$f}${sparse}$r${upstream}" + local gitstring="$c$b${f:+$z$f}${sparse}$r${upstream}${conflict}" if [ $pcmode = yes ]; then if [ "${__git_printf_supports_v-}" != yes ]; then diff --git a/contrib/credential/netrc/git-credential-netrc.perl b/contrib/credential/netrc/git-credential-netrc.perl index bc57cc6588..9fb998ae09 100755 --- a/contrib/credential/netrc/git-credential-netrc.perl +++ b/contrib/credential/netrc/git-credential-netrc.perl @@ -356,7 +356,10 @@ sub read_credential_data_from_stdin { next unless m/^([^=]+)=(.+)/; my ($token, $value) = ($1, $2); - die "Unknown search token $token" unless exists $q{$token}; + + # skip any unknown tokens + next unless exists $q{$token}; + $q{$token} = $value; log_debug("We were given search token $token and value $value"); } diff --git a/contrib/credential/netrc/t-git-credential-netrc.sh b/contrib/credential/netrc/t-git-credential-netrc.sh index 07227d0228..bf2777308a 100755 --- a/contrib/credential/netrc/t-git-credential-netrc.sh +++ b/contrib/credential/netrc/t-git-credential-netrc.sh @@ -3,16 +3,9 @@ cd ../../../t test_description='git-credential-netrc' . ./test-lib.sh + . "$TEST_DIRECTORY"/lib-perl.sh - if ! test_have_prereq PERL; then - skip_all='skipping perl interface tests, perl not available' - test_done - fi - - perl -MTest::More -e 0 2>/dev/null || { - skip_all="Perl Test::More unavailable, skipping test" - test_done - } + skip_all_if_no_Test_More # set up test repository @@ -20,13 +13,10 @@ 'set up test repository' \ 'git config --add gpg.program test.git-config-gpg' - # The external test will outputs its own plan - test_external_has_tap=1 - export PERL5LIB="$GITPERLLIB" - test_external \ - 'git-credential-netrc' \ + test_expect_success 'git-credential-netrc' ' perl "$GIT_BUILD_DIR"/contrib/credential/netrc/test.pl + ' test_done ) diff --git a/contrib/credential/osxkeychain/git-credential-osxkeychain.c b/contrib/credential/osxkeychain/git-credential-osxkeychain.c index bf77748d60..e29cc28779 100644 --- a/contrib/credential/osxkeychain/git-credential-osxkeychain.c +++ b/contrib/credential/osxkeychain/git-credential-osxkeychain.c @@ -159,6 +159,11 @@ static void read_credential(void) username = xstrdup(v); else if (!strcmp(buf, "password")) password = xstrdup(v); + /* + * Ignore other lines; we don't know what they mean, but + * this future-proofs us when later versions of git do + * learn new lines, and the helpers are updated to match. + */ } } diff --git a/contrib/credential/wincred/git-credential-wincred.c b/contrib/credential/wincred/git-credential-wincred.c index 5091048f9c..ead6e267c7 100644 --- a/contrib/credential/wincred/git-credential-wincred.c +++ b/contrib/credential/wincred/git-credential-wincred.c @@ -278,8 +278,11 @@ static void read_credential(void) wusername = utf8_to_utf16_dup(v); } else if (!strcmp(buf, "password")) password = utf8_to_utf16_dup(v); - else - die("unrecognized input"); + /* + * Ignore other lines; we don't know what they mean, but + * this future-proofs us when later versions of git do + * learn new lines, and the helpers are updated to match. + */ } } diff --git a/contrib/scalar/.gitignore b/contrib/scalar/.gitignore deleted file mode 100644 index ff3d47e84d..0000000000 --- a/contrib/scalar/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -/*.exe -/scalar diff --git a/contrib/scalar/Makefile b/contrib/scalar/Makefile deleted file mode 100644 index 37f283f35d..0000000000 --- a/contrib/scalar/Makefile +++ /dev/null @@ -1,35 +0,0 @@ -# The default target of this Makefile is... -all:: - -# Import tree-wide shared Makefile behavior and libraries -include ../../shared.mak - -include ../../config.mak.uname --include ../../config.mak.autogen --include ../../config.mak - -TARGETS = scalar$(X) scalar.o -GITLIBS = ../../common-main.o ../../libgit.a ../../xdiff/lib.a - -all:: scalar$(X) ../../bin-wrappers/scalar - -$(GITLIBS): - $(QUIET_SUBDIR0)../.. $(QUIET_SUBDIR1) $(subst ../../,,$@) - -$(TARGETS): $(GITLIBS) scalar.c - $(QUIET_SUBDIR0)../.. $(QUIET_SUBDIR1) $(patsubst %,contrib/scalar/%,$@) - -clean: - $(RM) $(TARGETS) ../../bin-wrappers/scalar - -../../bin-wrappers/scalar: ../../wrap-for-bin.sh Makefile - @mkdir -p ../../bin-wrappers - $(QUIET_GEN)sed -e '1s|#!.*/sh|#!$(SHELL_PATH_SQ)|' \ - -e 's|@@BUILD_DIR@@|$(shell cd ../.. && pwd)|' \ - -e 's|@@PROG@@|contrib/scalar/scalar$(X)|' < $< > $@ && \ - chmod +x $@ - -test: all - $(MAKE) -C t - -.PHONY: $(GITLIBS) all clean test FORCE diff --git a/contrib/scalar/README.md b/contrib/scalar/README.md deleted file mode 100644 index 634b5771ed..0000000000 --- a/contrib/scalar/README.md +++ /dev/null @@ -1,82 +0,0 @@ -# Scalar - an opinionated repository management tool - -Scalar is an add-on to Git that helps users take advantage of advanced -performance features in Git. Originally implemented in C# using .NET Core, -based on the learnings from the VFS for Git project, most of the techniques -developed by the Scalar project have been integrated into core Git already: - -* partial clone, -* commit graphs, -* multi-pack index, -* sparse checkout (cone mode), -* scheduled background maintenance, -* etc - -This directory contains the remaining parts of Scalar that are not (yet) in -core Git. - -## Roadmap - -The idea is to populate this directory via incremental patch series and -eventually move to a top-level directory next to `gitk-git/` and to `git-gui/`. The -current plan involves the following patch series: - -- `scalar-the-beginning`: The initial patch series which sets up - `contrib/scalar/` and populates it with a minimal `scalar` command that - demonstrates the fundamental ideas. - -- `scalar-c-and-C`: The `scalar` command learns about two options that can be - specified before the command, `-c <key>=<value>` and `-C <directory>`. - -- `scalar-diagnose`: The `scalar` command is taught the `diagnose` subcommand. - -- `scalar-and-builtin-fsmonitor`: The built-in FSMonitor is enabled in `scalar - register` and in `scalar clone`, for an enormous performance boost when - working in large worktrees. This patch series necessarily depends on Jeff - Hostetler's FSMonitor patch series to be integrated into Git. - -- `scalar-gentler-config-locking`: Scalar enlistments are registered in the - user's Git config. This usually does not represent any problem because it is - rare for a user to register an enlistment. However, in Scalar's functional - tests, Scalar enlistments are created galore, and in parallel, which can lead - to lock contention. This patch series works around that problem by re-trying - to lock the config file in a gentle fashion. - -- `scalar-extra-docs`: Add some extensive documentation that has been written - in the original Scalar project (all subject to discussion, of course). - -- `optionally-install-scalar`: Now that Scalar is feature (and documentation) - complete and is verified in CI builds, let's offer to install it. - -- `move-scalar-to-toplevel`: Now that Scalar is complete, let's move it next to - `gitk-git/` and to `git-gui/`, making it a top-level command. - -The following two patch series exist in Microsoft's fork of Git and are -publicly available. There is no current plan to upstream them, not because I -want to withhold these patches, but because I don't think the Git community is -interested in these patches. - -There are some interesting ideas there, but the implementation is too specific -to Azure Repos and/or VFS for Git to be of much help in general (and also: my -colleagues tried to upstream some patches already and the enthusiasm for -integrating things related to Azure Repos and VFS for Git can be summarized in -very, very few words). - -These still exist mainly because the GVFS protocol is what Azure Repos has -instead of partial clone, while Git is focused on improving partial clone: - -- `scalar-with-gvfs`: The primary purpose of this patch series is to support - existing Scalar users whose repositories are hosted in Azure Repos (which - does not support Git's partial clones, but supports its predecessor, the GVFS - protocol, which is used by Scalar to emulate the partial clone). - - Since the GVFS protocol will never be supported by core Git, this patch - series will remain in Microsoft's fork of Git. - -- `run-scalar-functional-tests`: The Scalar project developed a quite - comprehensive set of integration tests (or, "Functional Tests"). They are the - sole remaining part of the original C#-based Scalar project, and this patch - adds a GitHub workflow that runs them all. - - Since the tests partially depend on features that are only provided in the - `scalar-with-gvfs` patch series, this patch cannot be upstreamed. diff --git a/contrib/scalar/scalar.c b/contrib/scalar/scalar.c deleted file mode 100644 index 28176914e5..0000000000 --- a/contrib/scalar/scalar.c +++ /dev/null @@ -1,1133 +0,0 @@ -/* - * The Scalar command-line interface. - */ - -#include "cache.h" -#include "gettext.h" -#include "parse-options.h" -#include "config.h" -#include "run-command.h" -#include "refs.h" -#include "dir.h" -#include "packfile.h" -#include "help.h" -#include "archive.h" -#include "object-store.h" - -/* - * Remove the deepest subdirectory in the provided path string. Path must not - * include a trailing path separator. Returns 1 if parent directory found, - * otherwise 0. - */ -static int strbuf_parent_directory(struct strbuf *buf) -{ - size_t len = buf->len; - size_t offset = offset_1st_component(buf->buf); - char *path_sep = find_last_dir_sep(buf->buf + offset); - strbuf_setlen(buf, path_sep ? path_sep - buf->buf : offset); - - return buf->len < len; -} - -static void setup_enlistment_directory(int argc, const char **argv, - const char * const *usagestr, - const struct option *options, - struct strbuf *enlistment_root) -{ - struct strbuf path = STRBUF_INIT; - char *root; - int enlistment_found = 0; - - if (startup_info->have_repository) - BUG("gitdir already set up?!?"); - - if (argc > 1) - usage_with_options(usagestr, options); - - /* find the worktree, determine its corresponding root */ - if (argc == 1) { - strbuf_add_absolute_path(&path, argv[0]); - if (!is_directory(path.buf)) - die(_("'%s' does not exist"), path.buf); - } else if (strbuf_getcwd(&path) < 0) - die(_("need a working directory")); - - strbuf_trim_trailing_dir_sep(&path); - do { - const size_t len = path.len; - - /* check if currently in enlistment root with src/ workdir */ - strbuf_addstr(&path, "/src"); - if (is_nonbare_repository_dir(&path)) { - if (enlistment_root) - strbuf_add(enlistment_root, path.buf, len); - - enlistment_found = 1; - break; - } - - /* reset to original path */ - strbuf_setlen(&path, len); - - /* check if currently in workdir */ - if (is_nonbare_repository_dir(&path)) { - if (enlistment_root) { - /* - * If the worktree's directory's name is `src`, the enlistment is the - * parent directory, otherwise it is identical to the worktree. - */ - root = strip_path_suffix(path.buf, "src"); - strbuf_addstr(enlistment_root, root ? root : path.buf); - free(root); - } - - enlistment_found = 1; - break; - } - } while (strbuf_parent_directory(&path)); - - if (!enlistment_found) - die(_("could not find enlistment root")); - - if (chdir(path.buf) < 0) - die_errno(_("could not switch to '%s'"), path.buf); - - strbuf_release(&path); - setup_git_directory(); -} - -static int run_git(const char *arg, ...) -{ - struct strvec argv = STRVEC_INIT; - va_list args; - const char *p; - int res; - - va_start(args, arg); - strvec_push(&argv, arg); - while ((p = va_arg(args, const char *))) - strvec_push(&argv, p); - va_end(args); - - res = run_command_v_opt(argv.v, RUN_GIT_CMD); - - strvec_clear(&argv); - return res; -} - -static int set_recommended_config(int reconfigure) -{ - struct { - const char *key; - const char *value; - int overwrite_on_reconfigure; - } config[] = { - /* Required */ - { "am.keepCR", "true", 1 }, - { "core.FSCache", "true", 1 }, - { "core.multiPackIndex", "true", 1 }, - { "core.preloadIndex", "true", 1 }, -#ifndef WIN32 - { "core.untrackedCache", "true", 1 }, -#else - /* - * Unfortunately, Scalar's Functional Tests demonstrated - * that the untracked cache feature is unreliable on Windows - * (which is a bummer because that platform would benefit the - * most from it). For some reason, freshly created files seem - * not to update the directory's `lastModified` time - * immediately, but the untracked cache would need to rely on - * that. - * - * Therefore, with a sad heart, we disable this very useful - * feature on Windows. - */ - { "core.untrackedCache", "false", 1 }, -#endif - { "core.logAllRefUpdates", "true", 1 }, - { "credential.https://dev.azure.com.useHttpPath", "true", 1 }, - { "credential.validate", "false", 1 }, /* GCM4W-only */ - { "gc.auto", "0", 1 }, - { "gui.GCWarning", "false", 1 }, - { "index.threads", "true", 1 }, - { "index.version", "4", 1 }, - { "merge.stat", "false", 1 }, - { "merge.renames", "true", 1 }, - { "pack.useBitmaps", "false", 1 }, - { "pack.useSparse", "true", 1 }, - { "receive.autoGC", "false", 1 }, - { "feature.manyFiles", "false", 1 }, - { "feature.experimental", "false", 1 }, - { "fetch.unpackLimit", "1", 1 }, - { "fetch.writeCommitGraph", "false", 1 }, -#ifdef WIN32 - { "http.sslBackend", "schannel", 1 }, -#endif - /* Optional */ - { "status.aheadBehind", "false" }, - { "commitGraph.generationVersion", "1" }, - { "core.autoCRLF", "false" }, - { "core.safeCRLF", "false" }, - { "fetch.showForcedUpdates", "false" }, - { NULL, NULL }, - }; - int i; - char *value; - - for (i = 0; config[i].key; i++) { - if ((reconfigure && config[i].overwrite_on_reconfigure) || - git_config_get_string(config[i].key, &value)) { - trace2_data_string("scalar", the_repository, config[i].key, "created"); - if (git_config_set_gently(config[i].key, - config[i].value) < 0) - return error(_("could not configure %s=%s"), - config[i].key, config[i].value); - } else { - trace2_data_string("scalar", the_repository, config[i].key, "exists"); - free(value); - } - } - - /* - * The `log.excludeDecoration` setting is special because it allows - * for multiple values. - */ - if (git_config_get_string("log.excludeDecoration", &value)) { - trace2_data_string("scalar", the_repository, - "log.excludeDecoration", "created"); - if (git_config_set_multivar_gently("log.excludeDecoration", - "refs/prefetch/*", - CONFIG_REGEX_NONE, 0)) - return error(_("could not configure " - "log.excludeDecoration")); - } else { - trace2_data_string("scalar", the_repository, - "log.excludeDecoration", "exists"); - free(value); - } - - return 0; -} - -static int toggle_maintenance(int enable) -{ - return run_git("maintenance", enable ? "start" : "unregister", NULL); -} - -static int add_or_remove_enlistment(int add) -{ - int res; - - if (!the_repository->worktree) - die(_("Scalar enlistments require a worktree")); - - res = run_git("config", "--global", "--get", "--fixed-value", - "scalar.repo", the_repository->worktree, NULL); - - /* - * If we want to add and the setting is already there, then do nothing. - * If we want to remove and the setting is not there, then do nothing. - */ - if ((add && !res) || (!add && res)) - return 0; - - return run_git("config", "--global", add ? "--add" : "--unset", - add ? "--no-fixed-value" : "--fixed-value", - "scalar.repo", the_repository->worktree, NULL); -} - -static int register_dir(void) -{ - int res = add_or_remove_enlistment(1); - - if (!res) - res = set_recommended_config(0); - - if (!res) - res = toggle_maintenance(1); - - return res; -} - -static int unregister_dir(void) -{ - int res = 0; - - if (toggle_maintenance(0) < 0) - res = -1; - - if (add_or_remove_enlistment(0) < 0) - res = -1; - - return res; -} - -static int add_directory_to_archiver(struct strvec *archiver_args, - const char *path, int recurse) -{ - int at_root = !*path; - DIR *dir = opendir(at_root ? "." : path); - struct dirent *e; - struct strbuf buf = STRBUF_INIT; - size_t len; - int res = 0; - - if (!dir) - return error_errno(_("could not open directory '%s'"), path); - - if (!at_root) - strbuf_addf(&buf, "%s/", path); - len = buf.len; - strvec_pushf(archiver_args, "--prefix=%s", buf.buf); - - while (!res && (e = readdir(dir))) { - if (!strcmp(".", e->d_name) || !strcmp("..", e->d_name)) - continue; - - strbuf_setlen(&buf, len); - strbuf_addstr(&buf, e->d_name); - - if (e->d_type == DT_REG) - strvec_pushf(archiver_args, "--add-file=%s", buf.buf); - else if (e->d_type != DT_DIR) - warning(_("skipping '%s', which is neither file nor " - "directory"), buf.buf); - else if (recurse && - add_directory_to_archiver(archiver_args, - buf.buf, recurse) < 0) - res = -1; - } - - closedir(dir); - strbuf_release(&buf); - return res; -} - -#ifndef WIN32 -#include <sys/statvfs.h> -#endif - -static int get_disk_info(struct strbuf *out) -{ -#ifdef WIN32 - struct strbuf buf = STRBUF_INIT; - char volume_name[MAX_PATH], fs_name[MAX_PATH]; - DWORD serial_number, component_length, flags; - ULARGE_INTEGER avail2caller, total, avail; - - strbuf_realpath(&buf, ".", 1); - if (!GetDiskFreeSpaceExA(buf.buf, &avail2caller, &total, &avail)) { - error(_("could not determine free disk size for '%s'"), - buf.buf); - strbuf_release(&buf); - return -1; - } - - strbuf_setlen(&buf, offset_1st_component(buf.buf)); - if (!GetVolumeInformationA(buf.buf, volume_name, sizeof(volume_name), - &serial_number, &component_length, &flags, - fs_name, sizeof(fs_name))) { - error(_("could not get info for '%s'"), buf.buf); - strbuf_release(&buf); - return -1; - } - strbuf_addf(out, "Available space on '%s': ", buf.buf); - strbuf_humanise_bytes(out, avail2caller.QuadPart); - strbuf_addch(out, '\n'); - strbuf_release(&buf); -#else - struct strbuf buf = STRBUF_INIT; - struct statvfs stat; - - strbuf_realpath(&buf, ".", 1); - if (statvfs(buf.buf, &stat) < 0) { - error_errno(_("could not determine free disk size for '%s'"), - buf.buf); - strbuf_release(&buf); - return -1; - } - - strbuf_addf(out, "Available space on '%s': ", buf.buf); - strbuf_humanise_bytes(out, st_mult(stat.f_bsize, stat.f_bavail)); - strbuf_addf(out, " (mount flags 0x%lx)\n", stat.f_flag); - strbuf_release(&buf); -#endif - return 0; -} - -/* printf-style interface, expects `<key>=<value>` argument */ -static int set_config(const char *fmt, ...) -{ - struct strbuf buf = STRBUF_INIT; - char *value; - int res; - va_list args; - - va_start(args, fmt); - strbuf_vaddf(&buf, fmt, args); - va_end(args); - - value = strchr(buf.buf, '='); - if (value) - *(value++) = '\0'; - res = git_config_set_gently(buf.buf, value); - strbuf_release(&buf); - - return res; -} - -static char *remote_default_branch(const char *url) -{ - struct child_process cp = CHILD_PROCESS_INIT; - struct strbuf out = STRBUF_INIT; - - cp.git_cmd = 1; - strvec_pushl(&cp.args, "ls-remote", "--symref", url, "HEAD", NULL); - if (!pipe_command(&cp, NULL, 0, &out, 0, NULL, 0)) { - const char *line = out.buf; - - while (*line) { - const char *eol = strchrnul(line, '\n'), *p; - size_t len = eol - line; - char *branch; - - if (!skip_prefix(line, "ref: ", &p) || - !strip_suffix_mem(line, &len, "\tHEAD")) { - line = eol + (*eol == '\n'); - continue; - } - - eol = line + len; - if (skip_prefix(p, "refs/heads/", &p)) { - branch = xstrndup(p, eol - p); - strbuf_release(&out); - return branch; - } - - error(_("remote HEAD is not a branch: '%.*s'"), - (int)(eol - p), p); - strbuf_release(&out); - return NULL; - } - } - warning(_("failed to get default branch name from remote; " - "using local default")); - strbuf_reset(&out); - - child_process_init(&cp); - cp.git_cmd = 1; - strvec_pushl(&cp.args, "symbolic-ref", "--short", "HEAD", NULL); - if (!pipe_command(&cp, NULL, 0, &out, 0, NULL, 0)) { - strbuf_trim(&out); - return strbuf_detach(&out, NULL); - } - - strbuf_release(&out); - error(_("failed to get default branch name")); - return NULL; -} - -static int delete_enlistment(struct strbuf *enlistment) -{ -#ifdef WIN32 - struct strbuf parent = STRBUF_INIT; -#endif - - if (unregister_dir()) - die(_("failed to unregister repository")); - -#ifdef WIN32 - /* - * Change the current directory to one outside of the enlistment so - * that we may delete everything underneath it. - */ - strbuf_addbuf(&parent, enlistment); - strbuf_parent_directory(&parent); - if (chdir(parent.buf) < 0) - die_errno(_("could not switch to '%s'"), parent.buf); - strbuf_release(&parent); -#endif - - if (remove_dir_recursively(enlistment, 0)) - die(_("failed to delete enlistment directory")); - - return 0; -} - -/* - * Dummy implementation; Using `get_version_info()` would cause a link error - * without this. - */ -void load_builtin_commands(const char *prefix, struct cmdnames *cmds) -{ - die("not implemented"); -} - -static int cmd_clone(int argc, const char **argv) -{ - const char *branch = NULL; - int full_clone = 0, single_branch = 0; - struct option clone_options[] = { - OPT_STRING('b', "branch", &branch, N_("<branch>"), - N_("branch to checkout after clone")), - OPT_BOOL(0, "full-clone", &full_clone, - N_("when cloning, create full working directory")), - OPT_BOOL(0, "single-branch", &single_branch, - N_("only download metadata for the branch that will " - "be checked out")), - OPT_END(), - }; - const char * const clone_usage[] = { - N_("scalar clone [<options>] [--] <repo> [<dir>]"), - NULL - }; - const char *url; - char *enlistment = NULL, *dir = NULL; - struct strbuf buf = STRBUF_INIT; - int res; - - argc = parse_options(argc, argv, NULL, clone_options, clone_usage, 0); - - if (argc == 2) { - url = argv[0]; - enlistment = xstrdup(argv[1]); - } else if (argc == 1) { - url = argv[0]; - - strbuf_addstr(&buf, url); - /* Strip trailing slashes, if any */ - while (buf.len > 0 && is_dir_sep(buf.buf[buf.len - 1])) - strbuf_setlen(&buf, buf.len - 1); - /* Strip suffix `.git`, if any */ - strbuf_strip_suffix(&buf, ".git"); - - enlistment = find_last_dir_sep(buf.buf); - if (!enlistment) { - die(_("cannot deduce worktree name from '%s'"), url); - } - enlistment = xstrdup(enlistment + 1); - } else { - usage_msg_opt(_("You must specify a repository to clone."), - clone_usage, clone_options); - } - - if (is_directory(enlistment)) - die(_("directory '%s' exists already"), enlistment); - - dir = xstrfmt("%s/src", enlistment); - - strbuf_reset(&buf); - if (branch) - strbuf_addf(&buf, "init.defaultBranch=%s", branch); - else { - char *b = repo_default_branch_name(the_repository, 1); - strbuf_addf(&buf, "init.defaultBranch=%s", b); - free(b); - } - - if ((res = run_git("-c", buf.buf, "init", "--", dir, NULL))) - goto cleanup; - - if (chdir(dir) < 0) { - res = error_errno(_("could not switch to '%s'"), dir); - goto cleanup; - } - - setup_git_directory(); - - /* common-main already logs `argv` */ - trace2_def_repo(the_repository); - - if (!branch && !(branch = remote_default_branch(url))) { - res = error(_("failed to get default branch for '%s'"), url); - goto cleanup; - } - - if (set_config("remote.origin.url=%s", url) || - set_config("remote.origin.fetch=" - "+refs/heads/%s:refs/remotes/origin/%s", - single_branch ? branch : "*", - single_branch ? branch : "*") || - set_config("remote.origin.promisor=true") || - set_config("remote.origin.partialCloneFilter=blob:none")) { - res = error(_("could not configure remote in '%s'"), dir); - goto cleanup; - } - - if (!full_clone && - (res = run_git("sparse-checkout", "init", "--cone", NULL))) - goto cleanup; - - if (set_recommended_config(0)) - return error(_("could not configure '%s'"), dir); - - if ((res = run_git("fetch", "--quiet", "origin", NULL))) { - warning(_("partial clone failed; attempting full clone")); - - if (set_config("remote.origin.promisor") || - set_config("remote.origin.partialCloneFilter")) { - res = error(_("could not configure for full clone")); - goto cleanup; - } - - if ((res = run_git("fetch", "--quiet", "origin", NULL))) - goto cleanup; - } - - if ((res = set_config("branch.%s.remote=origin", branch))) - goto cleanup; - if ((res = set_config("branch.%s.merge=refs/heads/%s", - branch, branch))) - goto cleanup; - - strbuf_reset(&buf); - strbuf_addf(&buf, "origin/%s", branch); - res = run_git("checkout", "-f", "-t", buf.buf, NULL); - if (res) - goto cleanup; - - res = register_dir(); - -cleanup: - free(enlistment); - free(dir); - strbuf_release(&buf); - return res; -} - -static void dir_file_stats_objects(const char *full_path, size_t full_path_len, - const char *file_name, void *data) -{ - struct strbuf *buf = data; - struct stat st; - - if (!stat(full_path, &st)) - strbuf_addf(buf, "%-70s %16" PRIuMAX "\n", file_name, - (uintmax_t)st.st_size); -} - -static int dir_file_stats(struct object_directory *object_dir, void *data) -{ - struct strbuf *buf = data; - - strbuf_addf(buf, "Contents of %s:\n", object_dir->path); - - for_each_file_in_pack_dir(object_dir->path, dir_file_stats_objects, - data); - - return 0; -} - -static int count_files(char *path) -{ - DIR *dir = opendir(path); - struct dirent *e; - int count = 0; - - if (!dir) - return 0; - - while ((e = readdir(dir)) != NULL) - if (!is_dot_or_dotdot(e->d_name) && e->d_type == DT_REG) - count++; - - closedir(dir); - return count; -} - -static void loose_objs_stats(struct strbuf *buf, const char *path) -{ - DIR *dir = opendir(path); - struct dirent *e; - int count; - int total = 0; - unsigned char c; - struct strbuf count_path = STRBUF_INIT; - size_t base_path_len; - - if (!dir) - return; - - strbuf_addstr(buf, "Object directory stats for "); - strbuf_add_absolute_path(buf, path); - strbuf_addstr(buf, ":\n"); - - strbuf_add_absolute_path(&count_path, path); - strbuf_addch(&count_path, '/'); - base_path_len = count_path.len; - - while ((e = readdir(dir)) != NULL) - if (!is_dot_or_dotdot(e->d_name) && - e->d_type == DT_DIR && strlen(e->d_name) == 2 && - !hex_to_bytes(&c, e->d_name, 1)) { - strbuf_setlen(&count_path, base_path_len); - strbuf_addstr(&count_path, e->d_name); - total += (count = count_files(count_path.buf)); - strbuf_addf(buf, "%s : %7d files\n", e->d_name, count); - } - - strbuf_addf(buf, "Total: %d loose objects", total); - - strbuf_release(&count_path); - closedir(dir); -} - -static int cmd_diagnose(int argc, const char **argv) -{ - struct option options[] = { - OPT_END(), - }; - const char * const usage[] = { - N_("scalar diagnose [<enlistment>]"), - NULL - }; - struct strbuf zip_path = STRBUF_INIT; - struct strvec archiver_args = STRVEC_INIT; - char **argv_copy = NULL; - int stdout_fd = -1, archiver_fd = -1; - time_t now = time(NULL); - struct tm tm; - struct strbuf path = STRBUF_INIT, buf = STRBUF_INIT; - int res = 0; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - setup_enlistment_directory(argc, argv, usage, options, &zip_path); - - strbuf_addstr(&zip_path, "/.scalarDiagnostics/scalar_"); - strbuf_addftime(&zip_path, - "%Y%m%d_%H%M%S", localtime_r(&now, &tm), 0, 0); - strbuf_addstr(&zip_path, ".zip"); - switch (safe_create_leading_directories(zip_path.buf)) { - case SCLD_EXISTS: - case SCLD_OK: - break; - default: - error_errno(_("could not create directory for '%s'"), - zip_path.buf); - goto diagnose_cleanup; - } - stdout_fd = dup(1); - if (stdout_fd < 0) { - res = error_errno(_("could not duplicate stdout")); - goto diagnose_cleanup; - } - - archiver_fd = xopen(zip_path.buf, O_CREAT | O_WRONLY | O_TRUNC, 0666); - if (archiver_fd < 0 || dup2(archiver_fd, 1) < 0) { - res = error_errno(_("could not redirect output")); - goto diagnose_cleanup; - } - - init_zip_archiver(); - strvec_pushl(&archiver_args, "scalar-diagnose", "--format=zip", NULL); - - strbuf_reset(&buf); - strbuf_addstr(&buf, "Collecting diagnostic info\n\n"); - get_version_info(&buf, 1); - - strbuf_addf(&buf, "Enlistment root: %s\n", the_repository->worktree); - get_disk_info(&buf); - write_or_die(stdout_fd, buf.buf, buf.len); - strvec_pushf(&archiver_args, - "--add-virtual-file=diagnostics.log:%.*s", - (int)buf.len, buf.buf); - - strbuf_reset(&buf); - strbuf_addstr(&buf, "--add-virtual-file=packs-local.txt:"); - dir_file_stats(the_repository->objects->odb, &buf); - foreach_alt_odb(dir_file_stats, &buf); - strvec_push(&archiver_args, buf.buf); - - strbuf_reset(&buf); - strbuf_addstr(&buf, "--add-virtual-file=objects-local.txt:"); - loose_objs_stats(&buf, ".git/objects"); - strvec_push(&archiver_args, buf.buf); - - if ((res = add_directory_to_archiver(&archiver_args, ".git", 0)) || - (res = add_directory_to_archiver(&archiver_args, ".git/hooks", 0)) || - (res = add_directory_to_archiver(&archiver_args, ".git/info", 0)) || - (res = add_directory_to_archiver(&archiver_args, ".git/logs", 1)) || - (res = add_directory_to_archiver(&archiver_args, ".git/objects/info", 0))) - goto diagnose_cleanup; - - strvec_pushl(&archiver_args, "--prefix=", - oid_to_hex(the_hash_algo->empty_tree), "--", NULL); - - /* `write_archive()` modifies the `argv` passed to it. Let it. */ - argv_copy = xmemdupz(archiver_args.v, - sizeof(char *) * archiver_args.nr); - res = write_archive(archiver_args.nr, (const char **)argv_copy, NULL, - the_repository, NULL, 0); - if (res) { - error(_("failed to write archive")); - goto diagnose_cleanup; - } - - if (!res) - fprintf(stderr, "\n" - "Diagnostics complete.\n" - "All of the gathered info is captured in '%s'\n", - zip_path.buf); - -diagnose_cleanup: - if (archiver_fd >= 0) { - close(1); - dup2(stdout_fd, 1); - } - free(argv_copy); - strvec_clear(&archiver_args); - strbuf_release(&zip_path); - strbuf_release(&path); - strbuf_release(&buf); - - return res; -} - -static int cmd_list(int argc, const char **argv) -{ - if (argc != 1) - die(_("`scalar list` does not take arguments")); - - if (run_git("config", "--global", "--get-all", "scalar.repo", NULL) < 0) - return -1; - return 0; -} - -static int cmd_register(int argc, const char **argv) -{ - struct option options[] = { - OPT_END(), - }; - const char * const usage[] = { - N_("scalar register [<enlistment>]"), - NULL - }; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - setup_enlistment_directory(argc, argv, usage, options, NULL); - - return register_dir(); -} - -static int get_scalar_repos(const char *key, const char *value, void *data) -{ - struct string_list *list = data; - - if (!strcmp(key, "scalar.repo")) - string_list_append(list, value); - - return 0; -} - -static int cmd_reconfigure(int argc, const char **argv) -{ - int all = 0; - struct option options[] = { - OPT_BOOL('a', "all", &all, - N_("reconfigure all registered enlistments")), - OPT_END(), - }; - const char * const usage[] = { - N_("scalar reconfigure [--all | <enlistment>]"), - NULL - }; - struct string_list scalar_repos = STRING_LIST_INIT_DUP; - int i, res = 0; - struct repository r = { NULL }; - struct strbuf commondir = STRBUF_INIT, gitdir = STRBUF_INIT; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - if (!all) { - setup_enlistment_directory(argc, argv, usage, options, NULL); - - return set_recommended_config(1); - } - - if (argc > 0) - usage_msg_opt(_("--all or <enlistment>, but not both"), - usage, options); - - git_config(get_scalar_repos, &scalar_repos); - - for (i = 0; i < scalar_repos.nr; i++) { - const char *dir = scalar_repos.items[i].string; - - strbuf_reset(&commondir); - strbuf_reset(&gitdir); - - if (chdir(dir) < 0) { - warning_errno(_("could not switch to '%s'"), dir); - res = -1; - } else if (discover_git_directory(&commondir, &gitdir) < 0) { - warning_errno(_("git repository gone in '%s'"), dir); - res = -1; - } else { - git_config_clear(); - - the_repository = &r; - r.commondir = commondir.buf; - r.gitdir = gitdir.buf; - - if (set_recommended_config(1) < 0) - res = -1; - } - } - - string_list_clear(&scalar_repos, 1); - strbuf_release(&commondir); - strbuf_release(&gitdir); - - return res; -} - -static int cmd_run(int argc, const char **argv) -{ - struct option options[] = { - OPT_END(), - }; - struct { - const char *arg, *task; - } tasks[] = { - { "config", NULL }, - { "commit-graph", "commit-graph" }, - { "fetch", "prefetch" }, - { "loose-objects", "loose-objects" }, - { "pack-files", "incremental-repack" }, - { NULL, NULL } - }; - struct strbuf buf = STRBUF_INIT; - const char *usagestr[] = { NULL, NULL }; - int i; - - strbuf_addstr(&buf, N_("scalar run <task> [<enlistment>]\nTasks:\n")); - for (i = 0; tasks[i].arg; i++) - strbuf_addf(&buf, "\t%s\n", tasks[i].arg); - usagestr[0] = buf.buf; - - argc = parse_options(argc, argv, NULL, options, - usagestr, 0); - - if (!argc) - usage_with_options(usagestr, options); - - if (!strcmp("all", argv[0])) { - i = -1; - } else { - for (i = 0; tasks[i].arg && strcmp(tasks[i].arg, argv[0]); i++) - ; /* keep looking for the task */ - - if (i > 0 && !tasks[i].arg) { - error(_("no such task: '%s'"), argv[0]); - usage_with_options(usagestr, options); - } - } - - argc--; - argv++; - setup_enlistment_directory(argc, argv, usagestr, options, NULL); - strbuf_release(&buf); - - if (i == 0) - return register_dir(); - - if (i > 0) - return run_git("maintenance", "run", - "--task", tasks[i].task, NULL); - - if (register_dir()) - return -1; - for (i = 1; tasks[i].arg; i++) - if (run_git("maintenance", "run", - "--task", tasks[i].task, NULL)) - return -1; - return 0; -} - -static int remove_deleted_enlistment(struct strbuf *path) -{ - int res = 0; - strbuf_realpath_forgiving(path, path->buf, 1); - - if (run_git("config", "--global", - "--unset", "--fixed-value", - "scalar.repo", path->buf, NULL) < 0) - res = -1; - - if (run_git("config", "--global", - "--unset", "--fixed-value", - "maintenance.repo", path->buf, NULL) < 0) - res = -1; - - return res; -} - -static int cmd_unregister(int argc, const char **argv) -{ - struct option options[] = { - OPT_END(), - }; - const char * const usage[] = { - N_("scalar unregister [<enlistment>]"), - NULL - }; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - /* - * Be forgiving when the enlistment or worktree does not even exist any - * longer; This can be the case if a user deleted the worktree by - * mistake and _still_ wants to unregister the thing. - */ - if (argc == 1) { - struct strbuf src_path = STRBUF_INIT, workdir_path = STRBUF_INIT; - - strbuf_addf(&src_path, "%s/src/.git", argv[0]); - strbuf_addf(&workdir_path, "%s/.git", argv[0]); - if (!is_directory(src_path.buf) && !is_directory(workdir_path.buf)) { - /* remove possible matching registrations */ - int res = -1; - - strbuf_strip_suffix(&src_path, "/.git"); - res = remove_deleted_enlistment(&src_path) && res; - - strbuf_strip_suffix(&workdir_path, "/.git"); - res = remove_deleted_enlistment(&workdir_path) && res; - - strbuf_release(&src_path); - strbuf_release(&workdir_path); - return res; - } - strbuf_release(&src_path); - strbuf_release(&workdir_path); - } - - setup_enlistment_directory(argc, argv, usage, options, NULL); - - return unregister_dir(); -} - -static int cmd_delete(int argc, const char **argv) -{ - char *cwd = xgetcwd(); - struct option options[] = { - OPT_END(), - }; - const char * const usage[] = { - N_("scalar delete <enlistment>"), - NULL - }; - struct strbuf enlistment = STRBUF_INIT; - int res = 0; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - if (argc != 1) - usage_with_options(usage, options); - - setup_enlistment_directory(argc, argv, usage, options, &enlistment); - - if (dir_inside_of(cwd, enlistment.buf) >= 0) - res = error(_("refusing to delete current working directory")); - else { - close_object_store(the_repository->objects); - res = delete_enlistment(&enlistment); - } - strbuf_release(&enlistment); - free(cwd); - - return res; -} - -static int cmd_version(int argc, const char **argv) -{ - int verbose = 0, build_options = 0; - struct option options[] = { - OPT__VERBOSE(&verbose, N_("include Git version")), - OPT_BOOL(0, "build-options", &build_options, - N_("include Git's build options")), - OPT_END(), - }; - const char * const usage[] = { - N_("scalar verbose [-v | --verbose] [--build-options]"), - NULL - }; - struct strbuf buf = STRBUF_INIT; - - argc = parse_options(argc, argv, NULL, options, - usage, 0); - - if (argc != 0) - usage_with_options(usage, options); - - get_version_info(&buf, build_options); - fprintf(stderr, "%s\n", buf.buf); - strbuf_release(&buf); - - return 0; -} - -static struct { - const char *name; - int (*fn)(int, const char **); -} builtins[] = { - { "clone", cmd_clone }, - { "list", cmd_list }, - { "register", cmd_register }, - { "unregister", cmd_unregister }, - { "run", cmd_run }, - { "reconfigure", cmd_reconfigure }, - { "delete", cmd_delete }, - { "version", cmd_version }, - { "diagnose", cmd_diagnose }, - { NULL, NULL}, -}; - -int cmd_main(int argc, const char **argv) -{ - struct strbuf scalar_usage = STRBUF_INIT; - int i; - - while (argc > 1 && *argv[1] == '-') { - if (!strcmp(argv[1], "-C")) { - if (argc < 3) - die(_("-C requires a <directory>")); - if (chdir(argv[2]) < 0) - die_errno(_("could not change to '%s'"), - argv[2]); - argc -= 2; - argv += 2; - } else if (!strcmp(argv[1], "-c")) { - if (argc < 3) - die(_("-c requires a <key>=<value> argument")); - git_config_push_parameter(argv[2]); - argc -= 2; - argv += 2; - } else - break; - } - - if (argc > 1) { - argv++; - argc--; - - for (i = 0; builtins[i].name; i++) - if (!strcmp(builtins[i].name, argv[0])) - return !!builtins[i].fn(argc, argv); - } - - strbuf_addstr(&scalar_usage, - N_("scalar [-C <directory>] [-c <key>=<value>] " - "<command> [<options>]\n\nCommands:\n")); - for (i = 0; builtins[i].name; i++) - strbuf_addf(&scalar_usage, "\t%s\n", builtins[i].name); - - usage(scalar_usage.buf); -} diff --git a/contrib/scalar/scalar.txt b/contrib/scalar/scalar.txt deleted file mode 100644 index c0425e0653..0000000000 --- a/contrib/scalar/scalar.txt +++ /dev/null @@ -1,167 +0,0 @@ -scalar(1) -========= - -NAME ----- -scalar - an opinionated repository management tool - -SYNOPSIS --------- -[verse] -scalar clone [--single-branch] [--branch <main-branch>] [--full-clone] <url> [<enlistment>] -scalar list -scalar register [<enlistment>] -scalar unregister [<enlistment>] -scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>] -scalar reconfigure [ --all | <enlistment> ] -scalar diagnose [<enlistment>] -scalar delete <enlistment> - -DESCRIPTION ------------ - -Scalar is an opinionated repository management tool. By creating new -repositories or registering existing repositories with Scalar, your Git -experience will speed up. Scalar sets advanced Git config settings, -maintains your repositories in the background, and helps reduce data sent -across the network. - -An important Scalar concept is the enlistment: this is the top-level directory -of the project. It usually contains the subdirectory `src/` which is a Git -worktree. This encourages the separation between tracked files (inside `src/`) -and untracked files, such as build artifacts (outside `src/`). When registering -an existing Git worktree with Scalar whose name is not `src`, the enlistment -will be identical to the worktree. - -The `scalar` command implements various subcommands, and different options -depending on the subcommand. With the exception of `clone`, `list` and -`reconfigure --all`, all subcommands expect to be run in an enlistment. - -The following options can be specified _before_ the subcommand: - --C <directory>:: - Before running the subcommand, change the working directory. This - option imitates the same option of linkgit:git[1]. - --c <key>=<value>:: - For the duration of running the specified subcommand, configure this - setting. This option imitates the same option of linkgit:git[1]. - -COMMANDS --------- - -Clone -~~~~~ - -clone [<options>] <url> [<enlistment>]:: - Clones the specified repository, similar to linkgit:git-clone[1]. By - default, only commit and tree objects are cloned. Once finished, the - worktree is located at `<enlistment>/src`. -+ -The sparse-checkout feature is enabled (except when run with `--full-clone`) -and the only files present are those in the top-level directory. Use -`git sparse-checkout set` to expand the set of directories you want to see, -or `git sparse-checkout disable` to expand to all files (see -linkgit:git-sparse-checkout[1] for more details). You can explore the -subdirectories outside your sparse-checkout by using `git ls-tree -HEAD[:<directory>]`. - --b <name>:: ---branch <name>:: - Instead of checking out the branch pointed to by the cloned - repository's HEAD, check out the `<name>` branch instead. - ---[no-]single-branch:: - Clone only the history leading to the tip of a single branch, either - specified by the `--branch` option or the primary branch remote's - `HEAD` points at. -+ -Further fetches into the resulting repository will only update the -remote-tracking branch for the branch this option was used for the initial -cloning. If the HEAD at the remote did not point at any branch when -`--single-branch` clone was made, no remote-tracking branch is created. - ---[no-]full-clone:: - A sparse-checkout is initialized by default. This behavior can be - turned off via `--full-clone`. - -List -~~~~ - -list:: - List enlistments that are currently registered by Scalar. This - subcommand does not need to be run inside an enlistment. - -Register -~~~~~~~~ - -register [<enlistment>]:: - Adds the enlistment's repository to the list of registered repositories - and starts background maintenance. If `<enlistment>` is not provided, - then the enlistment associated with the current working directory is - registered. -+ -Note: when this subcommand is called in a worktree that is called `src/`, its -parent directory is considered to be the Scalar enlistment. If the worktree is -_not_ called `src/`, it itself will be considered to be the Scalar enlistment. - -Unregister -~~~~~~~~~~ - -unregister [<enlistment>]:: - Remove the specified repository from the list of repositories - registered with Scalar and stop the scheduled background maintenance. - -Run -~~~ - -scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>]:: - Run the given maintenance task (or all tasks, if `all` was specified). - Except for `all` and `config`, this subcommand simply hands off to - linkgit:git-maintenance[1] (mapping `fetch` to `prefetch` and - `pack-files` to `incremental-repack`). -+ -These tasks are run automatically as part of the scheduled maintenance, -as soon as the repository is registered with Scalar. It should therefore -not be necessary to run this subcommand manually. -+ -The `config` task is specific to Scalar and configures all those -opinionated default settings that make Git work more efficiently with -large repositories. As this task is run as part of `scalar clone` -automatically, explicit invocations of this task are rarely needed. - -Reconfigure -~~~~~~~~~~~ - -After a Scalar upgrade, or when the configuration of a Scalar enlistment -was somehow corrupted or changed by mistake, this subcommand allows to -reconfigure the enlistment. - -With the `--all` option, all enlistments currently registered with Scalar -will be reconfigured. Use this option after each Scalar upgrade. - -Diagnose -~~~~~~~~ - -diagnose [<enlistment>]:: - When reporting issues with Scalar, it is often helpful to provide the - information gathered by this command, including logs and certain - statistics describing the data shape of the current enlistment. -+ -The output of this command is a `.zip` file that is written into -a directory adjacent to the worktree in the `src` directory. - -Delete -~~~~~~ - -delete <enlistment>:: - This subcommand lets you delete an existing Scalar enlistment from your - local file system, unregistering the repository. - -SEE ALSO --------- -linkgit:git-clone[1], linkgit:git-maintenance[1]. - -Scalar ---- -Associated with the linkgit:git[1] suite diff --git a/contrib/scalar/t/Makefile b/contrib/scalar/t/Makefile deleted file mode 100644 index 01e82e56d1..0000000000 --- a/contrib/scalar/t/Makefile +++ /dev/null @@ -1,81 +0,0 @@ -# Import tree-wide shared Makefile behavior and libraries -include ../../../shared.mak - -# Run scalar tests -# -# Copyright (c) 2005,2021 Junio C Hamano, Johannes Schindelin -# - --include ../../../config.mak.autogen --include ../../../config.mak - -SHELL_PATH ?= $(SHELL) -PERL_PATH ?= /usr/bin/perl -RM ?= rm -f -PROVE ?= prove -DEFAULT_TEST_TARGET ?= test -TEST_LINT ?= test-lint - -ifdef TEST_OUTPUT_DIRECTORY -TEST_RESULTS_DIRECTORY = $(TEST_OUTPUT_DIRECTORY)/test-results -else -TEST_RESULTS_DIRECTORY = ../../../t/test-results -endif - -# Shell quote; -SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) -PERL_PATH_SQ = $(subst ','\'',$(PERL_PATH)) -TEST_RESULTS_DIRECTORY_SQ = $(subst ','\'',$(TEST_RESULTS_DIRECTORY)) - -T = $(sort $(wildcard t[0-9][0-9][0-9][0-9]-*.sh)) - -all: $(DEFAULT_TEST_TARGET) - -test: $(TEST_LINT) - $(MAKE) aggregate-results-and-cleanup - -prove: $(TEST_LINT) - @echo "*** prove ***"; GIT_CONFIG=.git/config $(PROVE) --exec '$(SHELL_PATH_SQ)' $(GIT_PROVE_OPTS) $(T) :: $(GIT_TEST_OPTS) - $(MAKE) clean-except-prove-cache - -$(T): - @echo "*** $@ ***"; GIT_CONFIG=.git/config '$(SHELL_PATH_SQ)' $@ $(GIT_TEST_OPTS) - -clean-except-prove-cache: - $(RM) -r 'trash directory'.* '$(TEST_RESULTS_DIRECTORY_SQ)' - $(RM) -r valgrind/bin - -clean: clean-except-prove-cache - $(RM) .prove - -test-lint: test-lint-duplicates test-lint-executable test-lint-shell-syntax - -test-lint-duplicates: - @dups=`echo $(T) | tr ' ' '\n' | sed 's/-.*//' | sort | uniq -d` && \ - test -z "$$dups" || { \ - echo >&2 "duplicate test numbers:" $$dups; exit 1; } - -test-lint-executable: - @bad=`for i in $(T); do test -x "$$i" || echo $$i; done` && \ - test -z "$$bad" || { \ - echo >&2 "non-executable tests:" $$bad; exit 1; } - -test-lint-shell-syntax: - @'$(PERL_PATH_SQ)' ../../../t/check-non-portable-shell.pl $(T) - -aggregate-results-and-cleanup: $(T) - $(MAKE) aggregate-results - $(MAKE) clean - -aggregate-results: - for f in '$(TEST_RESULTS_DIRECTORY_SQ)'/t*-*.counts; do \ - echo "$$f"; \ - done | '$(SHELL_PATH_SQ)' ../../../t/aggregate-results.sh - -valgrind: - $(MAKE) GIT_TEST_OPTS="$(GIT_TEST_OPTS) --valgrind" - -test-results: - mkdir -p test-results - -.PHONY: $(T) aggregate-results clean valgrind diff --git a/contrib/scalar/t/t9099-scalar.sh b/contrib/scalar/t/t9099-scalar.sh deleted file mode 100755 index 10b1172a8a..0000000000 --- a/contrib/scalar/t/t9099-scalar.sh +++ /dev/null @@ -1,123 +0,0 @@ -#!/bin/sh - -test_description='test the `scalar` command' - -TEST_DIRECTORY=$PWD/../../../t -export TEST_DIRECTORY - -# Make it work with --no-bin-wrappers -PATH=$PWD/..:$PATH - -. ../../../t/test-lib.sh - -GIT_TEST_MAINT_SCHEDULER="crontab:test-tool crontab ../cron.txt,launchctl:true,schtasks:true" -export GIT_TEST_MAINT_SCHEDULER - -test_expect_success 'scalar shows a usage' ' - test_expect_code 129 scalar -h -' - -test_expect_success 'scalar unregister' ' - git init vanish/src && - scalar register vanish/src && - git config --get --global --fixed-value \ - maintenance.repo "$(pwd)/vanish/src" && - scalar list >scalar.repos && - grep -F "$(pwd)/vanish/src" scalar.repos && - rm -rf vanish/src/.git && - scalar unregister vanish && - test_must_fail git config --get --global --fixed-value \ - maintenance.repo "$(pwd)/vanish/src" && - scalar list >scalar.repos && - ! grep -F "$(pwd)/vanish/src" scalar.repos -' - -test_expect_success 'set up repository to clone' ' - test_commit first && - test_commit second && - test_commit third && - git switch -c parallel first && - mkdir -p 1/2 && - test_commit 1/2/3 && - git config uploadPack.allowFilter true && - git config uploadPack.allowAnySHA1InWant true -' - -test_expect_success 'scalar clone' ' - second=$(git rev-parse --verify second:second.t) && - scalar clone "file://$(pwd)" cloned --single-branch && - ( - cd cloned/src && - - git config --get --global --fixed-value maintenance.repo \ - "$(pwd)" && - - git for-each-ref --format="%(refname)" refs/remotes/origin/ >actual && - echo "refs/remotes/origin/parallel" >expect && - test_cmp expect actual && - - test_path_is_missing 1/2 && - test_must_fail git rev-list --missing=print $second && - git rev-list $second && - git cat-file blob $second >actual && - echo "second" >expect && - test_cmp expect actual - ) -' - -test_expect_success 'scalar reconfigure' ' - git init one/src && - scalar register one && - git -C one/src config core.preloadIndex false && - scalar reconfigure one && - test true = "$(git -C one/src config core.preloadIndex)" && - git -C one/src config core.preloadIndex false && - scalar reconfigure -a && - test true = "$(git -C one/src config core.preloadIndex)" -' - -test_expect_success 'scalar delete without enlistment shows a usage' ' - test_expect_code 129 scalar delete -' - -test_expect_success 'scalar delete with enlistment' ' - scalar delete cloned && - test_path_is_missing cloned -' - -test_expect_success 'scalar supports -c/-C' ' - test_when_finished "scalar delete sub" && - git init sub && - scalar -C sub -c status.aheadBehind=bogus register && - test -z "$(git -C sub config --local status.aheadBehind)" && - test true = "$(git -C sub config core.preloadIndex)" -' - -test_expect_success '`scalar [...] <dir>` errors out when dir is missing' ' - ! scalar run config cloned 2>err && - grep "cloned. does not exist" err -' - -SQ="'" -test_expect_success UNZIP 'scalar diagnose' ' - scalar clone "file://$(pwd)" cloned --single-branch && - git repack && - echo "$(pwd)/.git/objects/" >>cloned/src/.git/objects/info/alternates && - test_commit -C cloned/src loose && - scalar diagnose cloned >out 2>err && - grep "Available space" out && - sed -n "s/.*$SQ\\(.*\\.zip\\)$SQ.*/\\1/p" <err >zip_path && - zip_path=$(cat zip_path) && - test -n "$zip_path" && - unzip -v "$zip_path" && - folder=${zip_path%.zip} && - test_path_is_missing "$folder" && - unzip -p "$zip_path" diagnostics.log >out && - test_file_not_empty out && - unzip -p "$zip_path" packs-local.txt >out && - grep "$(pwd)/.git/objects" out && - unzip -p "$zip_path" objects-local.txt >out && - grep "^Total: [1-9]" out -' - -test_done diff --git a/contrib/subtree/git-subtree.sh b/contrib/subtree/git-subtree.sh index 1af1d9653e..7562a395c2 100755 --- a/contrib/subtree/git-subtree.sh +++ b/contrib/subtree/git-subtree.sh @@ -50,6 +50,14 @@ m,message= use the given message as the commit message for the merge commit indent=0 +# Usage: say [MSG...] +say () { + if test -z "$arg_quiet" + then + printf '%s\n' "$*" + fi +} + # Usage: debug [MSG...] debug () { if test -n "$arg_debug" @@ -60,7 +68,7 @@ debug () { # Usage: progress [MSG...] progress () { - if test -z "$GIT_QUIET" + if test -z "$arg_quiet" then if test -z "$arg_debug" then @@ -146,6 +154,7 @@ main () { eval "$set_args" # Begin "real" flag parsing. + arg_quiet= arg_debug= arg_prefix= arg_split_branch= @@ -161,7 +170,7 @@ main () { case "$opt" in -q) - GIT_QUIET=1 + arg_quiet=1 ;; -d) arg_debug=1 @@ -252,7 +261,7 @@ main () { dir="$(dirname "$arg_prefix/.")" debug "command: {$arg_command}" - debug "quiet: {$GIT_QUIET}" + debug "quiet: {$arg_quiet}" debug "dir: {$dir}" debug "opts: {$*}" debug diff --git a/contrib/subtree/t/Makefile b/contrib/subtree/t/Makefile index 276898eb6b..4655e0987b 100644 --- a/contrib/subtree/t/Makefile +++ b/contrib/subtree/t/Makefile @@ -47,10 +47,11 @@ pre-clean: $(RM) -r '$(TEST_RESULTS_DIRECTORY_SQ)' clean-except-prove-cache: - $(RM) -r 'trash directory'.* '$(TEST_RESULTS_DIRECTORY_SQ)' + $(RM) -r 'trash directory'.* $(RM) -r valgrind/bin clean: clean-except-prove-cache + $(RM) -r '$(TEST_RESULTS_DIRECTORY_SQ)' $(RM) .prove test-lint: test-lint-duplicates test-lint-executable test-lint-shell-syntax |
