From dbdcab6b89ea86fe58ece01bbb7be297ff23b2c4 Mon Sep 17 00:00:00 2001 From: Paulo Casaretto Date: Thu, 22 Jan 2026 19:23:35 +0000 Subject: [PATCH 01/15] lockfile: add PID file for debugging stale locks When a lock file is held, it can be helpful to know which process owns it, especially when debugging stale locks left behind by crashed processes. Add an optional feature that creates a companion PID file alongside each lock file, containing the PID of the lock holder. For a lock file "foo.lock", the PID file is named "foo~pid.lock". The tilde character is forbidden in refnames and allowed in Windows filenames, which guarantees no collision with the refs namespace (e.g., refs "foo" and "foo~pid" cannot both exist). The file contains a single line in the format "pid " followed by a newline. The PID file is created when a lock is acquired (if enabled), and automatically cleaned up when the lock is released (via commit or rollback). The file is registered as a tempfile so it gets cleaned up by signal and atexit handlers if the process terminates abnormally. When a lock conflict occurs, the code checks for an existing PID file and, if found, uses kill(pid, 0) to determine if the process is still running. This allows providing context-aware error messages: Lock is held by process 12345. Wait for it to finish, or remove the lock file to continue. Or for a stale lock: Lock was held by process 12345, which is no longer running. Remove the stale lock file to continue. The feature is controlled via core.lockfilePid configuration (boolean). Defaults to false. When enabled, PID files are created for all lock operations. Existing PID files are always read when displaying lock errors, regardless of the core.lockfilePid setting. This ensures helpful diagnostics even when the feature was previously enabled and later disabled. Signed-off-by: Paulo Casaretto Signed-off-by: Junio C Hamano --- Documentation/config/core.adoc | 11 +++ compat/mingw.c | 10 ++ environment.c | 6 ++ lockfile.c | 168 ++++++++++++++++++++++++++++++--- lockfile.h | 43 ++++++--- t/meson.build | 1 + t/t0031-lockfile-pid.sh | 105 +++++++++++++++++++++ 7 files changed, 315 insertions(+), 29 deletions(-) create mode 100755 t/t0031-lockfile-pid.sh diff --git a/Documentation/config/core.adoc b/Documentation/config/core.adoc index 01202da7cd4a36..5c4bc9206fb0fb 100644 --- a/Documentation/config/core.adoc +++ b/Documentation/config/core.adoc @@ -348,6 +348,17 @@ confusion unless you know what you are doing (e.g. you are creating a read-only snapshot of the same index to a location different from the repository's usual working tree). +core.lockfilePid:: + If true, Git will create a PID file alongside lock files. When a + lock acquisition fails and a PID file exists, Git can provide + additional diagnostic information about the process holding the + lock, including whether it is still running. Defaults to `false`. ++ +The PID file is named by inserting `~pid` before the `.lock` suffix. +For example, if the lock file is `index.lock`, the PID file will be +`index~pid.lock`. The file contains a single line in the format +`pid ` followed by a newline. + core.logAllRefUpdates:: Enable the reflog. Updates to a ref is logged to the file "`$GIT_DIR/logs/`", by appending the new and old diff --git a/compat/mingw.c b/compat/mingw.c index 939f938fe27fe5..146b2585ce7ebf 100644 --- a/compat/mingw.c +++ b/compat/mingw.c @@ -1972,6 +1972,16 @@ int mingw_kill(pid_t pid, int sig) CloseHandle(h); return 0; } + /* + * OpenProcess returns ERROR_INVALID_PARAMETER for + * non-existent PIDs. Map this to ESRCH for POSIX + * compatibility with kill(pid, 0). + */ + if (GetLastError() == ERROR_INVALID_PARAMETER) + errno = ESRCH; + else + errno = err_win_to_posix(GetLastError()); + return -1; } errno = EINVAL; diff --git a/environment.c b/environment.c index a770b5921d9546..4adcce8606a34c 100644 --- a/environment.c +++ b/environment.c @@ -21,6 +21,7 @@ #include "gettext.h" #include "git-zlib.h" #include "ident.h" +#include "lockfile.h" #include "mailmap.h" #include "object-name.h" #include "repository.h" @@ -532,6 +533,11 @@ static int git_default_core_config(const char *var, const char *value, return 0; } + if (!strcmp(var, "core.lockfilepid")) { + lockfile_pid_enabled = git_config_bool(var, value); + return 0; + } + if (!strcmp(var, "core.createobject")) { if (!value) return config_error_nonbool(var); diff --git a/lockfile.c b/lockfile.c index 1d5ed016828746..13e2ad1307a186 100644 --- a/lockfile.c +++ b/lockfile.c @@ -6,6 +6,9 @@ #include "abspath.h" #include "gettext.h" #include "lockfile.h" +#include "parse.h" +#include "strbuf.h" +#include "wrapper.h" /* * path = absolute or relative path name @@ -71,19 +74,115 @@ static void resolve_symlink(struct strbuf *path) strbuf_reset(&link); } +/* + * Lock PID file functions - write PID to a foo~pid.lock file alongside + * the lock file for debugging stale locks. The PID file is registered + * as a tempfile so it gets cleaned up by signal/atexit handlers. + * + * Naming: For "foo.lock", the PID file is "foo~pid.lock". The tilde is + * forbidden in refnames and allowed in Windows filenames, guaranteeing + * no collision with the refs namespace. + */ + +/* Global config variable, initialized from core.lockfilePid */ +int lockfile_pid_enabled; + +/* + * Path generation helpers. + * Given base path "foo", generate: + * - lock path: "foo.lock" + * - pid path: "foo-pid.lock" + */ +static void get_lock_path(struct strbuf *out, const char *path) +{ + strbuf_addstr(out, path); + strbuf_addstr(out, LOCK_SUFFIX); +} + +static void get_pid_path(struct strbuf *out, const char *path) +{ + strbuf_addstr(out, path); + strbuf_addstr(out, LOCK_PID_INFIX); + strbuf_addstr(out, LOCK_SUFFIX); +} + +static struct tempfile *create_lock_pid_file(const char *pid_path, int mode) +{ + struct strbuf content = STRBUF_INIT; + struct tempfile *pid_tempfile = NULL; + int fd; + + if (!lockfile_pid_enabled) + goto out; + + fd = open(pid_path, O_WRONLY | O_CREAT | O_EXCL, mode); + if (fd < 0) + goto out; + + strbuf_addf(&content, "pid %" PRIuMAX "\n", (uintmax_t)getpid()); + if (write_in_full(fd, content.buf, content.len) < 0) { + warning_errno(_("could not write lock pid file '%s'"), pid_path); + close(fd); + unlink(pid_path); + goto out; + } + + close(fd); + pid_tempfile = register_tempfile(pid_path); + +out: + strbuf_release(&content); + return pid_tempfile; +} + +static int read_lock_pid(const char *pid_path, uintmax_t *pid_out) +{ + struct strbuf content = STRBUF_INIT; + const char *val; + int ret = -1; + + if (strbuf_read_file(&content, pid_path, LOCK_PID_MAXLEN) <= 0) + goto out; + + strbuf_rtrim(&content); + + if (skip_prefix(content.buf, "pid ", &val)) { + char *endptr; + *pid_out = strtoumax(val, &endptr, 10); + if (*pid_out > 0 && !*endptr) + ret = 0; + } + + if (ret) + warning(_("malformed lock pid file '%s'"), pid_path); + +out: + strbuf_release(&content); + return ret; +} + /* Make sure errno contains a meaningful value on error */ static int lock_file(struct lock_file *lk, const char *path, int flags, int mode) { - struct strbuf filename = STRBUF_INIT; + struct strbuf base_path = STRBUF_INIT; + struct strbuf lock_path = STRBUF_INIT; + struct strbuf pid_path = STRBUF_INIT; - strbuf_addstr(&filename, path); + strbuf_addstr(&base_path, path); if (!(flags & LOCK_NO_DEREF)) - resolve_symlink(&filename); + resolve_symlink(&base_path); + + get_lock_path(&lock_path, base_path.buf); + get_pid_path(&pid_path, base_path.buf); + + lk->tempfile = create_tempfile_mode(lock_path.buf, mode); + if (lk->tempfile) + lk->pid_tempfile = create_lock_pid_file(pid_path.buf, mode); - strbuf_addstr(&filename, LOCK_SUFFIX); - lk->tempfile = create_tempfile_mode(filename.buf, mode); - strbuf_release(&filename); + strbuf_release(&base_path); + strbuf_release(&lock_path); + strbuf_release(&pid_path); return lk->tempfile ? lk->tempfile->fd : -1; } @@ -151,16 +250,49 @@ static int lock_file_timeout(struct lock_file *lk, const char *path, void unable_to_lock_message(const char *path, int err, struct strbuf *buf) { if (err == EEXIST) { - strbuf_addf(buf, _("Unable to create '%s.lock': %s.\n\n" - "Another git process seems to be running in this repository, e.g.\n" - "an editor opened by 'git commit'. Please make sure all processes\n" - "are terminated then try again. If it still fails, a git process\n" - "may have crashed in this repository earlier:\n" - "remove the file manually to continue."), - absolute_path(path), strerror(err)); - } else + const char *abs_path = absolute_path(path); + struct strbuf lock_path = STRBUF_INIT; + struct strbuf pid_path = STRBUF_INIT; + uintmax_t pid; + int pid_status = 0; /* 0 = unknown, 1 = running, -1 = stale */ + + get_lock_path(&lock_path, abs_path); + get_pid_path(&pid_path, abs_path); + + strbuf_addf(buf, _("Unable to create '%s': %s.\n\n"), + lock_path.buf, strerror(err)); + + /* + * Try to read PID file unconditionally - it may exist if + * core.lockfilePid was enabled. + */ + if (!read_lock_pid(pid_path.buf, &pid)) { + if (kill((pid_t)pid, 0) == 0 || errno == EPERM) + pid_status = 1; /* running (or no permission to signal) */ + else if (errno == ESRCH) + pid_status = -1; /* no such process - stale lock */ + } + + if (pid_status == 1) + strbuf_addf(buf, _("Lock may be held by process %" PRIuMAX "; " + "if no git process is running, the lock file " + "may be stale (PIDs can be reused)"), + pid); + else if (pid_status == -1) + strbuf_addf(buf, _("Lock was held by process %" PRIuMAX ", " + "which is no longer running; the lock file " + "appears to be stale"), + pid); + else + strbuf_addstr(buf, _("Another git process seems to be running in this repository, " + "or the lock file may be stale")); + + strbuf_release(&lock_path); + strbuf_release(&pid_path); + } else { strbuf_addf(buf, _("Unable to create '%s.lock': %s"), absolute_path(path), strerror(err)); + } } NORETURN void unable_to_lock_die(const char *path, int err) @@ -207,6 +339,8 @@ int commit_lock_file(struct lock_file *lk) { char *result_path = get_locked_file_path(lk); + delete_tempfile(&lk->pid_tempfile); + if (commit_lock_file_to(lk, result_path)) { int save_errno = errno; free(result_path); @@ -216,3 +350,9 @@ int commit_lock_file(struct lock_file *lk) free(result_path); return 0; } + +int rollback_lock_file(struct lock_file *lk) +{ + delete_tempfile(&lk->pid_tempfile); + return delete_tempfile(&lk->tempfile); +} diff --git a/lockfile.h b/lockfile.h index 1bb99264976d27..e7233f28dea5c7 100644 --- a/lockfile.h +++ b/lockfile.h @@ -119,6 +119,7 @@ struct lock_file { struct tempfile *tempfile; + struct tempfile *pid_tempfile; }; #define LOCK_INIT { 0 } @@ -127,6 +128,22 @@ struct lock_file { #define LOCK_SUFFIX ".lock" #define LOCK_SUFFIX_LEN 5 +/* + * PID file naming: for a lock file "foo.lock", the PID file is "foo~pid.lock". + * The tilde is forbidden in refnames and allowed in Windows filenames, avoiding + * namespace collisions (e.g., refs "foo" and "foo~pid" cannot both exist). + */ +#define LOCK_PID_INFIX "~pid" +#define LOCK_PID_INFIX_LEN 4 + +/* Maximum length for PID file content */ +#define LOCK_PID_MAXLEN 32 + +/* + * Whether to create PID files alongside lock files. + * Configured via core.lockfilePid (boolean). + */ +extern int lockfile_pid_enabled; /* * Flags @@ -169,12 +186,12 @@ struct lock_file { * handling, and mode are described above. */ int hold_lock_file_for_update_timeout_mode( - struct lock_file *lk, const char *path, - int flags, long timeout_ms, int mode); + struct lock_file *lk, const char *path, + int flags, long timeout_ms, int mode); static inline int hold_lock_file_for_update_timeout( - struct lock_file *lk, const char *path, - int flags, long timeout_ms) + struct lock_file *lk, const char *path, + int flags, long timeout_ms) { return hold_lock_file_for_update_timeout_mode(lk, path, flags, timeout_ms, 0666); @@ -186,15 +203,14 @@ static inline int hold_lock_file_for_update_timeout( * argument and error handling are described above. */ static inline int hold_lock_file_for_update( - struct lock_file *lk, const char *path, - int flags) + struct lock_file *lk, const char *path, int flags) { return hold_lock_file_for_update_timeout(lk, path, flags, 0); } static inline int hold_lock_file_for_update_mode( - struct lock_file *lk, const char *path, - int flags, int mode) + struct lock_file *lk, const char *path, + int flags, int mode) { return hold_lock_file_for_update_timeout_mode(lk, path, flags, 0, mode); } @@ -319,13 +335,10 @@ static inline int commit_lock_file_to(struct lock_file *lk, const char *path) /* * Roll back `lk`: close the file descriptor and/or file pointer and - * remove the lockfile. It is a NOOP to call `rollback_lock_file()` - * for a `lock_file` object that has already been committed or rolled - * back. No error will be returned in this case. + * remove the lockfile and any associated PID file. It is a NOOP to + * call `rollback_lock_file()` for a `lock_file` object that has already + * been committed or rolled back. No error will be returned in this case. */ -static inline int rollback_lock_file(struct lock_file *lk) -{ - return delete_tempfile(&lk->tempfile); -} +int rollback_lock_file(struct lock_file *lk); #endif /* LOCKFILE_H */ diff --git a/t/meson.build b/t/meson.build index 459c52a48972e4..2aec2c011e6706 100644 --- a/t/meson.build +++ b/t/meson.build @@ -98,6 +98,7 @@ integration_tests = [ 't0028-working-tree-encoding.sh', 't0029-core-unsetenvvars.sh', 't0030-stripspace.sh', + 't0031-lockfile-pid.sh', 't0033-safe-directory.sh', 't0034-root-safe-directory.sh', 't0035-safe-bare-repository.sh', diff --git a/t/t0031-lockfile-pid.sh b/t/t0031-lockfile-pid.sh new file mode 100755 index 00000000000000..8ef87addf56f1e --- /dev/null +++ b/t/t0031-lockfile-pid.sh @@ -0,0 +1,105 @@ +#!/bin/sh + +test_description='lock file PID info tests + +Tests for PID info file alongside lock files. +The feature is opt-in via core.lockfilePid config setting (boolean). +' + +. ./test-lib.sh + +test_expect_success 'stale lock detected when PID is not running' ' + git init repo && + ( + cd repo && + touch .git/index.lock && + printf "pid 99999" >.git/index~pid.lock && + test_must_fail git -c core.lockfilePid=true add . 2>err && + test_grep "process 99999, which is no longer running" err && + test_grep "appears to be stale" err + ) +' + +test_expect_success 'PID info not shown by default' ' + git init repo2 && + ( + cd repo2 && + touch .git/index.lock && + printf "pid 99999" >.git/index~pid.lock && + test_must_fail git add . 2>err && + # Should not crash, just show normal error without PID + test_grep "Unable to create" err && + ! test_grep "is held by process" err + ) +' + +test_expect_success 'running process detected when PID is alive' ' + git init repo3 && + ( + cd repo3 && + echo content >file && + # Get the correct PID for this platform + shell_pid=$$ && + if test_have_prereq MINGW && test -f /proc/$shell_pid/winpid + then + # In Git for Windows, Bash uses MSYS2 PIDs but git.exe + # uses Windows PIDs. Use the Windows PID. + shell_pid=$(cat /proc/$shell_pid/winpid) + fi && + # Create a lock and PID file with current shell PID (which is running) + touch .git/index.lock && + printf "pid %d" "$shell_pid" >.git/index~pid.lock && + # Verify our PID is shown in the error message + test_must_fail git -c core.lockfilePid=true add file 2>err && + test_grep "held by process $shell_pid" err + ) +' + +test_expect_success 'PID info file cleaned up on successful operation when enabled' ' + git init repo4 && + ( + cd repo4 && + echo content >file && + git -c core.lockfilePid=true add file && + # After successful add, no lock or PID files should exist + test_path_is_missing .git/index.lock && + test_path_is_missing .git/index~pid.lock + ) +' + +test_expect_success 'no PID file created by default' ' + git init repo5 && + ( + cd repo5 && + echo content >file && + git add file && + # PID file should not be created when feature is disabled + test_path_is_missing .git/index~pid.lock + ) +' + +test_expect_success 'core.lockfilePid=false does not create PID file' ' + git init repo6 && + ( + cd repo6 && + echo content >file && + git -c core.lockfilePid=false add file && + # PID file should not be created when feature is disabled + test_path_is_missing .git/index~pid.lock + ) +' + +test_expect_success 'existing PID files are read even when feature disabled' ' + git init repo7 && + ( + cd repo7 && + touch .git/index.lock && + printf "pid 99999" >.git/index~pid.lock && + # Even with lockfilePid disabled, existing PID files are read + # to help diagnose stale locks + test_must_fail git add . 2>err && + test_grep "process 99999" err + ) +' + +test_done From 777f5d089c1ab2478f652d706460e1c0c710f5c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Fri, 6 Feb 2026 04:12:23 +0000 Subject: [PATCH 02/15] doc: convert git-submodule to synopsis style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * convert commands to synopsis style * use __ for arguments * convert inline lists into proper definition lists * minor formatting fixes Reviewed-by: Kristoffer Haugsbakk Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-submodule.adoc | 395 ++++++++++++++++--------------- 1 file changed, 199 insertions(+), 196 deletions(-) diff --git a/Documentation/git-submodule.adoc b/Documentation/git-submodule.adoc index 95beaee5617b42..722d827908e2ab 100644 --- a/Documentation/git-submodule.adoc +++ b/Documentation/git-submodule.adoc @@ -8,19 +8,19 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- -[verse] -'git submodule' [--quiet] [--cached] -'git submodule' [--quiet] add [] [--] [] -'git submodule' [--quiet] status [--cached] [--recursive] [--] [...] -'git submodule' [--quiet] init [--] [...] -'git submodule' [--quiet] deinit [-f|--force] (--all|[--] ...) -'git submodule' [--quiet] update [] [--] [...] -'git submodule' [--quiet] set-branch [] [--] -'git submodule' [--quiet] set-url [--] -'git submodule' [--quiet] summary [] [--] [...] -'git submodule' [--quiet] foreach [--recursive] -'git submodule' [--quiet] sync [--recursive] [--] [...] -'git submodule' [--quiet] absorbgitdirs [--] [...] +[synopsis] +git submodule [--quiet] [--cached] +git submodule [--quiet] add [] [--] [] +git submodule [--quiet] status [--cached] [--recursive] [--] [...] +git submodule [--quiet] init [--] [...] +git submodule [--quiet] deinit [-f|--force] (--all|[--] ...) +git submodule [--quiet] update [] [--] [...] +git submodule [--quiet] set-branch [] [--] +git submodule [--quiet] set-url [--] +git submodule [--quiet] summary [] [--] [...] +git submodule [--quiet] foreach [--recursive] +git submodule [--quiet] sync [--recursive] [--] [...] +git submodule [--quiet] absorbgitdirs [--] [...] DESCRIPTION @@ -34,34 +34,34 @@ COMMANDS With no arguments, shows the status of existing submodules. Several subcommands are available to perform operations on the submodules. -add [-b ] [-f|--force] [--name ] [--reference ] [--ref-format ] [--depth ] [--] []:: +`add [-b ] [-f | --force] [--name ] [--reference ] [--ref-format ] [--depth ] [--] []`:: Add the given repository as a submodule at the given path to the changeset to be committed next to the current project: the current project is termed the "superproject". + - is the URL of the new submodule's origin repository. -This may be either an absolute URL, or (if it begins with ./ -or ../), the location relative to the superproject's default remote -repository (Please note that to specify a repository 'foo.git' -which is located right next to a superproject 'bar.git', you'll +__ is the URL of the new submodule's `origin` repository. +This may be either an absolute URL, or (if it begins with `./` +or `../`), the location relative to the superproject's default remote +repository (Please note that to specify a repository `foo.git` +which is located right next to a superproject `bar.git`, you'll have to use `../foo.git` instead of `./foo.git` - as one might expect when following the rules for relative URLs - because the evaluation of relative URLs in Git is identical to that of relative directories). + The default remote is the remote of the remote-tracking branch of the current branch. If no such remote-tracking branch exists or -the HEAD is detached, "origin" is assumed to be the default remote. +the `HEAD` is detached, `origin` is assumed to be the default remote. If the superproject doesn't have a default remote configured the superproject is its own authoritative upstream and the current working directory is used instead. + -The optional argument is the relative location for the cloned -submodule to exist in the superproject. If is not given, the -canonical part of the source repository is used ("repo" for -"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If +The optional argument __ is the relative location for the cloned +submodule to exist in the superproject. If __ is not given, the +canonical part of the source repository is used (`repo` for +`/path/to/repo.git` and `foo` for `host.xz:foo/.git`). If __ exists and is already a valid Git repository, then it is staged -for commit without cloning. The is also used as the submodule's -logical name in its configuration entries unless `--name` is used +for commit without cloning. The __ is also used as the submodule's +logical name in its configuration entries unless `--name ` is used to specify a logical name. + The given URL is recorded into `.gitmodules` for use by subsequent users @@ -75,10 +75,10 @@ URL in `.gitmodules`. If `--ref-format ` is specified, the ref storage format of newly cloned submodules will be set accordingly. -status [--cached] [--recursive] [--] [...]:: +`status [--cached] [--recursive] [--] [...]`:: Show the status of the submodules. This will print the SHA-1 of the currently checked out commit for each submodule, along with the - submodule path and the output of 'git describe' for the + submodule path and the output of linkgit:git-describe[1] for the SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is not initialized, `+` if the currently checked out submodule commit does not match the SHA-1 found in the index of the containing @@ -91,11 +91,11 @@ If `--recursive` is specified, this command will recurse into nested submodules, and show their status as well. + If you are only interested in changes of the currently initialized -submodules with respect to the commit recorded in the index or the HEAD, +submodules with respect to the commit recorded in the index or the `HEAD`, linkgit:git-status[1] and linkgit:git-diff[1] will provide that information too (and can also report changes to a submodule's work tree). -init [--] [...]:: +`init [--] [...]`:: Initialize the submodules recorded in the index (which were added and committed elsewhere) by setting `submodule.$name.url` in `.git/config`, using the same setting from `.gitmodules` as @@ -103,7 +103,7 @@ init [--] [...]:: the default remote. If there is no default remote, the current repository will be assumed to be upstream. + -Optional arguments limit which submodules will be initialized. +Optional __ arguments limit which submodules will be initialized. If no path is specified and submodule.active has been configured, submodules configured to be active will be initialized, otherwise all submodules are initialized. @@ -116,12 +116,12 @@ that is set to a custom command is *not* copied for security reasons. You can then customize the submodule clone URLs in `.git/config` for your local setup and proceed to `git submodule update`; you can also just use `git submodule update --init` without -the explicit 'init' step if you do not intend to customize +the explicit `init` step if you do not intend to customize any submodule locations. + See the add subcommand for the definition of default remote. -deinit [-f|--force] (--all|[--] ...):: +`deinit [-f | --force] (--all|[--] ...)`:: Unregister the given submodules, i.e. remove the whole `submodule.$name` section from .git/config together with their work tree. Further calls to `git submodule update`, `git submodule foreach` @@ -139,7 +139,7 @@ If you really want to remove a submodule from the repository and commit that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal options. -update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference ] [--ref-format ] [--depth ] [--recursive] [--jobs ] [--[no-]single-branch] [--filter ] [--] [...]:: +`update [--init] [--remote] [-N | --no-fetch] [--[no-]recommend-shallow] [-f | --force] [--checkout | --rebase | --merge] [--reference=] [--ref-format=] [--depth=] [--recursive] [--jobs ] [--[no-]single-branch] [--filter=] [--] [...]`:: + -- Update the registered submodules to match what the superproject @@ -148,38 +148,38 @@ in submodules and updating the working tree of the submodules. The "updating" can be done in several ways depending on command line options and the value of `submodule..update` configuration variable. The command line option takes precedence over -the configuration variable. If neither is given, a 'checkout' is performed. +the configuration variable. If neither is given, a `checkout` is performed. (note: what is in `.gitmodules` file is irrelevant at this point; see `git submodule init` above for how `.gitmodules` is used). -The 'update' procedures supported both from the command line as well as +The `update` procedures supported both from the command line as well as through the `submodule..update` configuration are: - checkout;; the commit recorded in the superproject will be - checked out in the submodule on a detached HEAD. +`checkout`;; the commit recorded in the superproject will be +checked out in the submodule on a detached `HEAD`. + If `--force` is specified, the submodule will be checked out (using `git checkout --force`), even if the commit specified in the index of the containing repository already matches the commit checked out in the submodule. - rebase;; the current branch of the submodule will be rebased - onto the commit recorded in the superproject. +`rebase`;; the current branch of the submodule will be rebased +onto the commit recorded in the superproject. - merge;; the commit recorded in the superproject will be merged - into the current branch in the submodule. +`merge`;; the commit recorded in the superproject will be merged +into the current branch in the submodule. The following update procedures have additional limitations: - custom command;; mechanism for running arbitrary commands with the - commit ID as an argument. Specifically, if the - `submodule..update` configuration variable is set to - `!custom command`, the object name of the commit recorded in the - superproject for the submodule is appended to the `custom command` - string and executed. Note that this mechanism is not supported in - the `.gitmodules` file or on the command line. +`!`;; mechanism for running arbitrary commands with the +commit ID as an argument. Specifically, if the +`submodule..update` configuration variable is set to +`!`, the object name of the commit recorded in the +superproject for the submodule is appended to the __ +string and executed. Note that this mechanism is not supported in +the `.gitmodules` file or on the command line. - none;; the submodule is not updated. This update procedure is not - allowed on the command line. +`none`;; the submodule is not updated. This update procedure is not +allowed on the command line. If the submodule is not yet initialized, and you just want to use the setting as stored in `.gitmodules`, you can automatically initialize the @@ -195,20 +195,20 @@ If `--filter ` is specified, the given partial clone filter will be applied to the submodule. See linkgit:git-rev-list[1] for details on filter specifications. -- -set-branch (-b|--branch) [--] :: -set-branch (-d|--default) [--] :: - Sets the default remote tracking branch for the submodule. The +`set-branch (-b|--branch) [--] `:: +`set-branch (-d|--default) [--] `:: + Set the default remote tracking branch for the submodule. The `--branch` option allows the remote branch to be specified. The - `--default` option removes the submodule..branch configuration - key, which causes the tracking branch to default to the remote 'HEAD'. + `--default` option removes the `submodule..branch` configuration + key, which causes the tracking branch to default to the remote `HEAD`. -set-url [--] :: - Sets the URL of the specified submodule to . Then, it will +`set-url [--] `:: + Set the URL of the specified submodule to __. Then, it will automatically synchronize the submodule's new remote URL configuration. -summary [--cached|--files] [(-n|--summary-limit) ] [commit] [--] [...]:: - Show commit summary between the given commit (defaults to HEAD) and +`summary [--cached | --files] [(-n|--summary-limit) ] [commit] [--] [...]`:: + Show commit summary between the given commit (defaults to `HEAD`) and working tree/index. For a submodule in question, a series of commits in the submodule between the given super project commit and the index or working tree (switched by `--cached`) are shown. If the option @@ -220,27 +220,31 @@ summary [--cached|--files] [(-n|--summary-limit) ] [commit] [--] [...]: Using the `--submodule=log` option with linkgit:git-diff[1] will provide that information too. -foreach [--recursive] :: - Evaluates an arbitrary shell command in each checked out submodule. - The command has access to the variables $name, $sm_path, $displaypath, - $sha1 and $toplevel: - $name is the name of the relevant submodule section in `.gitmodules`, - $sm_path is the path of the submodule as recorded in the immediate - superproject, $displaypath contains the relative path from the - current working directory to the submodules root directory, - $sha1 is the commit as recorded in the immediate - superproject, and $toplevel is the absolute path to the top-level - of the immediate superproject. - Note that to avoid conflicts with '$PATH' on Windows, the '$path' - variable is now a deprecated synonym of '$sm_path' variable. - Any submodules defined in the superproject but not checked out are - ignored by this command. Unless given `--quiet`, foreach prints the name - of each submodule before evaluating the command. - If `--recursive` is given, submodules are traversed recursively (i.e. - the given shell command is evaluated in nested submodules as well). - A non-zero return from the command in any submodule causes - the processing to terminate. This can be overridden by adding '|| :' - to the end of the command. +`foreach [--recursive] `:: + Evaluate an arbitrary shell __ in each checked out submodule. + The command has access to the variables `$name`, `$sm_path`, `$displaypath`, + `$sha1` and `$toplevel`: ++ +-- +`$name`;; the name of the relevant submodule section in `.gitmodules` +`$sm_path`;; the path of the submodule as recorded in the immediate + superproject +`$displaypath`;; the relative path from the + current working directory to the submodules root directory +`$sha1`;; the commit as recorded in the immediate superproject +`$toplevel`;; the absolute path to the top-level of the immediate superproject. +-- ++ +Note that to avoid conflicts with `$PATH` on Windows, the `$path` +variable is now a deprecated synonym of `$sm_path` variable. +Any submodules defined in the superproject but not checked out are +ignored by this command. Unless given `--quiet`, foreach prints the name +of each submodule before evaluating the command. +If `--recursive` is given, submodules are traversed recursively (i.e. +the given shell command is evaluated in nested submodules as well). +A non-zero return from the command in any submodule causes +the processing to terminate. This can be overridden by adding ++||:++ +to the end of the command. + As an example, the command below will show the path and currently checked out commit for each submodule: @@ -249,26 +253,26 @@ checked out commit for each submodule: git submodule foreach 'echo $sm_path `git rev-parse HEAD`' -------------- -sync [--recursive] [--] [...]:: - Synchronizes submodules' remote URL configuration setting +`sync [--recursive] [--] [...]`:: + Synchronize submodules' remote URL configuration setting to the value specified in `.gitmodules`. It will only affect those - submodules which already have a URL entry in .git/config (that is the + submodules which already have a URL entry in `.git/config` (that is the case when they are initialized or freshly added). This is useful when submodule URLs change upstream and you need to update your local repositories accordingly. + `git submodule sync` synchronizes all submodules while -`git submodule sync -- A` synchronizes submodule "A" only. +`git submodule sync -- A` synchronizes submodule `A` only. + If `--recursive` is specified, this command will recurse into the registered submodules, and sync any nested submodules within. -absorbgitdirs:: +`absorbgitdirs`:: If a git directory of a submodule is inside the submodule, move the git directory of the submodule into its superproject's `$GIT_DIR/modules` path and then connect the git directory and its working directory by setting the `core.worktree` and adding - a .git file pointing to the git directory embedded in the + a `.git` file pointing to the git directory embedded in the superprojects git directory. + A repository that was cloned independently and later added as a submodule or @@ -279,72 +283,70 @@ This command is recursive by default. OPTIONS ------- --q:: ---quiet:: +`-q`:: +`--quiet`:: Only print error messages. ---progress:: - This option is only valid for add and update commands. - Progress status is reported on the standard error stream - by default when it is attached to a terminal, unless -q +`--progress`:: + Report progress status on the standard error stream + by default when it is attached to a terminal, unless `-q` is specified. This flag forces progress status even if the - standard error stream is not directed to a terminal. + standard error stream is not directed to a terminal. It is + only valid for `add` and `update` commands. ---all:: - This option is only valid for the deinit command. Unregister all - submodules in the working tree. +`--all`:: + Unregister all submodules in the working tree. This option is only + valid for the `deinit` command. --b :: ---branch :: +`-b`:: +`--branch=`:: Branch of repository to add as submodule. The name of the branch is recorded as `submodule..branch` in `.gitmodules` for `update --remote`. A special value of `.` is used to indicate that the name of the branch in the submodule should be the same name as the current branch in the current repository. If the - option is not specified, it defaults to the remote 'HEAD'. - --f:: ---force:: - This option is only valid for add, deinit and update commands. - When running add, allow adding an otherwise ignored submodule path. - This option is also used to bypass a check that the submodule's name - is not already in use. By default, 'git submodule add' will fail if - the proposed name (which is derived from the path) is already registered - for another submodule in the repository. Using '--force' allows the command - to proceed by automatically generating a unique name by appending a number - to the conflicting name (e.g., if a submodule named 'child' exists, it will - try 'child1', and so on). - When running deinit the submodule working trees will be removed even - if they contain local changes. - When running update (only effective with the checkout procedure), - throw away local changes in submodules when switching to a - different commit; and always run a checkout operation in the - submodule, even if the commit listed in the index of the - containing repository matches the commit checked out in the - submodule. - ---cached:: - This option is only valid for status and summary commands. These - commands typically use the commit found in the submodule HEAD, but - with this option, the commit stored in the index is used instead. - ---files:: - This option is only valid for the summary command. This command - compares the commit in the index with that in the submodule HEAD - when this option is used. - --n:: ---summary-limit:: - This option is only valid for the summary command. - Limit the summary size (number of commits shown in total). + option is not specified, it defaults to the remote `HEAD`. + +`-f`:: +`--force`:: + Force the command to proceed, even if it would otherwise fail. + This option is only valid for `add`, `deinit` and `update` commands. +`add`;; allow adding an otherwise ignored submodule path. +This option is also used to bypass a check that the submodule's name +is not already in use. By default, `git submodule add` will fail if +the proposed name (which is derived from the path) is already registered +for another submodule in the repository. Using `--force` allows the command +to proceed by automatically generating a unique name by appending a number +to the conflicting name (e.g., if a submodule named 'child' exists, it will +try 'child1', and so on). +`deinit`;; the submodule working trees will be removed even +if they contain local changes. +`update`;; (only effective with the checkout procedure), +throw away local changes in submodules when switching to a +different commit; and always run a checkout operation in the +submodule, even if the commit listed in the index of the +containing repository matches the commit checked out in the +submodule. + +`--cached`:: + Use the index to determine the commit instead of the `HEAD`. + This option is only valid for `status` and `summary` commands. + +`--files`:: + Make the `summary` command compare the commit in the index with that in + the submodule `HEAD`. + +`-n`:: +`--summary-limit=`:: + Limit the `summary` size (number of commits shown in total) to __. Giving 0 will disable the summary; a negative number means unlimited (the default). This limit only applies to modified submodules. The size is always limited to 1 for added/deleted/typechanged submodules. ---remote:: - This option is only valid for the update command. Instead of using - the superproject's recorded SHA-1 to update the submodule, use the - status of the submodule's remote-tracking branch. The remote used +`--remote`:: + Instead of using the superproject's recorded SHA-1 to update the + submodule, use the status of the submodule's remote-tracking branch. + This option is only valid for the `update` command. The remote used is branch's remote (`branch..remote`), defaulting to `origin`. The remote branch used defaults to the remote `HEAD`, but the branch name may be overridden by setting the `submodule..branch` @@ -363,7 +365,7 @@ SHA-1. If you don't want to fetch, you should use `submodule update --remote --no-fetch`. + Use this option to integrate changes from the upstream subproject with -your submodule's current HEAD. Alternatively, you can run `git pull` +your submodule's current `HEAD`. Alternatively, you can run `git pull` from the submodule, which is equivalent except for the remote branch name: `update --remote` uses the default upstream repository and `submodule..branch`, while `git pull` uses the submodule's @@ -372,105 +374,106 @@ to distribute the default upstream branch with the superproject and `branch..merge` if you want a more native feel while working in the submodule itself. --N:: ---no-fetch:: - This option is only valid for the update command. +`-N`:: +`--no-fetch`:: Don't fetch new objects from the remote site. + This option is only valid for the `update` command. ---checkout:: - This option is only valid for the update command. - Checkout the commit recorded in the superproject on a detached HEAD - in the submodule. This is the default behavior, the main use of - this option is to override `submodule.$name.update` when set to +`--checkout`:: + Checkout the commit recorded in the superproject on a detached `HEAD` + in the submodule. This option is only valid for the `update` command. + This is the default behavior, the main use of + this option is to override `submodule..update` when set to a value other than `checkout`. - If the key `submodule.$name.update` is either not explicitly set or + If the key `submodule..update` is either not explicitly set or set to `checkout`, this option is implicit. ---merge:: - This option is only valid for the update command. +`--merge`:: Merge the commit recorded in the superproject into the current branch - of the submodule. If this option is given, the submodule's HEAD will + of the submodule. This option is only valid for the `update` command. + If this option is given, the submodule's `HEAD` will not be detached. If a merge failure prevents this process, you will have to resolve the resulting conflicts within the submodule with the usual conflict resolution tools. - If the key `submodule.$name.update` is set to `merge`, this option is + If the key `submodule..update` is set to `merge`, this option is implicit. ---rebase:: - This option is only valid for the update command. - Rebase the current branch onto the commit recorded in the - superproject. If this option is given, the submodule's HEAD will not +`--rebase`:: + Rebase the current branch onto the commit recorded in the superproject. + This option is only valid for the `update` command. The submodule's `HEAD` will not be detached. If a merge failure prevents this process, you will have to resolve these failures with linkgit:git-rebase[1]. - If the key `submodule.$name.update` is set to `rebase`, this option is + If the key `submodule..update` is set to `rebase`, this option is implicit. ---init:: - This option is only valid for the update command. - Initialize all submodules for which "git submodule init" has not been - called so far before updating. +`--init`:: + Initialize all submodules for which `git submodule init` has not been + called so far before updating. This option is only valid for the `update` + command. + ---name:: - This option is only valid for the add command. It sets the submodule's - name to the given string instead of defaulting to its path. The name - must be valid as a directory name and may not end with a '/'. +`--name=`:: + Set the submodule's name to the given string instead of defaulting to its path. __ + must be valid as a directory name and may not end with a `/`. ---reference :: - This option is only valid for add and update commands. These - commands sometimes need to clone a remote repository. In this case, +`--reference=`:: + Pass the local __ as a reference when cloning the submodule. + This option is only valid for `add` and `update` commands. + These commands sometimes need to clone a remote repository. In this case, this option will be passed to the linkgit:git-clone[1] command. + -*NOTE*: Do *not* use this option unless you have read the note +NOTE: Do *not* use this option unless you have read the note for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate` options carefully. ---dissociate:: - This option is only valid for add and update commands. These - commands sometimes need to clone a remote repository. In this case, +`--dissociate`:: + After using a reference repository to clone from, do not rely on it anymore. + This option is only valid for `add` and `update` commands. + These commands sometimes need to clone a remote repository. In this case, this option will be passed to the linkgit:git-clone[1] command. + -*NOTE*: see the NOTE for the `--reference` option. +NOTE: See the NOTE above for the `--reference` option. ---recursive:: - This option is only valid for foreach, update, status and sync commands. - Traverse submodules recursively. The operation is performed not +`--recursive`:: + Traverse submodules recursively. This option is only valid for `foreach`, + `update`, `status` and `sync` commands. The operation is performed not only in the submodules of the current repo, but also in any nested submodules inside those submodules (and so on). ---depth:: - This option is valid for add and update commands. Create a 'shallow' - clone with a history truncated to the specified number of revisions. - See linkgit:git-clone[1] +`--depth=`:: + Create a 'shallow' clone with a history truncated to the __ revisions. + This option is valid for `add` and `update` commands. See linkgit:git-clone[1] ---recommend-shallow:: ---no-recommend-shallow:: - This option is only valid for the update command. +`--recommend-shallow`:: +`--no-recommend-shallow`:: + Recommend or not shallow cloning of submodules. + This option is only valid for the `update` command. The initial clone of a submodule will use the recommended `submodule..shallow` as provided by the `.gitmodules` file by default. To ignore the suggestions use `--no-recommend-shallow`. --j :: ---jobs :: - This option is only valid for the update command. - Clone new submodules in parallel with as many jobs. +`-j`:: +`--jobs=`:: + Clone new submodules in parallel with __ jobs. + This option is only valid for the `update` command. Defaults to the `submodule.fetchJobs` option. ---single-branch:: ---no-single-branch:: - This option is only valid for the update command. - Clone only one branch during update: HEAD or one specified by --branch. +`--single-branch`:: +`--no-single-branch`:: + Clone only one branch during update: `HEAD` or one specified by `--branch`. + This option is only valid for the `update` command. -...:: +`...`:: Paths to submodule(s). When specified this will restrict the command to only operate on the submodules found at the specified paths. - (This argument is required with add). + (This argument is required with `add`). FILES ----- When initializing submodules, a `.gitmodules` file in the top-level directory -of the containing repository is used to find the url of each submodule. +of the containing repository is used to find the URL of each submodule. This file should be formatted in the same way as `$GIT_DIR/config`. The key -to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] +to each submodule URL is `submodule..url`. See linkgit:gitmodules[5] for details. SEE ALSO From 4f29c685348d767b335c00fe84d01ea6e7d20d38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Fri, 6 Feb 2026 04:12:24 +0000 Subject: [PATCH 03/15] doc: finalize git-clone documentation conversion to synopsis style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Use backticks where appropriate for command-line options Reviewed-by: Kristoffer Haugsbakk Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-clone.adoc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/git-clone.adoc b/Documentation/git-clone.adoc index 57cdfb7620571c..7a0e147384edfb 100644 --- a/Documentation/git-clone.adoc +++ b/Documentation/git-clone.adoc @@ -152,7 +152,7 @@ objects from the source repository into a pack in the cloned repository. unknown ones, is server-specific. When multiple `--server-option=