From ba62bfc4a47119194812fad9200d5fac5a5c15f2 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 16 Jan 2024 12:43:46 -0800 Subject: Autogenerated HTML docs for v2.43.0-367-g186b1 --- MyFirstContribution.html | 2 +- MyFirstObjectWalk.html | 2 +- RelNotes/2.44.0.txt | 9 +++++++++ ReviewingGuidelines.html | 2 +- SubmittingPatches.html | 2 +- ToolsForGit.html | 2 +- everyday.html | 2 +- git-clone.html | 17 ++++++++++++++++- git-clone.txt | 6 ++++++ git-config.html | 19 +++++++++++++++++++ git-init.html | 18 +++++++++++++++++- git-init.txt | 7 +++++++ git-rebase.html | 18 ++++++++++-------- git-rebase.txt | 17 ++++++++++------- git-remote-helpers.html | 2 +- git-rev-parse.html | 10 +++++++++- git-rev-parse.txt | 3 +++ git.html | 12 +++++++++++- git.txt | 5 +++++ gitrepository-layout.html | 5 +++++ howto/coordinate-embargoed-releases.html | 2 +- howto/keep-canonical-history-correct.html | 4 ++-- howto/maintain-git.html | 4 ++-- howto/new-command.html | 4 ++-- howto/rebase-from-internal-branch.html | 4 ++-- howto/rebuild-from-update-hook.html | 4 ++-- howto/recover-corrupted-blob-object.html | 4 ++-- howto/recover-corrupted-object-harder.html | 4 ++-- howto/revert-a-faulty-merge.html | 4 ++-- howto/revert-branch-rebase.html | 4 ++-- howto/separating-topic-branches.html | 4 ++-- howto/setup-git-server-over-http.html | 4 ++-- howto/update-hook-example.html | 4 ++-- howto/use-git-daemon.html | 4 ++-- howto/using-merge-subtree.html | 4 ++-- howto/using-signed-tag-in-pull-request.html | 4 ++-- ref-storage-format.txt | 1 + technical/api-error-handling.html | 2 +- technical/api-index.html | 2 +- technical/api-merge.html | 2 +- technical/api-parse-options.html | 2 +- technical/api-simple-ipc.html | 2 +- technical/api-trace2.html | 2 +- technical/bitmap-format.html | 2 +- technical/bundle-uri.html | 2 +- technical/hash-function-transition.html | 2 +- technical/long-running-process-protocol.html | 2 +- technical/multi-pack-index.html | 2 +- technical/pack-heuristics.html | 2 +- technical/parallel-checkout.html | 2 +- technical/partial-clone.html | 2 +- technical/racy-git.html | 2 +- technical/repository-version.txt | 5 +++++ technical/scalar.html | 2 +- technical/send-pack-pipeline.html | 2 +- technical/shallow.html | 2 +- technical/trivial-merge.html | 2 +- technical/unit-tests.html | 2 +- user-manual.html | 2 +- 59 files changed, 192 insertions(+), 78 deletions(-) create mode 100644 ref-storage-format.txt diff --git a/MyFirstContribution.html b/MyFirstContribution.html index a1bff1f21..92770e4ca 100644 --- a/MyFirstContribution.html +++ b/MyFirstContribution.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/MyFirstObjectWalk.html b/MyFirstObjectWalk.html index a6490133a..da4daa6f0 100644 --- a/MyFirstObjectWalk.html +++ b/MyFirstObjectWalk.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/RelNotes/2.44.0.txt b/RelNotes/2.44.0.txt index 020692cda..2b9d2bd3c 100644 --- a/RelNotes/2.44.0.txt +++ b/RelNotes/2.44.0.txt @@ -167,6 +167,12 @@ Fixes since v2.43 which has been corrected. (merge 556e68032f cp/git-flush-is-an-env-bool later to maint). + * Clearing in-core repository (happens during e.g., "git fetch + --recurse-submodules" with commit graph enabled) made in-core + commit object in an inconsistent state by discarding the necessary + data from commit-graph too early, which has been corrected. + (merge d70f554cdf jk/commit-graph-slab-clear-fix later to maint). + * Other code cleanup, docfix, build fix, etc. (merge 50f1abcff6 js/packfile-h-typofix later to maint). (merge cbf498eb53 jb/reflog-expire-delete-dry-run-options later to maint). @@ -195,3 +201,6 @@ Fixes since v2.43 (merge 54d8a2531b jk/t1006-cat-file-objectsize-disk later to maint). (merge 7033d5479b jx/sideband-chomp-newline-fix later to maint). (merge 9cd30af991 ms/rebase-insnformat-doc-fix later to maint). + (merge 03bcc93769 cp/sideband-array-index-comment-fix later to maint). + (merge 993d38a066 jk/index-pack-lsan-false-positive-fix later to maint). + (merge 25aec06326 ib/rebase-reschedule-doc later to maint). diff --git a/ReviewingGuidelines.html b/ReviewingGuidelines.html index 69784726b..67d5c0f23 100644 --- a/ReviewingGuidelines.html +++ b/ReviewingGuidelines.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/SubmittingPatches.html b/SubmittingPatches.html index e01b8d8e4..f5e246750 100644 --- a/SubmittingPatches.html +++ b/SubmittingPatches.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/ToolsForGit.html b/ToolsForGit.html index ea302ec32..57f89ea72 100644 --- a/ToolsForGit.html +++ b/ToolsForGit.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/everyday.html b/everyday.html index e3482b8aa..820918a99 100644 --- a/everyday.html +++ b/everyday.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/git-clone.html b/git-clone.html index 39b3f6c92..aa445fd7e 100644 --- a/git-clone.html +++ b/git-clone.html @@ -1213,6 +1213,21 @@ or --mirror is given)

+--ref-format=<ref-format +

+Specify the given ref storage format for the repository. The valid values are: +

+
+files for loose files with packed-refs. This is the default. +
+

-j <n>

@@ -1513,7 +1528,7 @@ clone.filterSubmodules diff --git a/git-clone.txt b/git-clone.txt index c37c4a37f..6e43eb9c2 100644 --- a/git-clone.txt +++ b/git-clone.txt @@ -311,6 +311,12 @@ or `--mirror` is given) The result is Git repository can be separated from working tree. +--ref-format=:: --jobs :: The number of submodules fetched at the same time. diff --git a/git-config.html b/git-config.html index bcf672fec..52235bea1 100644 --- a/git-config.html +++ b/git-config.html @@ -5394,6 +5394,25 @@ extensions.objectFormat work and will produce hard-to-diagnose issues.

+extensions.refStorage +

+ Specify the ref storage format to use. The acceptable values are: +

+
+files for loose files with packed-refs. This is the default. +
+
It is an error to specify this key unless core.repositoryFormatVersion is 1.
+
Note that this setting should only be set by git-init(1) or +git-clone(1). Trying to change it after initialization will not +work and will produce hard-to-diagnose issues.
+

extensions.worktreeConfig

diff --git a/git-init.html b/git-init.html index 976b0805c..3e528c442 100644 --- a/git-init.html +++ b/git-init.html @@ -751,6 +751,7 @@ git-init(1) Manual Page

git init [-q | --quiet] [--bare] [--template=<template-directory>]
           [--separate-git-dir <git-dir>] [--object-format=<format>]
+          [--ref-format=<format>]
           [-b <branch-name> | --initial-branch=<branch-name>]
           [--shared[=<permissions>]] [<directory>]

@@ -821,6 +822,21 @@ created with today’s Git will be usable by future versions of Git without data loss.

+--ref-format=<format> +

+Specify the given ref storage format for the repository. The valid values are: +

+
+files for loose files with packed-refs. This is the default. +
+

--template=<template-directory>

@@ -1038,7 +1054,7 @@ init.defaultBranch diff --git a/git-init.txt b/git-init.txt index 6f0d2973b..e8dc645bb 100644 --- a/git-init.txt +++ b/git-init.txt @@ -11,6 +11,7 @@ SYNOPSIS [verse] 'git init' [-q | --quiet] [--bare] [--template=] [--separate-git-dir ] [--object-format=] + [--ref-format=] [-b | --initial-branch=] [--shared[=]] [] @@ -57,6 +58,12 @@ values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default. + include::object-format-disclaimer.txt[] +--ref-format=:: + +Specify the given ref storage format for the repository. The valid values are: ++ +include::ref-storage-format.txt[] + --template=:: Specify the directory from which templates will be used. (See the "TEMPLATE diff --git a/git-rebase.html b/git-rebase.html index 5c262155c..067e046f5 100644 --- a/git-rebase.html +++ b/git-rebase.html @@ -1592,13 +1592,15 @@ option can be used to override that setting.

Automatically reschedule exec commands that failed. This only makes sense in interactive mode (or when an --exec option was provided).

Even though this option applies once a rebase is started, it’s set for -the whole rebase at the start based on either the -rebase.rescheduleFailedExec configuration (see git-config(1) -or "CONFIGURATION" below) or whether this option is -provided. Otherwise an explicit --no-reschedule-failed-exec at the -start would be overridden by the presence of -rebase.rescheduleFailedExec=true configuration.

This option applies once a rebase is started. It is preserved for the whole +rebase based on, in order, the command line option provided to the initial git +rebase, the rebase.rescheduleFailedExec configuration (see +git-config(1) or "CONFIGURATION" below), or it defaults to false.

Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit --no-reschedule-failed-exec at the start would be overridden by +the presence of a rebase.rescheduleFailedExec=true configuration when git +rebase --continue is invoked. Currently, you cannot pass +--[no-]reschedule-failed-exec to git rebase --continue.

--update-refs @@ -2809,7 +2811,7 @@ sequence.editor diff --git a/git-rebase.txt b/git-rebase.txt index 25516c45d..8a8d32161 100644 --- a/git-rebase.txt +++ b/git-rebase.txt @@ -626,13 +626,16 @@ See also INCOMPATIBLE OPTIONS below. Automatically reschedule `exec` commands that failed. This only makes sense in interactive mode (or when an `--exec` option was provided). + -Even though this option applies once a rebase is started, it's set for -the whole rebase at the start based on either the -`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1] -or "CONFIGURATION" below) or whether this option is -provided. Otherwise an explicit `--no-reschedule-failed-exec` at the -start would be overridden by the presence of -`rebase.rescheduleFailedExec=true` configuration. +This option applies once a rebase is started. It is preserved for the whole +rebase based on, in order, the command line option provided to the initial `git +rebase`, the `rebase.rescheduleFailedExec` configuration (see +linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false. ++ +Recording this option for the whole rebase is a convenience feature. Otherwise +an explicit `--no-reschedule-failed-exec` at the start would be overridden by +the presence of a `rebase.rescheduleFailedExec=true` configuration when `git +rebase --continue` is invoked. Currently, you cannot pass +`--[no-]reschedule-failed-exec` to `git rebase --continue`. --update-refs:: --no-update-refs:: diff --git a/git-remote-helpers.html b/git-remote-helpers.html index f79df78d0..2d6e19be8 100644 --- a/git-remote-helpers.html +++ b/git-remote-helpers.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/git-rev-parse.html b/git-rev-parse.html index 01238dcc4..2caa0f110 100644 --- a/git-rev-parse.html +++ b/git-rev-parse.html @@ -1270,6 +1270,14 @@ print a message to stderr and exit with nonzero status.

If not specified, the default is "storage".

+--show-ref-format +

+ Show the reference storage format used for the repository. +

@@ -2151,7 +2159,7 @@ Similar to above: diff --git a/git-rev-parse.txt b/git-rev-parse.txt index 912fab9f5..546faf901 100644 --- a/git-rev-parse.txt +++ b/git-rev-parse.txt @@ -307,6 +307,9 @@ The following options are unaffected by `--path-format`: input, multiple algorithms may be printed, space-separated. If not specified, the default is "storage". +--show-ref-format:: + Show the reference storage format used for the repository. + Other Options ~~~~~~~~~~~~~ diff --git a/git.html b/git.html index b21b81a06..1ef855040 100644 --- a/git.html +++ b/git.html @@ -3006,6 +3006,16 @@ double-quotes and respecting backslash escapes. E.g., the value See --object-format in git-init(1).

+GIT_DEFAULT_REF_FORMAT +

+ If this variable is set, the default reference backend format for new + repositories will be set to this value. The default is "files". + See --ref-format in git-init(1). +

@@ -3836,7 +3846,7 @@ the Git Security mailing list <

diff --git a/git.txt b/git.txt index 962887f19..da4e8d130 100644 --- a/git.txt +++ b/git.txt @@ -556,6 +556,11 @@ double-quotes and respecting backslash escapes. E.g., the value is always used. The default is "sha1". See `--object-format` in linkgit:git-init[1]. +`GIT_DEFAULT_REF_FORMAT`:: + If this variable is set, the default reference backend format for new + repositories will be set to this value. The default is "files". + See `--ref-format` in linkgit:git-init[1]. + Git Commits ~~~~~~~~~~~ `GIT_AUTHOR_NAME`:: diff --git a/gitrepository-layout.html b/gitrepository-layout.html index c387997d7..b4ff74b25 100644 --- a/gitrepository-layout.html +++ b/gitrepository-layout.html @@ -1347,6 +1347,11 @@ multiple working directory mode, "config" file is shared while "config.worktree" is per-working directory (i.e., it’s in GIT_COMMON_DIR/worktrees/<id>/config.worktree)

diff --git a/howto/coordinate-embargoed-releases.html b/howto/coordinate-embargoed-releases.html index 47c99846b..445ef316e 100644 --- a/howto/coordinate-embargoed-releases.html +++ b/howto/coordinate-embargoed-releases.html @@ -1038,7 +1038,7 @@ Thanks, diff --git a/howto/keep-canonical-history-correct.html b/howto/keep-canonical-history-correct.html index 6bc8a5551..f1e843456 100644 --- a/howto/keep-canonical-history-correct.html +++ b/howto/keep-canonical-history-correct.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -849,7 +849,7 @@ Please note that if the other project merges from you, then it will diff --git a/howto/using-signed-tag-in-pull-request.html b/howto/using-signed-tag-in-pull-request.html index f4c0276f1..2aa51a0b3 100644 --- a/howto/using-signed-tag-in-pull-request.html +++ b/howto/using-signed-tag-in-pull-request.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -953,7 +953,7 @@ as part of the merge commit.

diff --git a/ref-storage-format.txt b/ref-storage-format.txt new file mode 100644 index 000000000..1a65cac46 --- /dev/null +++ b/ref-storage-format.txt @@ -0,0 +1 @@ +* `files` for loose files with packed-refs. This is the default. diff --git a/technical/api-error-handling.html b/technical/api-error-handling.html index c13fa7727..a59c8f907 100644 --- a/technical/api-error-handling.html +++ b/technical/api-error-handling.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/repository-version.txt b/technical/repository-version.txt index 045a76756..27be3741e 100644 --- a/technical/repository-version.txt +++ b/technical/repository-version.txt @@ -100,3 +100,8 @@ If set, by default "git config" reads from both "config" and multiple working directory mode, "config" file is shared while "config.worktree" is per-working directory (i.e., it's in GIT_COMMON_DIR/worktrees//config.worktree) + +==== `refStorage` + +Specifies the file format for the ref database. The only valid value +is `files` (loose references with a packed-refs file). diff --git a/technical/scalar.html b/technical/scalar.html index da3d9ff22..93accd336 100644 --- a/technical/scalar.html +++ b/technical/scalar.html @@ -735,7 +735,7 @@ asciidoc.install();

Introduction
1. Repositories and Branches

Introduction

Git is a fast distributed revision control system.

This manual is designed to be readable by someone with basic UNIX +Git User Manual

Git User Manual

Revision History
	2024-01-16

Table of Contents

Introduction

1. Repositories and Branches

How to get a Git repository

How to check out a different version of a project

Understanding History: Commits

Understanding history: commits, parents, and reachability
Understanding history: History diagrams
Understanding history: What is a branch?

Manipulating branches

Examining an old version without creating a new branch

Examining branches from a remote repository

Naming branches, tags, and other references

Updating a repository with git fetch

Fetching branches from other repositories

2. Exploring Git history

How to use bisect to find a regression

Naming commits

Creating tags

Browsing revisions

Generating diffs

Viewing old file versions

Examples

Counting the number of commits on a branch
Check whether two branches point at the same history
Find first tagged version including a given fix
Showing commits unique to a given branch
Creating a changelog and tarball for a software release
Finding commits referencing a file with given content

3. Developing with Git

Telling Git your name

Creating a new repository

How to make a commit

Creating good commit messages

Ignoring files

How to merge

Resolving a merge

Getting conflict-resolution help during a merge

Undoing a merge

Fast-forward merges

Fixing mistakes

Fixing a mistake with a new commit
Fixing a mistake by rewriting history
Checking out an old version of a file
Temporarily setting aside work in progress

Ensuring good performance

Ensuring reliability

Checking the repository for corruption
Recovering lost changes

4. Sharing development with others

Getting updates with git pull

Submitting patches to a project

Importing patches to a project

Public Git repositories

Setting up a public repository
Exporting a Git repository via the Git protocol
Exporting a git repository via HTTP
Pushing changes to a public repository
What to do when a push fails
Setting up a shared repository
Allowing web browsing of a repository

How to get a Git repository with minimal history

Examples

Maintaining topic branches for a Linux subsystem maintainer

5. Rewriting history and maintaining patch series

Creating the perfect patch series
Keeping a patch series up to date using git rebase
Rewriting a single commit
Reordering or selecting from a patch series
Using interactive rebases
Other tools
Problems with rewriting history
Why bisecting merge commits can be harder than bisecting linear history

6. Advanced branch management

Fetching individual branches
git fetch and fast-forwards
Forcing git fetch to do non-fast-forward updates
Configuring remote-tracking branches

7. Git concepts

The Object Database

Commit Object
Tree Object
Blob Object
Trust
Tag Object
How Git stores objects efficiently: pack files
Dangling objects
Recovering from repository corruption

The index

8. Submodules

Pitfalls with submodules

9. Low-level Git operations

Object access and manipulation

The Workflow

working directory → index
index → object database
object database → index
index → working directory
Tying it all together

Examining the data

Merging multiple trees

Merging multiple trees, continued

10. Hacking Git

Object storage format
A birds-eye view of Git’s source code

11. Git Glossary

Git explained

A. Git Quick Reference

Creating a new repository
Managing branches
Exploring history
Making changes
Merging
Sharing your changes
Repository maintenance

B. Notes and todo list for this manual

Todo list

Introduction

Git is a fast distributed revision control system.

This manual is designed to be readable by someone with basic UNIX command-line skills, but no previous knowledge of Git.

Chapter 1, Repositories and Branches and Chapter 2, Exploring Git history explain how to fetch and study a project using git—read these chapters to learn how to build and test a particular version of a software project, search for -- cgit 1.2.3-korg

My First Contribution to the Git Project

My First Object Walk

Reviewing Patches in the Git Project

Submitting Patches

Tools for developing Git

Everyday Git With 20 Commands Or So

git-remote-helpers

refStorage

Keep authoritative canonical history correct with git pull

How to maintain Git

How to integrate new subcommands

How to rebase from an internal branch

How to rebuild from update hook

How to recover a corrupted blob object

How to recover an object from scratch

How to revert a faulty merge

How to revert an existing commit

How to separate topic branches

How to setup Git server over http

How to use the update hook

How to use git-daemon

How to use the subtree merge strategy

How to use a signed tag in pull requests

Error reporting in git

Git API Documents

merge API

parse-options API

Simple-IPC API

Trace2 API

GIT bitmap v1 format

Bundle URIs

Git hash function transition

Long-running process protocol

Multi-Pack-Index (MIDX) Design Notes

Concerning Git’s Packing Heuristics

Parallel Checkout Design Notes

Partial Clone Design Notes

Use of index and Racy Git problem

Scalar

Git-send-pack internals

Shallow commits

Trivial merge rules

Unit Testing

Git User Manual

Introduction

Git User Manual

Introduction

`refStorage`