From ee1e428396a619659999df3e609e3d689173aaf5 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 4 Feb 2007 08:32:04 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.0-rc3-39-gec804 --- cmds-synchingrepositories.txt | 2 +- config.txt | 2 +- diff-format.txt | 2 +- git-config.html | 4 ++-- git-diff-files.html | 4 ++-- git-diff-index.html | 4 ++-- git-diff-stages.html | 4 ++-- git-diff-tree.html | 4 ++-- git-remote.html | 44 +++++++++++++++++++++++++++++------ git-remote.txt | 23 ++++++++++++++---- git-send-pack.html | 4 ++-- git-send-pack.txt | 2 +- git-svn.html | 4 ++-- git-svn.txt | 2 +- git.html | 4 ++-- gitk.html | 4 ++-- gitk.txt | 2 +- tutorial.html | 8 +++---- tutorial.txt | 6 ++--- user-manual.html | 12 +++++----- user-manual.txt | 10 ++++---- 21 files changed, 98 insertions(+), 53 deletions(-) diff --git a/cmds-synchingrepositories.txt b/cmds-synchingrepositories.txt index 736818f0c..5c6075dca 100644 --- a/cmds-synchingrepositories.txt +++ b/cmds-synchingrepositories.txt @@ -8,7 +8,7 @@ gitlink:git-local-fetch[1]:: Duplicate another git repository on a local system. gitlink:git-send-pack[1]:: - Push objects over git protocol to another reposiotory. + Push objects over git protocol to another repository. gitlink:git-ssh-fetch[1]:: Fetch from a remote repository over ssh connection. diff --git a/config.txt b/config.txt index e5e019fed..4e650af01 100644 --- a/config.txt +++ b/config.txt @@ -39,7 +39,7 @@ in the section header, like in example below: Subsection names can contain any characters except newline (doublequote '`"`' and backslash have to be escaped as '`\"`' and '`\\`', -respecitvely) and are case sensitive. Section header cannot span multiple +respectively) and are case sensitive. Section header cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have `[section]` if you have `[section "subsection"]`, but you don't need to. diff --git a/diff-format.txt b/diff-format.txt index 883c1bb0a..378e72f38 100644 --- a/diff-format.txt +++ b/diff-format.txt @@ -159,7 +159,7 @@ or like this (when '--cc' option is used): deleted file mode , + The `mode ,..` line appears only if at least one of -the is diferent from the rest. Extended headers with +the is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two and are not used by combined diff format. diff --git a/git-config.html b/git-config.html index 0f2104bf2..49a627709 100644 --- a/git-config.html +++ b/git-config.html @@ -592,7 +592,7 @@ in the section header, like in example below:

Subsection names can contain any characters except newline (doublequote " and backslash have to be escaped as \" and \\, -respecitvely) and are case sensitive. Section header cannot span multiple +respectively) and are case sensitive. Section header cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have [section] if you have [section "subsection"], but you don't need to.

@@ -1395,7 +1395,7 @@ transfer.unpackLimit diff --git a/git-diff-files.html b/git-diff-files.html index ea184a542..7405535ce 100644 --- a/git-diff-files.html +++ b/git-diff-files.html @@ -922,7 +922,7 @@ new file mode <mode> deleted file mode <mode>,<mode>

The mode <mode>,<mode>..<mode> line appears only if at least one of -the <mode> is diferent from the rest. Extended headers with +the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two <tree-ish> and are not used by combined diff format.

@@ -995,7 +995,7 @@ two unresolved merge parents with the working tree file diff --git a/git-diff-index.html b/git-diff-index.html index a0d25fb44..8fea5dede 100644 --- a/git-diff-index.html +++ b/git-diff-index.html @@ -918,7 +918,7 @@ new file mode <mode> deleted file mode <mode>,<mode>

The mode <mode>,<mode>..<mode> line appears only if at least one of -the <mode> is diferent from the rest. Extended headers with +the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two <tree-ish> and are not used by combined diff format.

@@ -1085,7 +1085,7 @@ always have the special all-zero sha1. diff --git a/git-diff-stages.html b/git-diff-stages.html index 8fc33a4f7..6938a2e7a 100644 --- a/git-diff-stages.html +++ b/git-diff-stages.html @@ -896,7 +896,7 @@ new file mode <mode> deleted file mode <mode>,<mode>

The mode <mode>,<mode>..<mode> line appears only if at least one of -the <mode> is diferent from the rest. Extended headers with +the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two <tree-ish> and are not used by combined diff format.

@@ -969,7 +969,7 @@ two unresolved merge parents with the working tree file diff --git a/git-diff-tree.html b/git-diff-tree.html index 89f313911..2920f5f2c 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html @@ -1216,7 +1216,7 @@ new file mode <mode> deleted file mode <mode>,<mode>

The mode <mode>,<mode>..<mode> line appears only if at least one of -the <mode> is diferent from the rest. Extended headers with +the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two <tree-ish> and are not used by combined diff format.

@@ -1289,7 +1289,7 @@ two unresolved merge parents with the working tree file diff --git a/git-remote.html b/git-remote.html index 45e476cba..f00c00ca6 100644 --- a/git-remote.html +++ b/git-remote.html @@ -281,14 +281,44 @@ git-remote(1) Manual Page

DESCRIPTION

Manage the set of repositories ("remotes") whose branches you track.

-

With no arguments, shows a list of existing remotes.

-

In the second form, adds a remote named <name> for the repository at +

+

COMMANDS

+
+

With no arguments, shows a list of existing remotes. Several +subcommands are available to perform operations on the remotes.

+
+
+add +
+
+

+Adds a remote named <name> for the repository at <url>. The command git fetch <name> can then be used to create and -update remote-tracking branches <name>/<branch>.

-

In the third form, gives some information about the remote <name>.

-

In the fourth form, deletes all stale tracking branches under <name>. +update remote-tracking branches <name>/<branch>. +

+
+
+show +
+
+

+Gives some information about the remote <name>. +

+
+
+prune +
+
+

+Deletes all stale tracking branches under <name>. These stale branches have already been removed from the remote repository -referenced by <name>, but are still locally available in "remotes/<name>".

+referenced by <name>, but are still locally available in "remotes/<name>". +

+
+
+
+

DISCUSSION

+

The remote configuration is achieved using the remote.origin.url and remote.origin.fetch configuration variables. (See git-config(1)).

@@ -336,7 +366,7 @@ $ git checkout -b nfs linux-nfs/master
diff --git a/git-remote.txt b/git-remote.txt index 817651eaa..a60c31a31 100644 --- a/git-remote.txt +++ b/git-remote.txt @@ -19,18 +19,33 @@ DESCRIPTION Manage the set of repositories ("remotes") whose branches you track. -With no arguments, shows a list of existing remotes. -In the second form, adds a remote named for the repository at +COMMANDS +-------- + +With no arguments, shows a list of existing remotes. Several +subcommands are available to perform operations on the remotes. + +'add':: + +Adds a remote named for the repository at . The command `git fetch ` can then be used to create and update remote-tracking branches /. -In the third form, gives some information about the remote . +'show':: -In the fourth form, deletes all stale tracking branches under . +Gives some information about the remote . + +'prune':: + +Deletes all stale tracking branches under . These stale branches have already been removed from the remote repository referenced by , but are still locally available in "remotes/". + +DISCUSSION +---------- + The remote configuration is achieved using the `remote.origin.url` and `remote.origin.fetch` configuration variables. (See gitlink:git-config[1]). diff --git a/git-send-pack.html b/git-send-pack.html index b308f3525..555b9f563 100644 --- a/git-send-pack.html +++ b/git-send-pack.html @@ -266,7 +266,7 @@ git-send-pack(1) Manual Page

NAME

git-send-pack - - Push objects over git protocol to another reposiotory + Push objects over git protocol to another repository

@@ -443,7 +443,7 @@ to disable the fast-forward check only on that ref.

diff --git a/git-send-pack.txt b/git-send-pack.txt index 2f6267ce6..205bfd2d2 100644 --- a/git-send-pack.txt +++ b/git-send-pack.txt @@ -3,7 +3,7 @@ git-send-pack(1) NAME ---- -git-send-pack - Push objects over git protocol to another reposiotory +git-send-pack - Push objects over git protocol to another repository SYNOPSIS diff --git a/git-svn.html b/git-svn.html index f97fd5c7b..b4221ec5a 100644 --- a/git-svn.html +++ b/git-svn.html @@ -451,7 +451,7 @@ manually joining branches on commit.

This command supports git-svnimport-like command-line syntax for - importing repositories that are layed out as recommended by the + importing repositories that are laid out as recommended by the SVN folks. This is a bit more tolerant than the git-svnimport command-line syntax and doesn't require the user to figure out where the repository URL ends and where the repository path @@ -911,7 +911,7 @@ detect them.

diff --git a/git-svn.txt b/git-svn.txt index aea4a6bf5..6ce6a3944 100644 --- a/git-svn.txt +++ b/git-svn.txt @@ -133,7 +133,7 @@ manually joining branches on commit. 'multi-init':: This command supports git-svnimport-like command-line syntax for - importing repositories that are layed out as recommended by the + importing repositories that are laid out as recommended by the SVN folks. This is a bit more tolerant than the git-svnimport command-line syntax and doesn't require the user to figure out where the repository URL ends and where the repository path diff --git a/git.html b/git.html index fabd0151c..30fadd4f7 100644 --- a/git.html +++ b/git.html @@ -1251,7 +1251,7 @@ the working tree.

- Push objects over git protocol to another reposiotory. + Push objects over git protocol to another repository.

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

diff --git a/gitk.html b/gitk.html index ca2d45d07..157d88ad9 100644 --- a/gitk.html +++ b/gitk.html @@ -341,7 +341,7 @@ frequently used options.

Limit commits to the ones touching files in the given paths. Note, to avoid ambiguity wrt. revision names use "--" to separate the paths - from any preceeding options. + from any preceding options.

@@ -425,7 +425,7 @@ gitk --max-count=100 --all — Makefile diff --git a/gitk.txt b/gitk.txt index 5bdaa601f..48c589473 100644 --- a/gitk.txt +++ b/gitk.txt @@ -54,7 +54,7 @@ frequently used options. Limit commits to the ones touching files in the given paths. Note, to avoid ambiguity wrt. revision names use "--" to separate the paths - from any preceeding options. + from any preceding options. Examples -------- diff --git a/tutorial.html b/tutorial.html index 34b45f62a..59b541ef9 100644 --- a/tutorial.html +++ b/tutorial.html @@ -648,9 +648,9 @@ $ git reset --hard HEAD^ # reset your current branch and working

Be careful with that last command: in addition to losing any changes in the working directory, it will also remove all later commits from this branch. If this branch is the only branch containing those -commits, they will be lost. (Also, don't use "git reset" on a -publicly-visible branch that other developers pull from, as git will -be confused by history that disappears in this way.)

+commits, they will be lost. Also, don't use "git reset" on a +publicly-visible branch that other developers pull from, as it will +force needless merges on other developers to clean up the history.

The git grep command can search for strings in any version of your project, so

@@ -779,7 +779,7 @@ digressions that may be interesting at this point are:

diff --git a/tutorial.txt b/tutorial.txt index ea3418909..5fc5be5a2 100644 --- a/tutorial.txt +++ b/tutorial.txt @@ -458,9 +458,9 @@ $ git reset --hard HEAD^ # reset your current branch and working Be careful with that last command: in addition to losing any changes in the working directory, it will also remove all later commits from this branch. If this branch is the only branch containing those -commits, they will be lost. (Also, don't use "git reset" on a -publicly-visible branch that other developers pull from, as git will -be confused by history that disappears in this way.) +commits, they will be lost. Also, don't use "git reset" on a +publicly-visible branch that other developers pull from, as it will +force needless merges on other developers to clean up the history. The git grep command can search for strings in any version of your project, so diff --git a/user-manual.html b/user-manual.html index 9a44a3d15..6d59d179d 100644 --- a/user-manual.html +++ b/user-manual.html @@ -1,4 +1,4 @@ -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
Undestanding 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 @@ -75,7 +75,7 @@ $ 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
Undestanding 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 @@ -168,7 +168,7 @@ 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.

Undestanding 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
        /
@@ -358,7 +358,7 @@ $
 commits since v2.5 which touch the Makefile or any file under fs:
$ git log v2.5.. Makefile fs/
You can also ask git log to show patches:
$ git log -p
See the "—pretty" option in the git-log(1) man page for more
 display options.
Note that git log starts with the most recent commit and works
 backwards through the parents; however, since git history can contain
-multiple independant lines of development, the particular order that
+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 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 @@ -433,7 +433,7 @@ produce no output at that point.

Modifying the index is easy:

To upd is what you'd commit if you created the commit now—and that

$ git diff

shows the difference between the working tree and the index file.

Note that "git add" always adds just the current contents of a file to the index; further changes to the same file will be ignored unless you run git-add on the file again.

When you're ready, just run

$ git commit

and git will prompt you for a commit message and then create the new -commmit. Check to make sure it looks like what you expected with

$ git show

As a special shortcut,

$ git commit -a

will update the index with any files that you've modified or removed +commit. Check to make sure it looks like what you expected with

$ git show

As a special shortcut,

$ git commit -a

will update the index with any files that you've modified or removed and create a commit, all in one step.

A number of commands are useful for keeping track of what you're about to commit:

$ git diff --cached # difference between HEAD and the index; what
                    # would be commited if you ran "commit" now.
@@ -1643,5 +1643,5 @@ section: diff -1, -2, -3, —ours, —theirs :1:/path notation. The actually. And note gitk —merge.

Add more good examples. Entire sections of just cookbook examples might be a good idea; maybe make an "advanced examples" section a standard end-of-chapter section?

Include cross-references to the glossary, where appropriate.

Document shallow clones? See draft 1.5.0 release notes for some -documentation.

Add a sectin on working with other version control systems, including +documentation.

Add a section on working with other version control systems, including CVS, Subversion, and just imports of series of release tarballs.

More details on gitweb?

Write a chapter on using plumbing and writing scripts.

diff --git a/user-manual.txt b/user-manual.txt index 6576625fa..c5e9ea8a4 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -425,8 +425,8 @@ 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. -Undestanding history: History diagrams -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +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 @@ -806,7 +806,7 @@ display options. Note that git log starts with the most recent commit and works backwards through the parents; however, since git history can contain -multiple independant lines of development, the particular order that +multiple independent lines of development, the particular order that commits are listed in may be somewhat arbitrary. Generating diffs @@ -1075,7 +1075,7 @@ $ git commit ------------------------------------------------- and git will prompt you for a commit message and then create the new -commmit. Check to make sure it looks like what you expected with +commit. Check to make sure it looks like what you expected with ------------------------------------------------- $ git show @@ -2953,7 +2953,7 @@ Include cross-references to the glossary, where appropriate. Document shallow clones? See draft 1.5.0 release notes for some documentation. -Add a sectin on working with other version control systems, including +Add a section on working with other version control systems, including CVS, Subversion, and just imports of series of release tarballs. More details on gitweb? -- 2.26.2