From 12ad45db5647123fe798d29da165617003b8b0dd Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 26 Jul 2023 14:29:48 -0700 Subject: Autogenerated HTML docs for v2.41.0-459-gb4fce --- MyFirstContribution.html | 2 +- MyFirstObjectWalk.html | 2 +- RelNotes/2.42.0.txt | 3 +++ ReviewingGuidelines.html | 2 +- SubmittingPatches.html | 2 +- ToolsForGit.html | 2 +- everyday.html | 2 +- git-remote-helpers.html | 2 +- gitignore.html | 10 +++++----- gitignore.txt | 8 ++++---- 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 ++-- 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/scalar.html | 2 +- technical/send-pack-pipeline.html | 2 +- technical/shallow.html | 2 +- technical/trivial-merge.html | 2 +- user-manual.html | 2 +- 46 files changed, 70 insertions(+), 67 deletions(-) diff --git a/MyFirstContribution.html b/MyFirstContribution.html index f3e504121..8a4ccb3c7 100644 --- a/MyFirstContribution.html +++ b/MyFirstContribution.html @@ -735,7 +735,7 @@ asciidoc.install();

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

diff --git a/RelNotes/2.42.0.txt b/RelNotes/2.42.0.txt index 2430cd2d1..a5e924b6c 100644 --- a/RelNotes/2.42.0.txt +++ b/RelNotes/2.42.0.txt @@ -234,3 +234,6 @@ Fixes since v2.41 (merge 6e6a529b57 jk/fsck-indices-in-worktrees later to maint). (merge 3e81b896f7 rs/packet-length-simplify later to maint). (merge 4c9cb51fe7 mh/doc-credential-helpers later to maint). + (merge 3437f549dd jr/gitignore-doc-example-markup later to maint). + (merge 947ebd62a0 jc/am-parseopt-fix later to maint). + (merge e12cb98e1e jc/branch-parseopt-fix later to maint). diff --git a/ReviewingGuidelines.html b/ReviewingGuidelines.html index 2d1c4176f..8bc8d0036 100644 --- a/ReviewingGuidelines.html +++ b/ReviewingGuidelines.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/SubmittingPatches.html b/SubmittingPatches.html index 6d280410d..98a5768a8 100644 --- a/SubmittingPatches.html +++ b/SubmittingPatches.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/ToolsForGit.html b/ToolsForGit.html index 618282eda..208fa47a6 100644 --- a/ToolsForGit.html +++ b/ToolsForGit.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/everyday.html b/everyday.html index 54cf33303..78b496997 100644 --- a/everyday.html +++ b/everyday.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/git-remote-helpers.html b/git-remote-helpers.html index 5ca54788c..6d24ef847 100644 --- a/git-remote-helpers.html +++ b/git-remote-helpers.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/gitignore.html b/gitignore.html index 731f7c825..4079b6bba 100644 --- a/gitignore.html +++ b/gitignore.html @@ -995,10 +995,10 @@ The pattern doc/frotz and /doc/frotz have the same eff

-The pattern "foo/*", matches "foo/test.json" - (a regular file), "foo/bar" (a directory), but it does not match - "foo/bar/hello.c" (a regular file), as the asterisk in the - pattern does not match "bar/hello.c" which has a slash in it. +The pattern foo/*, matches foo/test.json + (a regular file), foo/bar (a directory), but it does not match + foo/bar/hello.c (a regular file), as the asterisk in the + pattern does not match bar/hello.c which has a slash in it.

@@ -1073,7 +1073,7 @@ everything within foo/bar):

diff --git a/gitignore.txt b/gitignore.txt index 4c17f2356..810041acd 100644 --- a/gitignore.txt +++ b/gitignore.txt @@ -174,10 +174,10 @@ EXAMPLES is not relevant if there is already a middle slash in the pattern. - - The pattern "foo/*", matches "foo/test.json" - (a regular file), "foo/bar" (a directory), but it does not match - "foo/bar/hello.c" (a regular file), as the asterisk in the - pattern does not match "bar/hello.c" which has a slash in it. + - The pattern `foo/*`, matches `foo/test.json` + (a regular file), `foo/bar` (a directory), but it does not match + `foo/bar/hello.c` (a regular file), as the asterisk in the + pattern does not match `bar/hello.c` which has a slash in it. -------------------------------------------------------------- $ git status diff --git a/howto/coordinate-embargoed-releases.html b/howto/coordinate-embargoed-releases.html index 7956754b4..5d03def2c 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 e51abfdb9..7dc2141f8 100644 --- a/howto/keep-canonical-history-correct.html +++ b/howto/keep-canonical-history-correct.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -939,7 +939,7 @@ tip of your master again and redo the two merges:

diff --git a/howto/maintain-git.html b/howto/maintain-git.html index a41a3e19c..b7fb2df47 100644 --- a/howto/maintain-git.html +++ b/howto/maintain-git.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -1479,7 +1479,7 @@ $ git update-ref -d $mf/ai/topic diff --git a/howto/new-command.html b/howto/new-command.html index 3ffd03d30..911db4df0 100644 --- a/howto/new-command.html +++ b/howto/new-command.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -864,7 +864,7 @@ letter [PATCH 0/n]. diff --git a/howto/rebase-from-internal-branch.html b/howto/rebase-from-internal-branch.html index 6d09b65e6..80a6c2a06 100644 --- a/howto/rebase-from-internal-branch.html +++ b/howto/rebase-from-internal-branch.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -896,7 +896,7 @@ the #1' commit.

diff --git a/howto/rebuild-from-update-hook.html b/howto/rebuild-from-update-hook.html index 1d950bfda..ba1cf4bcf 100644 --- a/howto/rebuild-from-update-hook.html +++ b/howto/rebuild-from-update-hook.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -848,7 +848,7 @@ This is still crude and does not protect against simultaneous diff --git a/howto/recover-corrupted-blob-object.html b/howto/recover-corrupted-blob-object.html index d0b5e9fc7..6343dd199 100644 --- a/howto/recover-corrupted-blob-object.html +++ b/howto/recover-corrupted-blob-object.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -881,7 +881,7 @@ thing.

diff --git a/howto/recover-corrupted-object-harder.html b/howto/recover-corrupted-object-harder.html index 5a524c30a..6b8a576f4 100644 --- a/howto/recover-corrupted-object-harder.html +++ b/howto/recover-corrupted-object-harder.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -1190,7 +1190,7 @@ int main(int argc, char **argv) diff --git a/howto/revert-a-faulty-merge.html b/howto/revert-a-faulty-merge.html index 2ef629b87..a9a0481ef 100644 --- a/howto/revert-a-faulty-merge.html +++ b/howto/revert-a-faulty-merge.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -1026,7 +1026,7 @@ P---o---o---M---x---x---W---x---M2 diff --git a/howto/revert-branch-rebase.html b/howto/revert-branch-rebase.html index d38d804f7..1ec1bc41a 100644 --- a/howto/revert-branch-rebase.html +++ b/howto/revert-branch-rebase.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -908,7 +908,7 @@ Committed merge 7fb9b7262a1d1e0a47bbfdcbbcf50ce0635d3f8f diff --git a/howto/separating-topic-branches.html b/howto/separating-topic-branches.html index 5e0277b6f..7469e3ecb 100644 --- a/howto/separating-topic-branches.html +++ b/howto/separating-topic-branches.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -842,7 +842,7 @@ o---o"master" diff --git a/howto/setup-git-server-over-http.html b/howto/setup-git-server-over-http.html index 61b49c8fe..58df80d31 100644 --- a/howto/setup-git-server-over-http.html +++ b/howto/setup-git-server-over-http.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -1072,7 +1072,7 @@ help diagnosing the problem, but removes security checks.

diff --git a/howto/update-hook-example.html b/howto/update-hook-example.html index 40f2c761c..48c4afccb 100644 --- a/howto/update-hook-example.html +++ b/howto/update-hook-example.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -931,7 +931,7 @@ that JC can make non-fast-forward pushes on it.

diff --git a/howto/use-git-daemon.html b/howto/use-git-daemon.html index c3b43d492..eb2e97ee3 100644 --- a/howto/use-git-daemon.html +++ b/howto/use-git-daemon.html @@ -735,7 +735,7 @@ asciidoc.install();

@@ -792,7 +792,7 @@ a good practice to put the paths after a "--" separator.

diff --git a/howto/using-merge-subtree.html b/howto/using-merge-subtree.html index e5a37e992..5602c5fb7 100644 --- a/howto/using-merge-subtree.html +++ b/howto/using-merge-subtree.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 8fb56f346..d56d664df 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/technical/api-error-handling.html b/technical/api-error-handling.html index b0af3c14f..dae29b351 100644 --- a/technical/api-error-handling.html +++ b/technical/api-error-handling.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/api-index.html b/technical/api-index.html index 3ed208878..57417b8c0 100644 --- a/technical/api-index.html +++ b/technical/api-index.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/api-merge.html b/technical/api-merge.html index ca0b81568..4f7127b25 100644 --- a/technical/api-merge.html +++ b/technical/api-merge.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/api-parse-options.html b/technical/api-parse-options.html index a71d6b2c4..898497d10 100644 --- a/technical/api-parse-options.html +++ b/technical/api-parse-options.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/api-simple-ipc.html b/technical/api-simple-ipc.html index 13877b05f..5c37f76ef 100644 --- a/technical/api-simple-ipc.html +++ b/technical/api-simple-ipc.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/api-trace2.html b/technical/api-trace2.html index 6134c0137..c1773058f 100644 --- a/technical/api-trace2.html +++ b/technical/api-trace2.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/bitmap-format.html b/technical/bitmap-format.html index ec35a0b30..b5ab2ed23 100644 --- a/technical/bitmap-format.html +++ b/technical/bitmap-format.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/bundle-uri.html b/technical/bundle-uri.html index 5395b4719..264eb928d 100644 --- a/technical/bundle-uri.html +++ b/technical/bundle-uri.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/hash-function-transition.html b/technical/hash-function-transition.html index 104e0e766..f402b1bf9 100644 --- a/technical/hash-function-transition.html +++ b/technical/hash-function-transition.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/long-running-process-protocol.html b/technical/long-running-process-protocol.html index 2e031a3cf..a896cdf88 100644 --- a/technical/long-running-process-protocol.html +++ b/technical/long-running-process-protocol.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/multi-pack-index.html b/technical/multi-pack-index.html index 2b3cd7257..bbe007a21 100644 --- a/technical/multi-pack-index.html +++ b/technical/multi-pack-index.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/pack-heuristics.html b/technical/pack-heuristics.html index 6fcb10289..c4495bf20 100644 --- a/technical/pack-heuristics.html +++ b/technical/pack-heuristics.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/parallel-checkout.html b/technical/parallel-checkout.html index 8dbe24246..08e68c524 100644 --- a/technical/parallel-checkout.html +++ b/technical/parallel-checkout.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/partial-clone.html b/technical/partial-clone.html index 74ffae249..17391e5d2 100644 --- a/technical/partial-clone.html +++ b/technical/partial-clone.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/racy-git.html b/technical/racy-git.html index d6c7a6d9d..f8dd2f7df 100644 --- a/technical/racy-git.html +++ b/technical/racy-git.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/scalar.html b/technical/scalar.html index 99789dcef..232e57335 100644 --- a/technical/scalar.html +++ b/technical/scalar.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/send-pack-pipeline.html b/technical/send-pack-pipeline.html index b4cceb8dc..dc94c1660 100644 --- a/technical/send-pack-pipeline.html +++ b/technical/send-pack-pipeline.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/shallow.html b/technical/shallow.html index c577d165a..37e2d3959 100644 --- a/technical/shallow.html +++ b/technical/shallow.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/technical/trivial-merge.html b/technical/trivial-merge.html index f9b7d8a4b..754e6ffc5 100644 --- a/technical/trivial-merge.html +++ b/technical/trivial-merge.html @@ -735,7 +735,7 @@ asciidoc.install();

diff --git a/user-manual.html b/user-manual.html index 5383a5ef4..235fc72c6 100644 --- a/user-manual.html +++ b/user-manual.html @@ -1,5 +1,5 @@ -Git User Manual

Git User Manual

Revision History
	2023-07-25

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 +Git User Manual

Git User Manual

Revision History
	2023-07-26

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

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

Git User Manual

Introduction

Git User Manual

Introduction