From: Junio C Hamano Date: Wed, 14 Feb 2007 07:23:58 +0000 (+0000) Subject: Autogenerated HTML docs for v1.5.0-19-gddff X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=053827fc208a615853d69ff66269e9c1600b7fa0;p=git.git Autogenerated HTML docs for v1.5.0-19-gddff --- diff --git a/RelNotes-1.5.0.txt b/RelNotes-1.5.0.txt index 84e7eaf3c..f0120e1f5 100644 --- a/RelNotes-1.5.0.txt +++ b/RelNotes-1.5.0.txt @@ -94,8 +94,8 @@ Updates in v1.5.0 since v1.4.4 series entries for selected paths. - git-update-index is much less visible. Many suggestions to - use the command in git output and documentation have now been - replaced by simpler commands such as "git add" or "git rm". + use the command in git output and documentation have now been + replaced by simpler commands such as "git add" or "git rm". * Repository layout and objects transfer @@ -291,12 +291,10 @@ Updates in v1.5.0 since v1.4.4 series reset" to jump to arbitrary commit, while still keeping your HEAD detached. - Going back to attached state (i.e. on a particular branch) by - "git checkout $branch" can lose the current stat you arrived - in these ways, and "git checkout" refuses when the detached - HEAD is not pointed by any existing ref (an existing branch, - a remote tracking branch or a tag). This safety can be - overridden with "git checkout -f $branch". + Remember that a detached state is volatile, i.e. it will be forgotten + as soon as you move away from it with the checkout or reset command, + unless a branch is created from it as mentioned above. It is also + possible to rescue a lost detached state from the HEAD reflog. * Packed refs @@ -411,14 +409,14 @@ Updates in v1.5.0 since v1.4.4 series * Foreign SCM interfaces - - git-svn now requires the Perl SVN:: libraries, the - command-line backend was too slow and limited. + - git-svn now requires the Perl SVN:: libraries, the + command-line backend was too slow and limited. - - the 'commit' subcommand of git-svn has been renamed to - 'set-tree', and 'dcommit' is the recommended replacement for - day-to-day work. + - the 'commit' subcommand of git-svn has been renamed to + 'set-tree', and 'dcommit' is the recommended replacement for + day-to-day work. - - git fast-import backend. + - git fast-import backend. * User support diff --git a/cmds-ancillarymanipulators.txt b/cmds-ancillarymanipulators.txt index b7b42861f..56d388ef7 100644 --- a/cmds-ancillarymanipulators.txt +++ b/cmds-ancillarymanipulators.txt @@ -2,7 +2,7 @@ gitlink:git-convert-objects[1]:: Converts old-style git repository. gitlink:git-fast-import[1]:: - Backend for fast Git data importers.. + Backend for fast Git data importers. gitlink:git-lost-found[1]:: Recover lost refs that luckily have not yet been pruned. @@ -25,3 +25,6 @@ gitlink:git-repack[1]:: gitlink:git-config[1]:: Get and set repository or global options. +gitlink:git-remote[1]:: + manage set of tracked repositories. + diff --git a/cmds-mainporcelain.txt b/cmds-mainporcelain.txt index 9a59c0305..49922e672 100644 --- a/cmds-mainporcelain.txt +++ b/cmds-mainporcelain.txt @@ -73,9 +73,6 @@ gitlink:git-rebase[1]:: gitlink:git-reset[1]:: Reset current HEAD to the specified state. -gitlink:git-resolve[1]:: - Merge two commits. - gitlink:git-revert[1]:: Revert an existing commit. diff --git a/cmds-plumbinginterrogators.txt b/cmds-plumbinginterrogators.txt index ad2256358..5c083ed6b 100644 --- a/cmds-plumbinginterrogators.txt +++ b/cmds-plumbinginterrogators.txt @@ -7,9 +7,6 @@ gitlink:git-diff-files[1]:: gitlink:git-diff-index[1]:: Compares content and mode of blobs between the index and repository. -gitlink:git-diff-stages[1]:: - Compares two merge stages in the index. - gitlink:git-diff-tree[1]:: Compares the content and mode of blobs found via two tree objects. diff --git a/core-intro.txt b/core-intro.txt index abafefc71..24b060b91 100644 --- a/core-intro.txt +++ b/core-intro.txt @@ -587,4 +587,5 @@ stages to temporary files and calls a "merge" script on it: git-merge-index git-merge-one-file hello.c -and that is what higher level `git resolve` is implemented with. +and that is what higher level `git merge -s resolve` is implemented +with. diff --git a/core-tutorial.html b/core-tutorial.html index c8ccee785..1edab71f1 100644 --- a/core-tutorial.html +++ b/core-tutorial.html @@ -1192,7 +1192,7 @@ see more complex cases.

Now, let's pretend you are the one who did all the work in mybranch, and the fruit of your hard work has finally been merged to the master branch. Let's go back to mybranch, and run -resolve to get the "upstream changes" back to your branch.

+git merge to get the "upstream changes" back to your branch.

$ git checkout mybranch
@@ -1209,7 +1209,7 @@ Fast forward
  2 files changed, 2 insertions(+), 0 deletions(-)

Because your branch did not contain anything more than what are -already merged into the master branch, the resolve operation did +already merged into the master branch, the merge operation did not actually do a merge. Instead, it just updated the top of the tree of your branch to that of the master branch. This is often called fast forward merge.

@@ -1325,10 +1325,10 @@ usefulness when git Native and SSH transports were introduced, and not used by git pull or git push scripts.

-

Once you fetch from the remote repository, you resolve that +

Once you fetch from the remote repository, you merge that with your current branch.

However — it's such a common thing to fetch and then -immediately resolve, that it's called git pull, and you can +immediately merge, that it's called git pull, and you can simply do

@@ -1969,7 +1969,7 @@ to follow, not easier.

diff --git a/core-tutorial.txt b/core-tutorial.txt index 9c28bea62..97cdb90cb 100644 --- a/core-tutorial.txt +++ b/core-tutorial.txt @@ -977,7 +977,7 @@ see more complex cases. Now, let's pretend you are the one who did all the work in `mybranch`, and the fruit of your hard work has finally been merged to the `master` branch. Let's go back to `mybranch`, and run -resolve to get the "upstream changes" back to your branch. +`git merge` to get the "upstream changes" back to your branch. ------------ $ git checkout mybranch @@ -996,7 +996,7 @@ Fast forward ---------------- Because your branch did not contain anything more than what are -already merged into the `master` branch, the resolve operation did +already merged into the `master` branch, the merge operation did not actually do a merge. Instead, it just updated the top of the tree of your branch to that of the `master` branch. This is often called 'fast forward' merge. @@ -1099,11 +1099,11 @@ programs, which are 'commit walkers'; they outlived their usefulness when git Native and SSH transports were introduced, and not used by `git pull` or `git push` scripts. -Once you fetch from the remote repository, you `resolve` that +Once you fetch from the remote repository, you `merge` that with your current branch. However -- it's such a common thing to `fetch` and then -immediately `resolve`, that it's called `git pull`, and you can +immediately `merge`, that it's called `git pull`, and you can simply do ---------------- diff --git a/diffcore.html b/diffcore.html index 8914ec3a4..a13131fa0 100644 --- a/diffcore.html +++ b/diffcore.html @@ -264,8 +264,8 @@ div.exampleblock-content {

Introduction

-

The diff commands git-diff-index, git-diff-files, git-diff-tree, and -git-diff-stages can be told to manipulate differences they find in +

The diff commands git-diff-index, git-diff-files, and git-diff-tree +can be told to manipulate differences they find in unconventional ways before showing diff(1) output. The manipulation is collectively called "diffcore transformation". This short note describes what they are and how to use them to produce diff outputs @@ -295,12 +295,6 @@ git-diff-files compares contents of the index file and the git-diff-tree compares contents of two "tree" objects;

-
  • -

    -git-diff-stages compares contents of blobs at two stages in an - unmerged index file. -

    -

    • In all of these cases, the commands themselves compare corresponding paths in the two sets of files. The result of @@ -547,7 +541,7 @@ t

    diff --git a/diffcore.txt b/diffcore.txt index cb4e56200..34cd306bb 100644 --- a/diffcore.txt +++ b/diffcore.txt @@ -6,8 +6,8 @@ June 2005 Introduction ------------ -The diff commands git-diff-index, git-diff-files, git-diff-tree, and -git-diff-stages can be told to manipulate differences they find in +The diff commands git-diff-index, git-diff-files, and git-diff-tree +can be told to manipulate differences they find in unconventional ways before showing diff(1) output. The manipulation is collectively called "diffcore transformation". This short note describes what they are and how to use them to produce diff outputs @@ -30,9 +30,6 @@ files: - git-diff-tree compares contents of two "tree" objects; - - git-diff-stages compares contents of blobs at two stages in an - unmerged index file. - In all of these cases, the commands themselves compare corresponding paths in the two sets of files. The result of comparison is passed from these commands to what is internally diff --git a/git-diff-stages.txt b/git-diff-stages.txt deleted file mode 100644 index b8f45b8cd..000000000 --- a/git-diff-stages.txt +++ /dev/null @@ -1,42 +0,0 @@ -git-diff-stages(1) -================== - -NAME ----- -git-diff-stages - Compares two merge stages in the index - - -SYNOPSIS --------- -'git-diff-stages' [] [...] - -DESCRIPTION ------------ -DEPRECATED and will be removed in 1.5.1. - -Compares the content and mode of the blobs in two stages in an -unmerged index file. - -OPTIONS -------- -include::diff-options.txt[] - -,:: - The stage number to be compared. - -Output format -------------- -include::diff-format.txt[] - - -Author ------- -Written by Junio C Hamano - -Documentation --------------- -Documentation by Junio C Hamano. - -GIT ---- -Part of the gitlink:git[7] suite diff --git a/git-fast-import.html b/git-fast-import.html index 49d812717..5d50a332d 100644 --- a/git-fast-import.html +++ b/git-fast-import.html @@ -266,7 +266,7 @@ git-fast-import(1) Manual Page

    NAME

    git-fast-import - - Backend for fast Git data importers. + Backend for fast Git data importers

    @@ -1188,7 +1188,7 @@ memory footprint (less than 2.7 MiB per active branch).

    diff --git a/git-fast-import.txt b/git-fast-import.txt index 445f6b854..77a14bb07 100644 --- a/git-fast-import.txt +++ b/git-fast-import.txt @@ -3,7 +3,7 @@ git-fast-import(1) NAME ---- -git-fast-import - Backend for fast Git data importers. +git-fast-import - Backend for fast Git data importers SYNOPSIS diff --git a/git-resolve.txt b/git-resolve.txt deleted file mode 100644 index 7fde665fb..000000000 --- a/git-resolve.txt +++ /dev/null @@ -1,38 +0,0 @@ -git-resolve(1) -============== - -NAME ----- -git-resolve - Merge two commits - - -SYNOPSIS --------- -'git-resolve' - -DESCRIPTION ------------ -DEPRECATED and will be removed in 1.5.1. Use `git-merge` instead. - -Given two commits and a merge message, merge the commit -into commit, with the commit log message . - -When is a descendant of , or is an -ancestor of , no new commit is created and the -is ignored. The former is informally called "already up to -date", and the latter is often called "fast forward". - - -Author ------- -Written by Linus Torvalds and -Dan Holmsand . - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the gitlink:git[7] suite - diff --git a/git-rev-list.html b/git-rev-list.html index 0849a239f..b484d4a53 100644 --- a/git-rev-list.html +++ b/git-rev-list.html @@ -291,6 +291,7 @@ git-rev-list(1) Manual Page [ --pretty | --header ] [ --bisect ] [ --merge ] + [ --reverse ] [ --walk-reflogs ] <commit>… [ -- <paths>… ] @@ -752,6 +753,14 @@ one.

    are still ordered in the commit timestamp order.

    +
    +--reverse +
    +
    +

    + Output the commits in reverse order. +

    +

    Object Traversal

    These options are mostly targeted for packing of git repositories.

    @@ -805,7 +814,7 @@ and the git-list <git@vger.kernel.org>.

    diff --git a/git-rev-list.txt b/git-rev-list.txt index c74211759..4f145eaba 100644 --- a/git-rev-list.txt +++ b/git-rev-list.txt @@ -27,6 +27,7 @@ SYNOPSIS [ \--pretty | \--header ] [ \--bisect ] [ \--merge ] + [ \--reverse ] [ \--walk-reflogs ] ... [ \-- ... ] @@ -266,6 +267,10 @@ By default, the commits are shown in reverse chronological order. parent comes before all of its children, but otherwise things are still ordered in the commit timestamp order. +--reverse:: + + Output the commits in reverse order. + Object Traversal ~~~~~~~~~~~~~~~~ diff --git a/git.html b/git.html index 03fdd110f..c64f507d5 100644 --- a/git.html +++ b/git.html @@ -573,14 +573,6 @@ ancillary user utilities.

    -git-resolve(1) -
    -
    -

    - Merge two commits. -

    -
    -
    git-revert(1)
    @@ -645,7 +637,7 @@ ancillary user utilities.

    - Backend for fast Git data importers.. + Backend for fast Git data importers.

    @@ -704,6 +696,14 @@ ancillary user utilities.

    Get and set repository or global options.

    +
    +git-remote(1) +
    +
    +

    + manage set of tracked repositories. +

    +

    Interrogators:

    @@ -1098,14 +1098,6 @@ repositories.

    -git-diff-stages(1) -
    -
    -

    - Compares two merge stages in the index. -

    -
    -
    git-diff-tree(1)
    @@ -2257,7 +2249,8 @@ stages to temporary files and calls a "merge" script on it:

    git-merge-index git-merge-one-file hello.c
    -

    and that is what higher level git resolve is implemented with.

    +

    and that is what higher level git merge -s resolve is implemented +with.

    Authors

    @@ -2296,7 +2289,7 @@ contributors on the git-list <git@vger.kernel.org>.

    diff --git a/git.txt b/git.txt index c0fa0d4b1..3d8be5931 100644 --- a/git.txt +++ b/git.txt @@ -35,6 +35,10 @@ ifdef::stalenotes[] You are reading the documentation for the latest version of git. Documentation for older releases are available here: +* link:v1.5.0/git.html[documentation for release 1.5.0] + +* link:v1.5.0/RelNotes-1.5.0.txt[release notes for 1.5.0] + * link:v1.4.4.4/git.html[documentation for release 1.4.4.4] * link:v1.3.3/git.html[documentation for release 1.3.3] diff --git a/howto-index.html b/howto-index.html index 6196e8587..a0caa2201 100644 --- a/howto-index.html +++ b/howto-index.html @@ -375,7 +375,7 @@ as a Linux subsystem maintainer.

    diff --git a/howto/revert-branch-rebase.html b/howto/revert-branch-rebase.html index ae699d601..d8c28f631 100644 --- a/howto/revert-branch-rebase.html +++ b/howto/revert-branch-rebase.html @@ -331,7 +331,7 @@ Fortunately I did not have to; what I have in the current branch 
    $ git checkout master
-$ git resolve master revert-c99 fast ;# this should be a fast forward
+$ git merge revert-c99 ;# this should be a fast forward
 Updating from 10d781b9caa4f71495c7b34963bef137216f86a8 to e3a693c...
  cache.h        |    8 ++++----
  commit.c       |    2 +-
@@ -340,12 +340,6 @@ Updating from 10d781b9caa4f71495c7b34963bef137216f86a8 to e3a693c...
  server-info.c  |    2 +-
  5 files changed, 8 insertions(+), 8 deletions(-)
    -

    The fast in the above git resolve is not a magic. I knew this -resolve would result in a fast forward merge, and if not, there is -something very wrong (so I would do git reset on the master branch -and examine the situation). When a fast forward merge is done, the -message parameter to git resolve is discarded, because no new commit -is created. You could have said junk or nothing there as well.

    There is no need to redo the test at this point. We fast forwarded and we know master matches revert-c99 exactly. In fact:

    @@ -440,7 +434,7 @@ Committed merge 7fb9b7262a1d1e0a47bbfdcbbcf50ce0635d3f8f
    diff --git a/howto/revert-branch-rebase.txt b/howto/revert-branch-rebase.txt index d10476b56..d88ec23a9 100644 --- a/howto/revert-branch-rebase.txt +++ b/howto/revert-branch-rebase.txt @@ -85,7 +85,7 @@ Fortunately I did not have to; what I have in the current branch ------------------------------------------------ $ git checkout master -$ git resolve master revert-c99 fast ;# this should be a fast forward +$ git merge revert-c99 ;# this should be a fast forward Updating from 10d781b9caa4f71495c7b34963bef137216f86a8 to e3a693c... cache.h | 8 ++++---- commit.c | 2 +- @@ -95,13 +95,6 @@ Updating from 10d781b9caa4f71495c7b34963bef137216f86a8 to e3a693c... 5 files changed, 8 insertions(+), 8 deletions(-) ------------------------------------------------ -The 'fast' in the above 'git resolve' is not a magic. I knew this -'resolve' would result in a fast forward merge, and if not, there is -something very wrong (so I would do 'git reset' on the 'master' branch -and examine the situation). When a fast forward merge is done, the -message parameter to 'git resolve' is discarded, because no new commit -is created. You could have said 'junk' or 'nothing' there as well. - There is no need to redo the test at this point. We fast forwarded and we know 'master' matches 'revert-c99' exactly. In fact: diff --git a/user-manual.html b/user-manual.html index 6d59d179d..2a8863daa 100644 --- a/user-manual.html +++ b/user-manual.html @@ -1,17 +1,17 @@ -Git User's Manual

    Git User's Manual

    Table of Contents

    Preface
    1. Git Quick Start
    Creating a new repository
    Managing branches
    Exploring history
    Making changes
    Merging
    Sharing your changes
    Repository maintenance
    2. 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 branches from a remote repository
    Naming branches, tags, and other references
    Updating a repository with git fetch
    Fetching branches from other repositories
    3. Exploring git history
    How to use bisect to find a regression
    Naming commits
    Creating tags
    Browsing revisions
    Generating diffs
    Viewing old file versions
    Examples
    Check whether two branches point at the same history
    Find first tagged version including a given fix
    4. Developing with git
    Telling git your name
    Creating a new repository
    how to make a commit
    creating good commit messages
    how to merge
    Resolving a merge
    undoing a merge
    Fast-forward merges
    Fixing mistakes
    Fixing a mistake with a new commit
    Fixing a mistake by editing history
    Checking out an old version of a file
    Ensuring good performance
    Ensuring reliability
    Checking the repository for corruption
    Recovering lost changes
    5. Sharing development with others
    Getting updates with git pull
    Submitting patches to a project
    Importing patches to a project
    Setting up a public repository
    Exporting a git repository via http
    Exporting a git repository via the git protocol
    Pushing changes to a public repository
    Setting up a shared repository
    Allow web browsing of a repository
    Examples
    6. Rewriting history and maintaining patch series
    Creating the perfect patch series
    Keeping a patch series up to date using git-rebase
    Reordering or selecting from a patch series
    Other tools
    Problems with rewriting history
    7. Advanced branch management
    Fetching individual branches
    Understanding git history: fast-forwards
    Forcing git fetch to do non-fast-forward updates
    Configuring remote branches
    8. Git internals
    The Object Database
    Blob Object
    Tree Object
    Commit Object
    Trust
    Tag Object
    The "index" aka "Current Directory Cache"
    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
    How git stores objects efficiently: pack files
    Dangling objects
    9. Glossary of git terms
    10. Notes and todo list for this manual

    Preface

    This manual is designed to be readable by someone with basic unix +Git User's Manual

    Git User's Manual

    Table of Contents

    Preface
    1. Git Quick Start
    Creating a new repository
    Managing branches
    Exploring history
    Making changes
    Merging
    Sharing your changes
    Repository maintenance
    2. 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 branches from a remote repository
    Naming branches, tags, and other references
    Updating a repository with git fetch
    Fetching branches from other repositories
    3. Exploring git history
    How to use bisect to find a regression
    Naming commits
    Creating tags
    Browsing revisions
    Generating diffs
    Viewing old file versions
    Examples
    Check whether two branches point at the same history
    Find first tagged version including a given fix
    4. Developing with git
    Telling git your name
    Creating a new repository
    how to make a commit
    creating good commit messages
    how to merge
    Resolving a merge
    undoing a merge
    Fast-forward merges
    Fixing mistakes
    Fixing a mistake with a new commit
    Fixing a mistake by editing history
    Checking out an old version of a file
    Ensuring good performance
    Ensuring reliability
    Checking the repository for corruption
    Recovering lost changes
    5. Sharing development with others
    Getting updates with git pull
    Submitting patches to a project
    Importing patches to a project
    Setting up a public repository
    Exporting a git repository via http
    Exporting a git repository via the git protocol
    Pushing changes to a public repository
    Setting up a shared repository
    Allow web browsing of a repository
    Examples
    6. Rewriting history and maintaining patch series
    Creating the perfect patch series
    Keeping a patch series up to date using git-rebase
    Reordering or selecting from a patch series
    Other tools
    Problems with rewriting history
    7. Advanced branch management
    Fetching individual branches
    Understanding git history: fast-forwards
    Forcing git fetch to do non-fast-forward updates
    Configuring remote branches
    8. Git internals
    The Object Database
    Blob Object
    Tree Object
    Commit Object
    Trust
    Tag Object
    The "index" aka "Current Directory Cache"
    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
    How git stores objects efficiently: pack files
    Dangling objects
    9. Glossary of git terms
    10. Notes and todo list for this manual

    Preface

    This manual is designed to be readable by someone with basic unix commandline skills, but no previous knowledge of git.

    Chapter 1 gives a brief overview of git commands, without any explanation; you may prefer to skip to chapter 2 on a first reading.

    Chapters 2 and 3 explain how to fetch and study a project using git—the tools you'd need to build and test a particular version of a software project, to search for regressions, and so on.

    Chapter 4 explains how to do development with git, and chapter 5 how to share that development with others.

    Further chapters cover more specialized topics.

    Comprehensive reference documentation is available through the man -pages. For a command such as "git clone", just use

    $ man git-clone

    Chapter 1. Git Quick Start

    Table of Contents

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

    This is a quick summary of the major commands; the following chapters -will explain how these work in more detail.

    Creating a new repository

    From a tarball:

    $ tar xzf project.tar.gz
    +pages. For a command such as "git clone", just use

    $ man git-clone

    Chapter 1. Git Quick Start

    Table of Contents

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

    This is a quick summary of the major commands; the following chapters +will explain how these work in more detail.

    Creating a new repository

    From a tarball:

    $ tar xzf project.tar.gz
    $ cd project
    $ git init
    Initialized empty Git repository in .git/
    $ git add .
    $ git commit

    From a remote repository:

    $ git clone git://example.com/pub/project.git
    -$ cd project

    Managing branches

    $ git branch         # list all branches in this repo
    +$ cd project

    Managing branches

    $ git branch         # list all branches in this repo
    $ git checkout test  # switch working directory to branch "test"
    $ git branch new     # create branch "new" starting at current HEAD
    $ git branch -d new  # delete branch "new"

    Instead of basing new branch on current HEAD (the default), use:

    $ git branch new test    # branch named "test"
    @@ -35,7 +35,7 @@ $   Tracked remote branches
        master next ...
    $ git fetch example             # update branches from example
    -$ git branch -r                 # list all remote branches

    Exploring history

    $ gitk                      # visualize and browse history
    +$ git branch -r                 # list all remote branches

    Exploring history

    $ gitk                      # visualize and browse history
    $ git log                   # list all commits
    $ git log src/              # ...modifying src/
    $ git log v2.6.15..v2.6.16  # ...in v2.6.16, not in v2.6.15
    @@ -57,7 +57,7 @@ Bisecting:                                 # test here, then:
    $ git bisect good               # if this revision is good, or
    $ git bisect bad                # if this revision is bad.
    -                                # repeat until done.

    Making changes

    Make sure git knows who to blame:

    $ cat >~/.gitconfig <<\EOF
    +                                # repeat until done.

    Making changes

    Make sure git knows who to blame:

    $ cat >~/.gitconfig <<\EOF
    [user]
    name = Your Name Comes Here
    email = you@yourdomain.example.com
    @@ -66,16 +66,16 @@ commit:

    $ $ git add b.txt    # new file
    $ git rm c.txt     # old file
    $ git commit

    Or, prepare and create the commit in one step:

    $ git commit d.txt # use latest content only of d.txt
    -$ git commit -a    # use latest content of all tracked files

    Merging

    $ git merge test   # merge branch "test" into the current branch
    +$ git commit -a    # use latest content of all tracked files

    Merging

    $ git merge test   # merge branch "test" into the current branch
    $ git pull git://example.com/project.git master
                       # fetch and merge in remote branch
    -$ git pull . test  # equivalent to git merge test

    Sharing your changes

    Importing or exporting patches:

    $ git format-patch origin..HEAD # format a patch for each commit
    +$ git pull . test  # equivalent to git merge test

    Sharing your changes

    Importing or exporting patches:

    $ git format-patch origin..HEAD # format a patch for each commit
                                    # in HEAD but not in origin
    $ git-am mbox # import patches from the mailbox "mbox"

    Fetch a branch in a different git repository, then merge into the current branch:

    $ git pull git://example.com/project.git theirbranch

    Store the fetched branch into a local branch before merging into the current branch:

    $ git pull git://example.com/project.git theirbranch:mybranch

    After creating commits on a local branch, update the remote branch with your commits:

    $ git push ssh://example.com/project.git mybranch:theirbranch

    When remote and local branch are both named "test":

    $ git push ssh://example.com/project.git test

    Shortcut version for a frequently used remote repository:

    $ git remote add example ssh://example.com/project.git
    -$ git push example test

    Repository maintenance

    Check for corruption:

    $ git fsck

    Recompress, remove unused cruft:

    $ git gc

    Chapter 2. Repositories and Branches

    Table of Contents

    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 branches from a remote repository
    Naming branches, tags, and other references
    Updating a repository with git fetch
    Fetching branches from other repositories

    How to get a git repository

    It will be useful to have a git repository to experiment with as you +$ git push example test

    Repository maintenance

    Check for corruption:

    $ git fsck

    Recompress, remove unused cruft:

    $ git gc

    Chapter 2. Repositories and Branches

    Table of Contents

    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 branches from a remote repository
    Naming branches, tags, and other references
    Updating a repository with git fetch
    Fetching branches from other repositories

    How to get a git repository

    It will be useful to have a git repository to experiment with as you read this manual.

    The best way to get one is by using the git-clone(1) command to download a copy of an existing repository for a project that you are interested in. If you don't already have a project in mind, here @@ -88,7 +88,7 @@ will only need to clone once.

    The clone command creates a new directory na directory, you will see that it contains a copy of the project files, together with a special top-level directory named ".git", which contains all the information about the history of the project.

    In most of the following, examples will be taken from one of the two -repositories above.

    How to check out a different version of a project

    Git is best thought of as a tool for storing the history of a +repositories above.

    How to check out a different version of a project

    Git is best thought of as a tool for storing the history of a collection of files. It stores the history as a compressed collection of interrelated snapshots (versions) of the project's contents.

    A single git repository may contain multiple branches. Each branch @@ -118,7 +118,7 @@ branches, with an asterisk marking the currently checked-out branch:

    $ git reset --hard v2.6.17

    Note that if the current branch was your only reference to a particular point in history, then resetting that branch may leave you with no way to find the history it used to point to; so use this -command carefully.

    Understanding History: Commits

    Every change in the history of a project is represented by a commit. +command carefully.

    Understanding History: Commits

    Every change in the history of a project is represented by a commit. The git-show(1) command shows the most recent commit on the current branch:

    $ git show
    commit 2b5f6dcce5bf94b9b119e9ed8d537098ec61c3d2
    @@ -155,7 +155,7 @@ importantly, it is a globally unique name for this commit: so if you tell somebody else the object name (for example in email), then you are guaranteed that name will refer to the same commit in their repository that it does in yours (assuming their repository has that commit at -all).

    Understanding history: commits, parents, and reachability

    Every commit (except the very first commit in a project) also has a +all).

    Understanding history: commits, parents, and reachability

    Every commit (except the very first commit in a project) also has a parent commit which shows what happened before this commit. Following the chain of parents will eventually take you back to the beginning of the project.

    However, the commits do not form a simple list; git allows lines of @@ -168,13 +168,13 @@ command; running gitk now on a git repository and looking for merge commits will help understand how the git organizes history.

    In the following, we say that commit X is "reachable" from commit Y if commit X is an ancestor of commit Y. Equivalently, you could say that Y is a descendent of X, or that there is a chain of parents -leading from commit Y to commit X.

    Understanding history: History diagrams

    We will sometimes represent git history using diagrams like the one +leading from commit Y to commit X.

    Understanding history: History diagrams

    We will sometimes represent git history using diagrams like the one below. Commits are shown as "o", and the links between them with lines drawn with - / and \. Time goes left to right:

            o--o--o <-- Branch A
        /
 o--o--o <-- master
                 o--o--o <-- Branch B

    If we need to talk about a particular commit, the character "o" may -be replaced with another letter or number.

    Understanding history: What is a branch?

    Though we've been using the word "branch" to mean a kind of reference +be replaced with another letter or number.

    Understanding history: What is a branch?

    Though we've been using the word "branch" to mean a kind of reference to a particular commit, the word branch is also commonly used to refer to the line of commits leading up to that point. In the example above, git may think of the branch named "A" as just a @@ -223,7 +223,7 @@ git checkout -b <new> <start-point> create a new branch <new> referencing <start-point>, and check it out.

    It is also useful to know that the special symbol "HEAD" can always -be used to refer to the current branch.

    Examining branches from a remote repository

    The "master" branch that was created at the time you cloned is a copy +be used to refer to the current branch.

    Examining branches from a remote repository

    The "master" branch that was created at the time you cloned is a copy of the HEAD in the repository that you cloned from. That repository may also have had other branches, though, and your local repository keeps branches which track each of those remote branches, which you @@ -259,7 +259,7 @@ repository, creating new commits and advancing the branches to point at the new commits.

    The command "git fetch", with no arguments, will update all of the remote-tracking branches to the latest version found in her repository. It will not touch any of your own branches—not even the -"master" branch that was created for you on clone.

    Fetching branches from other repositories

    You can also track branches from repositories other than the one you +"master" branch that was created for you on clone.

    Fetching branches from other repositories

    You can also track branches from repositories other than the one you cloned from, using git-remote(1):

    $ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
    $ git fetch
    * refs/remotes/linux-nfs/master: storing branch 'master' ...
    @@ -276,12 +276,12 @@ a new stanza:

    $ ...

    This is what causes git to track the remote's branches; you may modify or delete these configuration options by editing .git/config with a text editor. (See the "CONFIGURATION FILE" section of -git-config(1) for details.)

    Chapter 3. Exploring git history

    Table of Contents

    How to use bisect to find a regression
    Naming commits
    Creating tags
    Browsing revisions
    Generating diffs
    Viewing old file versions
    Examples
    Check whether two branches point at the same history
    Find first tagged version including a given fix

    Git is best thought of as a tool for storing the history of a +git-config(1) for details.)

    Chapter 3. Exploring git history

    Table of Contents

    How to use bisect to find a regression
    Naming commits
    Creating tags
    Browsing revisions
    Generating diffs
    Viewing old file versions
    Examples
    Check whether two branches point at the same history
    Find first tagged version including a given fix

    Git is best thought of as a tool for storing the history of a collection of files. It does this by storing compressed snapshots of the contents of a file heirarchy, together with "commits" which show the relationships between these snapshots.

    Git provides extremely flexible and fast tools for exploring the history of a project.

    We start with one specialized tool that is useful for finding the -commit that introduced a bug into a project.

    How to use bisect to find a regression

    Suppose version 2.6.18 of your project worked, but the version at +commit that introduced a bug into a project.

    How to use bisect to find a regression

    Suppose version 2.6.18 of your project worked, but the version at "master" crashes. Sometimes the best way to find the cause of such a regression is to perform a brute-force search through the project's history to find the particular commit that caused the problem. The @@ -309,7 +309,7 @@ occasionally you may land on a commit that broke something unrelated; run

    $ git bisect-visualize

    which will run gitk and label the commit it chose with a marker that says "bisect". Chose a safe-looking commit nearby, note its commit id, and check it out with:

    $ git reset --hard fb47ddb2db...

    then test, run "bisect good" or "bisect bad" as appropriate, and -continue.

    Naming commits

    We have seen several ways of naming commits already:

    • +continue.

    Naming commits

    We have seen several ways of naming commits already:

    • 40-hexdigit object name
    • branch name: refers to the commit at the head of the given @@ -339,11 +339,11 @@ which refers to the other branch that we're merging in to the current branch.

      The git-rev-parse(1) command is a low-level command that is occasionally useful for translating some name for a commit to the object name for that commit:

      $ git rev-parse origin
      -e05db0fd4f31dde7005f075a84f96b360d05984b

    Creating tags

    We can also create a tag to refer to a particular commit; after +e05db0fd4f31dde7005f075a84f96b360d05984b

    Creating tags

    We can also create a tag to refer to a particular commit; after running

    $ git-tag stable-1 1b2e1d63ff

    You can use stable-1 to refer to the commit 1b2e1d63ff.

    This creates a "lightweight" tag. If the tag is a tag you wish to share with others, and possibly sign cryptographically, then you should create a tag object instead; see the git-tag(1) man -page for details.

    Browsing revisions

    The git-log(1) command can show lists of commits. On its +page for details.

    Browsing revisions

    The git-log(1) command can show lists of commits. On its own, it shows all commits reachable from the parent commit; but you can also make more specific requests:

    $ git log v2.5..        # commits since (not reachable from) v2.5
    $ git log test..master  # commits reachable from master but not test
    @@ -359,15 +359,15 @@ commits since v2.5 which touch the Makefile or any file under fs:

    Note that git log starts with the most recent commit and works backwards through the parents; however, since git history can contain multiple independent lines of development, the particular order that -commits are listed in may be somewhat arbitrary.

    Generating diffs

    You can generate diffs between any two versions using +commits are listed in may be somewhat arbitrary.

    Generating diffs

    You can generate diffs between any two versions using git-diff(1):

    $ git diff master..test

    Sometimes what you want instead is a set of patches:

    $ git format-patch master..test

    will generate a file with a patch for each commit reachable from test but not from master. Note that if master also has commits which are not reachable from test, then the combined result of these patches -will not be the same as the diff produced by the git-diff example.

    Viewing old file versions

    You can always view an old version of a file by just checking out the +will not be the same as the diff produced by the git-diff example.

    Viewing old file versions

    You can always view an old version of a file by just checking out the correct revision first. But sometimes it is more convenient to be able to view an old version of a single file without checking anything out; this command does that:

    $ git show v2.5:fs/locks.c

    Before the colon may be anything that names a commit, and after it -may be any path to a file tracked by git.

    Examples

    Check whether two branches point at the same history

    Suppose you want to check whether two branches point at the same point +may be any path to a file tracked by git.

    Examples

    Check whether two branches point at the same history

    Suppose you want to check whether two branches point at the same point in history.

    $ git diff origin..master

    will tell you whether the contents of the project are the same at the two branches; in theory, however, it's possible that the same project contents could have been arrived at by two different historical @@ -376,7 +376,7 @@ e05db0fd4f31dde7005f075a84f96b360d05984b
    $ git rev-list master
    e05db0fd4f31dde7005f075a84f96b360d05984b

    Or you could recall that the … operator selects all commits contained reachable from either one reference or the other but not -both: so

    $ git log origin...master

    will return no commits when the two branches are equal.

    Find first tagged version including a given fix

    Suppose you know that the commit e05db0fd fixed a certain problem. +both: so

    $ git log origin...master

    will return no commits when the two branches are equal.

    Find first tagged version including a given fix

    Suppose you know that the commit e05db0fd fixed a certain problem. You'd like to find the earliest tagged release that contains that fix.

    Of course, there may be more than one answer—if the history branched after commit e05db0fd, then there could be multiple "earliest" tagged @@ -403,13 +403,13 @@ available
       ! [v1.5.0-rc2] GIT v1.5.0-rc2
    ...

    then search for a line that looks like

    + ++ [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
    available

    Which shows that e05db0fd is reachable from itself, from v1.5.0-rc1, and -from v1.5.0-rc2, but not from v1.5.0-rc0.

    Chapter 4. Developing with git

    Table of Contents

    Telling git your name
    Creating a new repository
    how to make a commit
    creating good commit messages
    how to merge
    Resolving a merge
    undoing a merge
    Fast-forward merges
    Fixing mistakes
    Fixing a mistake with a new commit
    Fixing a mistake by editing history
    Checking out an old version of a file
    Ensuring good performance
    Ensuring reliability
    Checking the repository for corruption
    Recovering lost changes

    Telling git your name

    Before creating any commits, you should introduce yourself to git. The +from v1.5.0-rc2, but not from v1.5.0-rc0.

    Chapter 4. Developing with git

    Table of Contents

    Telling git your name
    Creating a new repository
    how to make a commit
    creating good commit messages
    how to merge
    Resolving a merge
    undoing a merge
    Fast-forward merges
    Fixing mistakes
    Fixing a mistake with a new commit
    Fixing a mistake by editing history
    Checking out an old version of a file
    Ensuring good performance
    Ensuring reliability
    Checking the repository for corruption
    Recovering lost changes

    Telling git your name

    Before creating any commits, you should introduce yourself to git. The easiest way to do so is:

    $ cat >~/.gitconfig <<\EOF
    [user]
            name = Your Name Comes Here
            email = you@yourdomain.example.com
    EOF

    (See the "CONFIGURATION FILE" section of git-config(1) for -details on the configuration file.)

    Creating a new repository

    Creating a new repository from scratch is very easy:

    $ mkdir project
    +details on the configuration file.)

    Creating a new repository

    Creating a new repository from scratch is very easy:

    $ mkdir project
    $ cd project
    $ git init

    If you have some initial content (say, a tarball):

    $ tar -xzvf project.tar.gz
    $ cd project
    @@ -440,12 +440,12 @@ about to commit:

    $ $ git diff          # difference between the index file and your
                        # working directory; changes that would not
                        # be included if you ran "commit" now.
    -$ git status        # a brief per-file summary of the above.

    creating good commit messages

    Though not required, it's a good idea to begin the commit message +$ git status        # a brief per-file summary of the above.

    creating good commit messages

    Though not required, it's a good idea to begin the commit message with a single short (less than 50 character) line summarizing the change, followed by a blank line and then a more thorough description. Tools that turn commits into email, for example, use the first line on the Subject line and the rest of the commit in the -body.

    how to merge

    You can rejoin two diverging branches of development using +body.

    how to merge

    You can rejoin two diverging branches of development using git-merge(1):

    $ git merge branchname

    merges the development in the branch "branchname" into the current branch. If there are conflicts—for example, if the same file is modified in two different ways in the remote branch and the local @@ -511,7 +511,7 @@ your own if desired.

    $ git reset --hard HEAD

    Or, if you've already commited the merge that you want to throw away,

    $ git reset --hard HEAD^

    However, this last command can be dangerous in some cases—never throw away a commit you have already committed if that commit may itself have been merged into another branch, as doing so may confuse -further merges.

    Fast-forward merges

    There is one special case not mentioned above, which is treated +further merges.

    Fast-forward merges

    There is one special case not mentioned above, which is treated differently. Normally, a merge results in a merge commit, with two parents, one pointing at each of the two lines of development that were merged.

    However, if one of the two lines of development is completely @@ -519,7 +519,7 @@ contained within the other—so every commit present in the one is already contained in the other—then git just performs a fast forward; the head of the current branch is moved forward to point at the head of the merged-in branch, without -any new commits being created.

    Fixing mistakes

    If you've messed up the working tree, but haven't yet committed your +any new commits being created.

    Fixing mistakes

    If you've messed up the working tree, but haven't yet committed your mistake, you can return the entire working tree to the last committed state with

    $ git reset --hard HEAD

    If you make a commit that you later wish you hadn't, there are two fundamentally different ways to fix the problem:

    1. @@ -532,13 +532,13 @@ You can go back and modify the old commit. You should git does not normally expect the "history" of a project to change, and cannot correctly perform repeated merges from a branch that has had its history changed. -

    Fixing a mistake with a new commit

    Creating a new commit that reverts an earlier change is very easy; +

    Fixing a mistake with a new commit

    Creating a new commit that reverts an earlier change is very easy; just pass the git-revert(1) command a reference to the bad commit; for example, to revert the most recent commit:

    $ git revert HEAD

    This will create a new commit which undoes the change in HEAD. You will be given a chance to edit the commit message for the new commit.

    You can also revert an earlier change, for example, the next-to-last:

    $ git revert HEAD^

    In this case git will attempt to undo the old change while leaving intact any changes made since then. If more recent changes overlap with the changes to be reverted, then you will be asked to fix -conflicts manually, just as in the case of resolving a merge.

    Fixing a mistake by editing history

    If the problematic commit is the most recent commit, and you have not +conflicts manually, just as in the case of resolving a merge.

    Fixing a mistake by editing history

    If the problematic commit is the most recent commit, and you have not yet made that commit public, then you may just destroy it using git-reset.

    Alternatively, you can edit the working directory and update the index to fix your @@ -547,17 +547,17 @@ changes, giving you a chance to edit the old commit message first.

    Again, been merged into another branch; use git-revert(1) instead in that case.

    It is also possible to edit commits further back in the history, but this is an advanced topic to be left for -another chapter.

    Checking out an old version of a file

    In the process of undoing a previous bad change, you may find it +another chapter.

    Checking out an old version of a file

    In the process of undoing a previous bad change, you may find it useful to check out an older version of a particular file using git-checkout(1). We've used git checkout before to switch branches, but it has quite different behavior if it is given a path name: the command

    $ git checkout HEAD^ path/to/file

    replaces path/to/file by the contents it had in the commit HEAD^, and also updates the index to match. It does not change branches.

    If you just want to look at an old version of the file, without modifying the working directory, you can do that with -git-show(1):

    $ git show HEAD^ path/to/file

    which will display the given version of the file.

    Ensuring good performance

    On large repositories, git depends on compression to keep the history +git-show(1):

    $ git show HEAD^ path/to/file

    which will display the given version of the file.

    Ensuring good performance

    On large repositories, git depends on compression to keep the history information from taking up to much space on disk or in memory.

    This compression is not performed automatically. Therefore you should occasionally run git-gc(1):

    $ git gc

    to recompress the archive. This can be very time-consuming, so -you may prefer to run git-gc when you are not doing other work.

    Ensuring reliability

    Checking the repository for corruption

    The git-fsck(1) command runs a number of self-consistency checks +you may prefer to run git-gc when you are not doing other work.

    Ensuring reliability

    Checking the repository for corruption

    The git-fsck(1) command runs a number of self-consistency checks on the repository, and reports on any problems. This may take some time. The most common warning by far is about "dangling" objects:

    $ git fsck
    dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
    @@ -572,7 +572,7 @@ dangling you can remove them at any time with git-prune(1) or the —prune option to git-gc(1):

    $ git gc --prune

    This may be time-consuming. Unlike most other git operations (including git-gc when run without any options), it is not safe to prune while -other git operations are in progress in the same repository.

    For more about dangling objects, see the section called “Dangling objects”.

    Recovering lost changes

    Reflogs

    Say you modify a branch with git-reset(1) —hard, and then +other git operations are in progress in the same repository.

    For more about dangling objects, see the section called “Dangling objects”.

    Recovering lost changes

    Reflogs

    Say you modify a branch with git-reset(1) —hard, and then realize that the branch was the only reference you had to that point in history.

    Fortunately, git also keeps a log, called a "reflog", of all the previous values of each branch. So in this case you can still find the @@ -587,7 +587,7 @@ how to control this pruning, and see the "SPECIFYING REVISIONS" section of git-rev-parse(1) for details.

    Note that the reflog history is very different from normal git history. While normal history is shared by every repository that works on the same project, the reflog history is not shared: it tells you only about -how the branches in your local repository have changed over time.

    Examining dangling objects

    In some situations the reflog may not be able to save you. For +how the branches in your local repository have changed over time.

    Examining dangling objects

    In some situations the reflog may not be able to save you. For example, suppose you delete a branch, then realize you need the history it pointed you. The reflog is also deleted; however, if you have not yet pruned the repository, then you may still be able to find @@ -604,7 +604,7 @@ you get exactly the history reachable from that commit that is lost. (And notice that it might not be just one commit: we only report the "tip of the line" as being dangling, but there might be a whole deep and complex commit history that was gotten dropped.)

    If you decide you want the history back, you can always create a new -reference pointing to it, for example, a new branch:

    $ git branch recovered-branch 7281251ddd

    Chapter 5. Sharing development with others

    Table of Contents

    Getting updates with git pull
    Submitting patches to a project
    Importing patches to a project
    Setting up a public repository
    Exporting a git repository via http
    Exporting a git repository via the git protocol
    Pushing changes to a public repository
    Setting up a shared repository
    Allow web browsing of a repository
    Examples

    Getting updates with git pull

    After you clone a repository and make a few changes of your own, you +reference pointing to it, for example, a new branch:

    $ git branch recovered-branch 7281251ddd

    Chapter 5. Sharing development with others

    Table of Contents

    Getting updates with git pull
    Submitting patches to a project
    Importing patches to a project
    Setting up a public repository
    Exporting a git repository via http
    Exporting a git repository via the git protocol
    Pushing changes to a public repository
    Setting up a shared repository
    Allow web browsing of a repository
    Examples

    Getting updates with git pull

    After you clone a repository and make a few changes of your own, you may wish to check the original repository for updates and merge them into your own work.

    We have already seen how to keep remote tracking branches up to date with git-fetch(1), and how to merge two branches. So you can merge in changes from the @@ -621,13 +621,13 @@ repository that you pulled from.

    (But note that no such commit will be cre updated to point to the latest commit from the upstream branch).

    The git-pull command can also be given "." as the "remote" repository, in which case it just merges in a branch from the current repository; so the commands

    $ git pull . branch
    -$ git merge branch

    are roughly equivalent. The former is actually very commonly used.

    Submitting patches to a project

    If you just have a few changes, the simplest way to submit them may +$ git merge branch

    are roughly equivalent. The former is actually very commonly used.

    Submitting patches to a project

    If you just have a few changes, the simplest way to submit them may just be to send them as patches in email:

    First, use git-format-patch(1); for example:

    $ git format-patch origin

    will produce a numbered series of files in the current directory, one for each patch in the current branch but not in origin/HEAD.

    You can then import these into your mail client and send them by hand. However, if you have a lot to send at once, you may prefer to use the git-send-email(1) script to automate the process. Consult the mailing list for your project first to determine how they -prefer such patches be handled.

    Importing patches to a project

    Git also provides a tool called git-am(1) (am stands for +prefer such patches be handled.

    Importing patches to a project

    Git also provides a tool called git-am(1) (am stands for "apply mailbox"), for importing such an emailed series of patches. Just save all of the patch-containing messages, in order, into a single mailbox file, say "patches.mbox", then run

    $ git am -3 patches.mbox

    Git will apply each patch in order; if any conflicts are found, it @@ -699,16 +699,16 @@ save typing; so, for example, after

    $         url = ssh://yourserver.com/~you/proj.git
    EOF

    you should be able to perform the above push with just

    $ git push public-repo master

    See the explanations of the remote.<name>.url, branch.<name>.remote, and remote.<name>.push options in git-config(1) for -details.

    Setting up a shared repository

    Another way to collaborate is by using a model similar to that +details.

    Setting up a shared repository

    Another way to collaborate is by using a model similar to that commonly used in CVS, where several developers with special rights all push to and pull from a single shared repository. See git for CVS users for instructions on how to -set this up.

    Allow web browsing of a repository

    The gitweb cgi script provides users an easy way to browse your +set this up.

    Allow web browsing of a repository

    The gitweb cgi script provides users an easy way to browse your project's files and history without having to install git; see the file -gitweb/README in the git source tree for instructions on setting it up.

    Examples

    TODO: topic branches, typical roles as in everyday.txt, ?

    Chapter 6. Rewriting history and maintaining patch series

    Table of Contents

    Creating the perfect patch series
    Keeping a patch series up to date using git-rebase
    Reordering or selecting from a patch series
    Other tools
    Problems with rewriting history

    Normally commits are only added to a project, never taken away or +gitweb/README in the git source tree for instructions on setting it up.

    Examples

    TODO: topic branches, typical roles as in everyday.txt, ?

    Chapter 6. Rewriting history and maintaining patch series

    Table of Contents

    Creating the perfect patch series
    Keeping a patch series up to date using git-rebase
    Reordering or selecting from a patch series
    Other tools
    Problems with rewriting history

    Normally commits are only added to a project, never taken away or replaced. Git is designed with this assumption, and violating it will cause git's merge machinery (for example) to do the wrong thing.

    However, there is a situation in which it can be useful to violate this -assumption.

    Creating the perfect patch series

    Suppose you are a contributor to a large project, and you want to add a +assumption.

    Creating the perfect patch series

    Suppose you are a contributor to a large project, and you want to add a complicated feature, and to present it to the other developers in a way that makes it easy for them to read your changes, verify that they are correct, and understand why you made each change.

    If you present all of your changes as a single patch (or commit), they @@ -727,7 +727,7 @@ The complete series produces the same end result as your own (probably much messier!) development process did.

    We will introduce some tools that can help you do this, explain how to use them, and then explain some of the problems that can arise because -you are rewriting history.

    Keeping a patch series up to date using git-rebase

    Suppose you have a series of commits in a branch "mywork", which +you are rewriting history.

    Keeping a patch series up to date using git-rebase

    Suppose you have a series of commits in a branch "mywork", which originally branched off from "origin".

    Suppose you create a branch "mywork" on a remote-tracking branch "origin", and created some commits on top of it:

    $ git checkout -b mywork origin
    $ vi file.txt
    @@ -751,7 +751,7 @@ patches to the new mywork. The result will look like:

    $ git rebase --continue
    and git will continue applying the rest of the patches.
    At any point you may use the —abort option to abort this process and
-return mywork to the state it had before you started the rebase:
    $ git rebase --abort

    Reordering or selecting from a patch series

    Given one existing commit, the git-cherry-pick(1) command +return mywork to the state it had before you started the rebase:

    $ git rebase --abort

    Reordering or selecting from a patch series

    Given one existing commit, the git-cherry-pick(1) command allows you to apply the change introduced by that commit and create a new commit that records it. So, for example, if "mywork" points to a series of patches on top of "origin", you might do something like:

    $ git checkout -b mywork-new origin
    @@ -761,9 +761,9 @@ cherry-pick, and possibly modifying them as you go using commit —amend.

    Another technique is to use git-format-patch to create a series of patches, then reset the state to before the patches:

    $ git format-patch origin
    $ git reset --hard origin

    Then modify, reorder, or eliminate patches as preferred before applying -them again with git-am(1).

    Other tools

    There are numerous other tools, such as stgit, which exist for the +them again with git-am(1).

    Other tools

    There are numerous other tools, such as stgit, which exist for the purpose of maintaining a patch series. These are out of the scope of -this manual.

    Problems with rewriting history

    The primary problem with rewriting the history of a branch has to do +this manual.

    Problems with rewriting history

    The primary problem with rewriting the history of a branch has to do with merging. Suppose somebody fetches your branch and merges it into their branch, with a result something like this:

    o--o--O--o--o--o <-- origin
        \                 t--t--t--m <-- their branch:

    Then suppose you modify the last three commits:

            o--o--o <-- new head of origin
@@ -782,7 +782,7 @@ new.  The results are likely to be unexpected.
    You may still choose to pub
 and it may be useful for others to be able to fetch those branches in
 order to examine or test them, but they should not attempt to pull such
 branches into their own work.
    For true distributed development that supports proper merging,
-published branches should never be rewritten.

    Chapter 7. Advanced branch management

    Table of Contents

    Fetching individual branches
    Understanding git history: fast-forwards
    Forcing git fetch to do non-fast-forward updates
    Configuring remote branches

    Fetching individual branches

    Instead of using git-remote(1), you can also choose just +published branches should never be rewritten.

    Chapter 7. Advanced branch management

    Table of Contents

    Fetching individual branches
    Understanding git history: fast-forwards
    Forcing git fetch to do non-fast-forward updates
    Configuring remote branches

    Fetching individual branches

    Instead of using git-remote(1), you can also choose just to update one branch at a time, and to store it locally under an arbitrary name:

    $ git fetch origin todo:my-todo-work

    The first argument, "origin", just tells git to fetch from the repository you originally cloned from. The second argument tells git @@ -804,10 +804,10 @@ resulting in a situation like:

    o--o--o--o--a--b &l
 described in the following section.  However, note that in the
 situation above this may mean losing the commits labeled "a" and "b",
 unless you've already created a reference of your own pointing to
-them.

    Forcing git fetch to do non-fast-forward updates

    If git fetch fails because the new head of a branch is not a +them.

    Forcing git fetch to do non-fast-forward updates

    If git fetch fails because the new head of a branch is not a descendant of the old head, you may force the update with:

    $ git fetch git://example.com/proj.git +master:refs/remotes/example/master

    Note the addition of the "+" sign. Be aware that commits which the old version of example/master pointed at may be lost, as we saw in -the previous section.

    Configuring remote branches

    We saw above that "origin" is just a shortcut to refer to the +the previous section.

    Configuring remote branches

    We saw above that "origin" is just a shortcut to refer to the repository which you originally cloned from. This information is stored in git configuration variables, which you can see using git-config(1):

    $ git config -l
    @@ -827,8 +827,8 @@ $ throwing away commits on mybranch.

    Also note that all of the above configuration can be performed by directly editing the file .git/config instead of using git-config(1).

    See git-config(1) for more details on the configuration -options mentioned above.

    Chapter 8. Git internals

    Table of Contents

    The Object Database
    Blob Object
    Tree Object
    Commit Object
    Trust
    Tag Object
    The "index" aka "Current Directory Cache"
    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
    How git stores objects efficiently: pack files
    Dangling objects

    There are two object abstractions: the "object database", and the -"current directory cache" aka "index".

    The Object Database

    The object database is literally just a content-addressable collection +options mentioned above.

    Chapter 8. Git internals

    Table of Contents

    The Object Database
    Blob Object
    Tree Object
    Commit Object
    Trust
    Tag Object
    The "index" aka "Current Directory Cache"
    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
    How git stores objects efficiently: pack files
    Dangling objects

    There are two object abstractions: the "object database", and the +"current directory cache" aka "index".

    The Object Database

    The object database is literally just a content-addressable collection of objects. All objects are named by their content, which is approximated by the SHA1 hash of the object itself. Objects may refer to other objects (by referencing their SHA1 hash), and so you can @@ -870,7 +870,7 @@ size> + <byte\0> + <binary object data>.

    The structured obj connectivity to other objects verified. This is generally done with the git-fsck program, which generates a full dependency graph of all objects, and verifies their internal consistency (in addition -to just verifying their superficial consistency through the hash).

    The object types in some more detail:

    Blob Object

    A "blob" object is nothing but a binary blob of data, and doesn't +to just verifying their superficial consistency through the hash).

    The object types in some more detail:

    Blob Object

    A "blob" object is nothing but a binary blob of data, and doesn't refer to anything else. There is no signature or any other verification of the data, so while the object is consistent (it is indexed by its sha1 hash, so the data itself is certainly correct), it @@ -882,7 +882,7 @@ repository) have the same contents, they will share the same blob object. The object is totally independent of its location in the directory tree, and renaming a file does not change the object that file is associated with in any way.

    A blob is typically created when git-update-index(1) -is run, and its data can be accessed by git-cat-file(1).

    Tree Object

    The next hierarchical object type is the "tree" object. A tree object +is run, and its data can be accessed by git-cat-file(1).

    Tree Object

    The next hierarchical object type is the "tree" object. A tree object is a list of mode/name/blob data, sorted by name. Alternatively, the mode data may specify a directory mode, in which case instead of naming a blob, that name is associated with another TREE object.

    Like the "blob" object, a tree object is uniquely determined by the @@ -906,7 +906,7 @@ involved), you can see trivial renames or permission changes by noticing that the blob stayed the same. However, renames with data changes need a smarter "diff" implementation.

    A tree is created with git-write-tree(1) and its data can be accessed by git-ls-tree(1). -Two trees can be compared with git-diff-tree(1).

    Commit Object

    The "commit" object is an object that introduces the notion of +Two trees can be compared with git-diff-tree(1).

    Commit Object

    The "commit" object is an object that introduces the notion of history into the picture. In contrast to the other objects, it doesn't just describe the physical state of a tree, it describes how we got there, and why.

    A "commit" is defined by the tree-object that it results in, the @@ -921,7 +921,7 @@ rename information or file mode change information. All of that is implicit in the trees involved (the result tree, and the result trees of the parents), and describing that makes no sense in this idiotic file manager.

    A commit is created with git-commit-tree(1) and -its data can be accessed by git-cat-file(1).

    Trust

    An aside on the notion of "trust". Trust is really outside the scope +its data can be accessed by git-cat-file(1).

    Trust

    An aside on the notion of "trust". Trust is really outside the scope of "git", but it's worth noting a few things. First off, since everything is hashed with SHA1, you can trust that an object is intact and has not been messed with by external sources. So the name @@ -937,7 +937,7 @@ that you trust that commit, and the immutability of the history of commits tells others that they can trust the whole history.

    In other words, you can easily validate a whole archive by just sending out a single email that tells the people the name (SHA1 hash) of the top commit, and digitally sign that email using something -like GPG/PGP.

    To assist in this, git also provides the tag object…

    Tag Object

    Git provides the "tag" object to simplify creating, managing and +like GPG/PGP.

    To assist in this, git also provides the tag object…

    Tag Object

    Git provides the "tag" object to simplify creating, managing and exchanging symbolic and signed tokens. The "tag" object at its simplest simply symbolically identifies another object by containing the sha1, type and symbolic name.

    However it can optionally contain additional signature information @@ -947,7 +947,7 @@ integrity; the trust framework (and signature provision and verification) has to come from outside.

    A tag is created with git-mktag(1), its data can be accessed by git-cat-file(1), and the signature can be verified by -git-verify-tag(1).

    The "index" aka "Current Directory Cache"

    The index is a simple binary file, which contains an efficient +git-verify-tag(1).

    The "index" aka "Current Directory Cache"

    The index is a simple binary file, which contains an efficient representation of a virtual directory content at some random time. It does so by a simple array that associates a set of names, dates, permissions and content (aka "blob") objects together. The cache is @@ -980,11 +980,11 @@ involves a controlled modification of the index file. In particular, the index file can have the representation of an intermediate tree that has not yet been instantiated. So the index can be thought of as a write-back cache, which can contain dirty information that has not yet -been written back to the backing store.

    The Workflow

    Generally, all "git" operations work on the index file. Some operations +been written back to the backing store.

    The Workflow

    Generally, all "git" operations work on the index file. Some operations work purely on the index file (showing the current state of the index), but most operations move data to and from the index file. Either from the database or from the working directory. Thus there are four -main combinations:

    working directory -> index

    You update the index with information from the working directory with +main combinations:

    working directory -> index

    You update the index with information from the working directory with the git-update-index(1) command. You generally update the index information by just specifying the filename you want to update, like so:

    $ git-update-index filename

    but to avoid common mistakes with filename globbing etc, the command @@ -1000,16 +1000,16 @@ does not exist any more, it will update the index accordingly.

    As a specia will refresh the "stat" information of each index to match the current stat information. It will not update the object status itself, and it will only update the fields that are used to quickly test whether -an object still matches its old backing store object.

    index -> object database

    You write your current index file to a "tree" object with the program

    $ git-write-tree

    that doesn't come with any options - it will just write out the +an object still matches its old backing store object.

    index -> object database

    You write your current index file to a "tree" object with the program

    $ git-write-tree

    that doesn't come with any options - it will just write out the current index into the set of tree objects that describe that state, and it will return the name of the resulting top-level tree. You can use that tree to re-generate the index at any time by going in the -other direction:

    object database -> index

    You read a "tree" file from the object database, and use that to +other direction:

    object database -> index

    You read a "tree" file from the object database, and use that to populate (and overwrite - don't do this if your index contains any unsaved state that you might want to restore later!) your current index. Normal operation is just

    $ git-read-tree <sha1 of tree>

    and your index file will now be equivalent to the tree that you saved earlier. However, that is only your index file: your working -directory contents have not been modified.

    index -> working directory

    You update your working directory from the index by "checking out" +directory contents have not been modified.

    index -> working directory

    You update your working directory from the index by "checking out" files. This is not a very common operation, since normally you'd just keep your files updated, and rather than write to your working directory, you'd tell the index files about the changes in your @@ -1020,7 +1020,7 @@ with

    $ if you have an old version of the tree already checked out, you will need to use the "-f" flag (before the "-a" flag or the filename) to force the checkout.

    Finally, there are a few odds and ends which are not purely moving -from one representation to the other:

    Tying it all together

    To commit a tree you have instantiated with "git-write-tree", you'd +from one representation to the other:

    Tying it all together

    To commit a tree you have instantiated with "git-write-tree", you'd create a "commit" object that refers to that tree and the history behind it - most notably the "parent" commits that preceded it in history.

    Normally a "commit" has one parent: the previous state of the tree @@ -1069,7 +1069,7 @@ various pieces fit together.


                        |  Working  |
                        | Directory |
                        +-----------+
    -

    Examining the data

    You can examine the data represented in the object database and the +

    Examining the data

    You can examine the data represented in the object database and the index with various helper tools. For every object, you can use git-cat-file(1) to examine details about the object:

    $ git-cat-file -t <objectname>

    shows the type of the object, and once you have the type (which is @@ -1079,7 +1079,7 @@ there is a special helper for showing that content, called readable form.

    It's especially instructive to look at "commit" objects, since those tend to be small and fairly self-explanatory. In particular, if you follow the convention of having the top commit name in .git/HEAD, -you can do

    $ git-cat-file commit HEAD

    to see what the top commit was.

    Merging multiple trees

    Git helps you do a three-way merge, which you can expand to n-way by +you can do

    $ git-cat-file commit HEAD

    to see what the top commit was.

    Merging multiple trees

    Git helps you do a three-way merge, which you can expand to n-way by repeating the merge procedure arbitrary times until you finally "commit" the state. The normal situation is that you'd only do one three-way merge (two parents), and commit it, but if you like to, you @@ -1098,7 +1098,7 @@ make sure that you've committed those - in fact you would normally always do a merge against your last commit (which should thus match what you have in your current index anyway).

    To do the merge, do

    $ git-read-tree -m -u <origtree> <yourtree> <targettree>

    which will do all trivial merge operations for you directly in the index file, and you can just write the result out with -git-write-tree.

    Merging multiple trees, continued

    Sadly, many merges aren't trivial. If there are files that have +git-write-tree.

    Merging multiple trees, continued

    Sadly, many merges aren't trivial. If there are files that have been added.moved or removed, or if both branches have modified the same file, you will be left with an index tree that contains "merge entries" in it. Such an index tree can NOT be written out to a tree @@ -1133,7 +1133,7 @@ that path tells git to mark the path resolved.

    The above is the descriptio to help you understand what conceptually happens under the hood. In practice, nobody, not even git itself, uses three git-cat-file for this. There is git-merge-index program that extracts the -stages to temporary files and calls a "merge" script on it:

    $ git-merge-index git-merge-one-file hello.c

    and that is what higher level git resolve is implemented with.

    How git stores objects efficiently: pack files

    We've seen how git stores each object in a file named after the +stages to temporary files and calls a "merge" script on it:

    $ git-merge-index git-merge-one-file hello.c

    and that is what higher level git merge -s resolve is implemented with.

    How git stores objects efficiently: pack files

    We've seen how git stores each object in a file named after the object's SHA1 hash.

    Unfortunately this system becomes inefficient once a project has a lot of objects. Try this on an old project:

    $ git count-objects
    6930 objects, 47620 kilobytes

    The first number is the number of objects which are kept in @@ -1197,7 +1197,7 @@ on what it found, git-fsck itself is never "dangerous" to run. Running it while somebody is actually changing the repository can cause confusing and scary messages, but it won't actually do anything bad. In contrast, running "git prune" while somebody is actively changing the -repository is a BAD idea).

    Chapter 9. Glossary of git terms

    +repository is a BAD idea).

    Chapter 9. Glossary of git terms

    alternate object database
    Via the alternates mechanism, a repository can inherit part of its @@ -1620,7 +1620,7 @@ working tree
    The set of files and directories currently being worked on, i.e. you can work in your working tree without using git at all. -

    Chapter 10. Notes and todo list for this manual

    This is a work in progress.

    The basic requirements: +

    Chapter 10. Notes and todo list for this manual

    This is a work in progress.

    The basic requirements: - It must be readable in order, from beginning to end, by someone intelligent with a basic grasp of the unix commandline, but without any special knowledge of git. If diff --git a/user-manual.txt b/user-manual.txt index c5e9ea8a4..03736bbcd 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -2755,7 +2755,7 @@ stages to temporary files and calls a "merge" script on it: $ git-merge-index git-merge-one-file hello.c ------------------------------------------------- -and that is what higher level `git resolve` is implemented with. +and that is what higher level `git merge -s resolve` is implemented with. How git stores objects efficiently: pack files ----------------------------------------------