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

From c96fb5a7d7921dab126671259bd1665dff1a7b50 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 12 Aug 2008 06:59:38 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.6.0-rc2-35-g04c6e --- RelNotes-1.6.0.txt | 16 +++++++++++----- git-log.html | 4 ++-- git-rev-list.html | 4 ++-- gitcore-tutorial.html | 17 +++++++++-------- gitcore-tutorial.txt | 15 ++++++++------- rev-list-options.txt | 2 +- user-manual.html | 4 ++-- user-manual.txt | 2 +- 8 files changed, 36 insertions(+), 28 deletions(-) diff --git a/RelNotes-1.6.0.txt b/RelNotes-1.6.0.txt index 8afb5b253..e3c0c1d88 100644 --- a/RelNotes-1.6.0.txt +++ b/RelNotes-1.6.0.txt @@ -28,6 +28,16 @@ introduced in v1.5.2 and v1.4.4.5. If you want to keep your repositories backwards compatible past these versions, set repack.useDeltaBaseOffset to false or pack.indexVersion to 1, respectively. +We used to prevent sample hook scripts shipped in templates/ from +triggering by default by relying on the fact that we install them as +unexecutable, but on some filesystems, this approach does not work. +They are now shipped with ".sample" suffix. If you want to activate +any of these samples as-is, rename them to drop the ".sample" suffix, +instead of running "chmod +x" on them. For example, you can rename +hooks/post-update.sample to hooks/post-update to enable the sample +hook that runs update-server-info, in order to make repositories +friendly to dumb protocols (i.e. HTTP). + GIT_CONFIG, which was only documented as affecting "git config", but actually affected all git commands, now only affects "git config". GIT_LOCAL_CONFIG, also only documented as affecting "git config" and @@ -56,11 +66,7 @@ Updates since v1.5.6 gangs. * Sample hook scripts shipped in templates/ are now suffixed with - *.sample. We used to prevent them from triggering by default by - relying on the fact that we install them as unexecutable, but on - some filesystems this approach does not work. Instead of running - "chmod +x" on them, the users who want to activate these samples - as-is can now rename them dropping *.sample suffix. + *.sample. * perl's in-place edit (-i) does not work well without backup files on Windows; some tests are rewritten to cope with this. diff --git a/git-log.html b/git-log.html index 129ff704e..688438646 100644 --- a/git-log.html +++ b/git-log.html @@ -980,7 +980,7 @@ format, often found in E-mail messages.

/ / \ o---x---a---a branch A -

you would get an output line this:

you would get an output like this:

        $ git rev-list --left-right --boundary --pretty=oneline A...B
@@ -2031,7 +2031,7 @@ reversible operation.

-Last updated 2008-08-11 22:02:43 UTC +Last updated 2008-08-12 06:59:09 UTC diff --git a/git-rev-list.html b/git-rev-list.html index c5841b1a4..c0915c490 100644 --- a/git-rev-list.html +++ b/git-rev-list.html @@ -519,7 +519,7 @@ format, often found in E-mail messages. / / \ o---x---a---a branch A -

you would get an output line this:

you would get an output like this:

        $ git rev-list --left-right --boundary --pretty=oneline A...B
@@ -1346,7 +1346,7 @@ and the git-list <git@vger.kernel.org>.

-Last updated 2008-08-11 22:02:43 UTC +Last updated 2008-08-12 06:59:09 UTC diff --git a/gitcore-tutorial.html b/gitcore-tutorial.html index 36c0fcea7..886b7d396 100644 --- a/gitcore-tutorial.html +++ b/gitcore-tutorial.html @@ -1662,8 +1662,9 @@ your login shell is bash, only .bashrc is read and not Note If you plan to publish this repository to be accessed over http, -you should do chmod +x my-git.git/hooks/post-update at this -point. This makes sure that every time you push into this +you should do mv my-git.git/hooks/post-update.sample +my-git.git/hooks/post-update at this point. +This makes sure that every time you push into this repository, git update-server-info is run. @@ -1783,11 +1784,11 @@ Prepare a public repository accessible to others. If other people are pulling from your repository over dumb transport protocols (HTTP), you need to keep this repository dumb transport friendly. After git init, -$GIT_DIR/hooks/post-update copied from the standard templates -would contain a call to git-update-server-info but the -post-update hook itself is disabled by default — enable it -with chmod +x post-update. This makes sure git-update-server-info -keeps the necessary files up-to-date. +$GIT_DIR/hooks/post-update.sample copied from the standard templates +would contain a call to git-update-server-info +but you need to manually enable the hook with +mv post-update.sample post-update. This makes sure +git-update-server-info keeps the necessary files up-to-date. @@ -2037,7 +2038,7 @@ to follow, not easier. -Last updated 2008-07-09 19:53:06 UTC +Last updated 2008-08-12 06:59:10 UTC diff --git a/gitcore-tutorial.txt b/gitcore-tutorial.txt index 49179b0a0..a417e592a 100644 --- a/gitcore-tutorial.txt +++ b/gitcore-tutorial.txt @@ -1366,8 +1366,9 @@ your login shell is 'bash', only `.bashrc` is read and not [NOTE] If you plan to publish this repository to be accessed over http, -you should do `chmod +x my-git.git/hooks/post-update` at this -point. This makes sure that every time you push into this +you should do `mv my-git.git/hooks/post-update.sample +my-git.git/hooks/post-update` at this point. +This makes sure that every time you push into this repository, `git update-server-info` is run. Your "public repository" is now ready to accept your changes. @@ -1486,11 +1487,11 @@ A recommended workflow for a "project lead" goes like this: If other people are pulling from your repository over dumb transport protocols (HTTP), you need to keep this repository 'dumb transport friendly'. After `git init`, -`$GIT_DIR/hooks/post-update` copied from the standard templates -would contain a call to 'git-update-server-info' but the -`post-update` hook itself is disabled by default -- enable it -with `chmod +x post-update`. This makes sure 'git-update-server-info' -keeps the necessary files up-to-date. +`$GIT_DIR/hooks/post-update.sample` copied from the standard templates +would contain a call to 'git-update-server-info' +but you need to manually enable the hook with +`mv post-update.sample post-update`. This makes sure +'git-update-server-info' keeps the necessary files up-to-date. 3. Push into the public repository from your primary repository. diff --git a/rev-list-options.txt b/rev-list-options.txt index be8472178..1d857559e 100644 --- a/rev-list-options.txt +++ b/rev-list-options.txt @@ -71,7 +71,7 @@ For example, if you have this topology: o---x---a---a branch A ----------------------------------------------------------------------- + -you would get an output line this: +you would get an output like this: + ----------------------------------------------------------------------- $ git rev-list --left-right --boundary --pretty=oneline A...B diff --git a/user-manual.html b/user-manual.html index 07aa71a41..6fb4301ce 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 @@ -736,7 +736,7 @@ a directory that is exported by the web server, and make some adjustments to give web clients some extra information they need: $Â mvÂ proj.gitÂ /home/you/public_html/proj.git $Â cdÂ proj.git $Â gitÂ --bareÂ update-server-info -$Â chmodÂ a+xÂ hooks/post-update (For an explanation of the last two lines, see +$Â mvÂ hooks/post-update.sampleÂ hooks/post-update (For an explanation of the last two lines, see git-update-server-info(1) and githooks(5).) Advertise the URL of proj.git. Anybody else should then be able to clone or pull from that URL, for example with a command line like: $Â gitÂ cloneÂ http://yourserver.com/~you/proj.git (See also setup-git-server-over-http diff --git a/user-manual.txt b/user-manual.txt index e99921108..08d1310bf 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -1890,7 +1890,7 @@ adjustments to give web clients some extra information they need: $ mv proj.git /home/you/public_html/proj.git $ cd proj.git $ git --bare update-server-info -$ chmod a+x hooks/post-update +$ mv hooks/post-update.sample hooks/post-update ------------------------------------------------- (For an explanation of the last two lines, see -- 2.26.2