Git User's Manual (for version 1.5.3 or newer)

From 7f80ae8006f163acc614aebc362adf92788b20a6 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 30 Jul 2008 18:31:35 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.6.0-rc1-27-g9b6bf --- git-fast-export.html | 17 ++++++++++++++++- git-fast-export.txt | 9 +++++++++ git-push.html | 19 ++++++++++--------- git-push.txt | 17 +++++++++-------- git-rev-parse.html | 7 ++++--- git-rev-parse.txt | 5 +++-- git-svn.html | 28 +++++++++++++--------------- git-svn.txt | 26 ++++++++++++-------------- user-manual.html | 10 +++++----- user-manual.txt | 8 ++++---- 10 files changed, 85 insertions(+), 61 deletions(-) diff --git a/git-fast-export.html b/git-fast-export.html index 717496097..06540680e 100644 --- a/git-fast-export.html +++ b/git-fast-export.html @@ -357,6 +357,21 @@ unsigned, with verbatim, they will be silently exported and with warn, they will be exported, but you will see a warning.

+-M +

+-C +

+ Perform move and/or copy detection, as described in the + git-diff(1) manual page, and use it to generate + rename and copy commands in the output dump. +

Note that earlier versions of this command did not complain and +produced incorrect results if you gave these options.

--export-marks=<file>

@@ -428,7 +443,7 @@ a tag referencing a tree instead of a commit.

diff --git a/git-fast-export.txt b/git-fast-export.txt index 4956964d8..b974e2115 100644 --- a/git-fast-export.txt +++ b/git-fast-export.txt @@ -36,6 +36,15 @@ when encountering a signed tag. With 'strip', the tags will be made unsigned, with 'verbatim', they will be silently exported and with 'warn', they will be exported, but you will see a warning. +-M:: +-C:: + Perform move and/or copy detection, as described in the + linkgit:git-diff[1] manual page, and use it to generate + rename and copy commands in the output dump. ++ +Note that earlier versions of this command did not complain and +produced incorrect results if you gave these options. + --export-marks=:: Dumps the internal marks table to when complete. Marks are written one per line as `:markid SHA-1`. Only marks diff --git a/git-push.html b/git-push.html index bf542f586..844940f32 100644 --- a/git-push.html +++ b/git-push.html @@ -322,7 +322,8 @@ git-push(1) Manual Page

git push [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>] - [--repo=all] [-f | --force] [-v | --verbose] [<repository> <refspec>…]

+ [--repo=all] [-f | --force] [-v | --verbose] + [<repository> <refspec>…]

DESCRIPTION

@@ -345,11 +346,11 @@ documentation for git-receive-pack(1).

-<refspec> +<refspec>…

- The canonical format of a <refspec> parameter is + The canonical format of each <refspec> parameter is ?<src>:<dst>; that is, an optional plus , followed by the source ref, followed by a colon :, followed by the destination ref. @@ -778,14 +779,14 @@ git push origin :experimental

-git push origin master:satellite/master +git push origin master:satellite/master dev:satellite/dev

- Find a ref that matches master in the source repository - (most likely, it would find refs/heads/master), and update - the ref that matches satellite/master (most likely, it would - be refs/remotes/satellite/master) in origin repository with it. + Use the source ref that matches master (e.g. refs/heads/master) + to update the ref that matches satellite/master (most probably + refs/remotes/satellite/master) in the origin repository, then + do the same for dev and satellite/dev.

@@ -817,7 +818,7 @@ by Linus Torvalds <torvalds@osdl.org>

diff --git a/git-push.txt b/git-push.txt index 94d07ab81..050c3ddae 100644 --- a/git-push.txt +++ b/git-push.txt @@ -10,7 +10,8 @@ SYNOPSIS -------- [verse] 'git push' [--all] [--dry-run] [--tags] [--receive-pack=] - [--repo=all] [-f | --force] [-v | --verbose] [ ...] + [--repo=all] [-f | --force] [-v | --verbose] + [ ...] DESCRIPTION ----------- @@ -29,8 +30,8 @@ OPTIONS The "remote" repository that is destination of a push operation. See the section <> below. -:: - The canonical format of a parameter is +...:: + The canonical format of each parameter is `+?:`; that is, an optional plus `+`, followed by the source ref, followed by a colon `:`, followed by the destination ref. @@ -180,11 +181,11 @@ git push origin :experimental:: Find a ref that matches `experimental` in the `origin` repository (e.g. `refs/heads/experimental`), and delete it. -git push origin master:satellite/master:: - Find a ref that matches `master` in the source repository - (most likely, it would find `refs/heads/master`), and update - the ref that matches `satellite/master` (most likely, it would - be `refs/remotes/satellite/master`) in `origin` repository with it. +git push origin master:satellite/master dev:satellite/dev:: + Use the source ref that matches `master` (e.g. `refs/heads/master`) + to update the ref that matches `satellite/master` (most probably + `refs/remotes/satellite/master`) in the `origin` repository, then + do the same for `dev` and `satellite/dev`. git push origin master:refs/heads/experimental:: Create the branch `experimental` in the `origin` repository diff --git a/git-rev-parse.html b/git-rev-parse.html index f93966932..5c8623ec5 100644 --- a/git-rev-parse.html +++ b/git-rev-parse.html @@ -614,8 +614,9 @@ The full SHA1 object name (40-byte hexadecimal string), or

-An output from git-describe; i.e. a closest tag, followed by a - dash, a g, and an abbreviated object name. +An output from git-describe; i.e. a closest tag, optionally + followed by a dash and a number of commits, followed by a dash, a + g, and an abbreviated object name.

@@ -973,7 +974,7 @@ Junio C Hamano <gitster@pobox.com> and Pierre Habouzit <madcoder@debian diff --git a/git-rev-parse.txt b/git-rev-parse.txt index 5c936693d..2921da320 100644 --- a/git-rev-parse.txt +++ b/git-rev-parse.txt @@ -155,8 +155,9 @@ blobs contained in a commit. name the same commit object if there are no other object in your repository whose object name starts with dae86e. -* An output from 'git-describe'; i.e. a closest tag, followed by a - dash, a `g`, and an abbreviated object name. +* An output from 'git-describe'; i.e. a closest tag, optionally + followed by a dash and a number of commits, followed by a dash, a + `g`, and an abbreviated object name. * A symbolic ref name. E.g. 'master' typically means the commit object referenced by $GIT_DIR/refs/heads/master. If you diff --git a/git-svn.html b/git-svn.html index a740b8a4e..cbac2b3d6 100644 --- a/git-svn.html +++ b/git-svn.html @@ -325,16 +325,16 @@ git-svn(1) Manual Page

DESCRIPTION

git-svn is a simple conduit for changesets between Subversion and git. -It is not to be confused with git-svnimport(1), which is -read-only.

git-svn was originally designed for an individual developer who wants a -bidirectional flow of changesets between a single branch in Subversion -and an arbitrary number of branches in git. Since its inception, -git-svn has gained the ability to track multiple branches in a manner -similar to git-svnimport.

git-svn is especially useful when it comes to tracking repositories -not organized in the way Subversion developers recommend (trunk, -branches, tags directories).

+It provides a bidirectional flow of changes between a Subversion and a git +respository.

git-svn can track a single Subversion branch simply by using a +URL to the branch, follow branches laid out in the Subversion recommended +method (trunk, branches, tags directories) with the --stdlayout option, or +follow branches in any layout with the -T/-t/-b options (see options to +init below, and also the clone command).

Once tracking a Subversion branch (with any of the above methods), the git +repository can be updated from Subversion by the fetch command and +Subversion updated from git by the dcommit command.

COMMANDS

@@ -715,8 +715,7 @@ environment). This command has the same behaviour.

Commits the diff of two tree-ish arguments from the - command-line. This command is intended for interoperability with - git-svnimport and does not rely on being inside an git-svn + command-line. This command does not rely on being inside an git-svn init-ed repository. This command takes three arguments, (a) the original tree to diff against, (b) the new tree result, (c) the URL of the target Subversion repository. The final argument @@ -865,8 +864,7 @@ config key: svn.findcopiesharder

-Syntax is compatible with the files used by git-svnimport and -git-cvsimport: +Syntax is compatible with the file used by git-cvsimport: @@ -1221,7 +1219,7 @@ should be manually entered with a text-editor or using git-config.< -Last updated 2008-07-06 05:17:04 UTC +Last updated 2008-07-30 18:31:06 UTC diff --git a/git-svn.txt b/git-svn.txt index e7c0f1c95..f230125a8 100644 --- a/git-svn.txt +++ b/git-svn.txt @@ -12,18 +12,18 @@ SYNOPSIS DESCRIPTION ----------- 'git-svn' is a simple conduit for changesets between Subversion and git. -It is not to be confused with linkgit:git-svnimport[1], which is -read-only. +It provides a bidirectional flow of changes between a Subversion and a git +respository. -'git-svn' was originally designed for an individual developer who wants a -bidirectional flow of changesets between a single branch in Subversion -and an arbitrary number of branches in git. Since its inception, -'git-svn' has gained the ability to track multiple branches in a manner -similar to 'git-svnimport'. +'git-svn' can track a single Subversion branch simply by using a +URL to the branch, follow branches laid out in the Subversion recommended +method (trunk, branches, tags directories) with the --stdlayout option, or +follow branches in any layout with the -T/-t/-b options (see options to +'init' below, and also the 'clone' command). -'git-svn' is especially useful when it comes to tracking repositories -not organized in the way Subversion developers recommend (trunk, -branches, tags directories). +Once tracking a Subversion branch (with any of the above methods), the git +repository can be updated from Subversion by the 'fetch' command and +Subversion updated from git by the 'dcommit' command. COMMANDS -------- @@ -218,8 +218,7 @@ Any other arguments are passed directly to 'git-log' 'commit-diff':: Commits the diff of two tree-ish arguments from the - command-line. This command is intended for interoperability with - 'git-svnimport' and does not rely on being inside an `git-svn + command-line. This command does not rely on being inside an `git-svn init`-ed repository. This command takes three arguments, (a) the original tree to diff against, (b) the new tree result, (c) the URL of the target Subversion repository. The final argument @@ -317,8 +316,7 @@ config key: svn.findcopiesharder -A:: --authors-file=:: -Syntax is compatible with the files used by 'git-svnimport' and -'git-cvsimport': +Syntax is compatible with the file used by 'git-cvsimport': ------------------------------------------------------------------------ loginname = Joe User diff --git a/user-manual.html b/user-manual.html index a2339f789..35cef3557 100644 --- a/user-manual.html +++ b/user-manual.html @@ -1,4 +1,4 @@ -Git User's Manual (for version 1.5.3 or newer)Git User's Manual (for version 1.5.3 or newer) Table of Contents Preface 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 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 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 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 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 Preface Git is a fast distributed revision control system. This manual is designed to be readable by someone with basic UNIX +Git User's Manual (for version 1.5.3 or newer) Git User's Manual (for version 1.5.3 or newer) Table of Contents Preface 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 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 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 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 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 Preface 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 @@ -1485,11 +1485,11 @@ $Â cdÂ super $Â gitÂ init $Â forÂ iÂ inÂ aÂ bÂ cÂ d do -Â Â Â Â Â Â Â Â gitÂ submoduleÂ addÂ ~/git/$i +Â Â Â Â Â Â Â Â gitÂ submoduleÂ addÂ ~/git/$iÂ $i done Note Do not use local URLs here if you plan to publish your superproject! See what files git-submodule created: $Â lsÂ -a -.Â Â ..Â Â .gitÂ Â .gitmodulesÂ Â aÂ Â bÂ Â cÂ Â d The git-submodule add command does a couple of things: -It clones the submodule under the current directory and by default checks out - the master branch. +.Â Â ..Â Â .gitÂ Â .gitmodulesÂ Â aÂ Â bÂ Â cÂ Â d The git-submodule add <repo> <path> command does a couple of things: +It clones the submodule from <repo> to the given <path> under the + current directory and by default checks out the master branch. It adds the submodule's clone path to the gitmodules(5) file and adds this file to the index, ready to be committed. diff --git a/user-manual.txt b/user-manual.txt index c5641af19..00256ca57 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -3458,7 +3458,7 @@ $ cd super $ git init $ for i in a b c d do - git submodule add ~/git/$i + git submodule add ~/git/$i $i done ------------------------------------------------- @@ -3471,10 +3471,10 @@ $ ls -a . .. .git .gitmodules a b c d ------------------------------------------------- -The `git-submodule add` command does a couple of things: +The `git-submodule add ` command does a couple of things: -- It clones the submodule under the current directory and by default checks out - the master branch. +- It clones the submodule from to the given under the + current directory and by default checks out the master branch. - It adds the submodule's clone path to the linkgit:gitmodules[5] file and adds this file to the index, ready to be committed. - It adds the submodule's current commit ID to the index, ready to be -- 2.26.2