From: Junio C Hamano Date: Mon, 2 Jun 2008 07:31:16 +0000 (+0000) Subject: Autogenerated HTML docs for v1.5.6-rc0-84-g06f60 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9e1793f616e87f4cb87e970250caa7b5ee8ad313;p=git.git Autogenerated HTML docs for v1.5.6-rc0-84-g06f60 --- diff --git a/git-init.html b/git-init.html index 75a80104c..a2e23c928 100644 --- a/git-init.html +++ b/git-init.html @@ -272,7 +272,7 @@ git-init(1) Manual Page

SYNOPSIS

-

git-init [-q | --quiet] [--template=<template_directory>] [--shared[=<permissions>]]

+

git-init [-q | --quiet] [--bare] [--template=<template_directory>] [--shared[=<permissions>]]

OPTIONS

@@ -286,6 +286,15 @@ Only print error and warning messages, all other output will be suppressed.

+--bare +
+
+

+Create a bare repository. If GIT_DIR environment is not set, it is set to the +current working directory. +

+
+
--template=<template_directory>
@@ -412,7 +421,7 @@ add all existing file to the index
diff --git a/git-init.txt b/git-init.txt index b17ae8485..b48c31289 100644 --- a/git-init.txt +++ b/git-init.txt @@ -8,7 +8,7 @@ git-init - Create an empty git repository or reinitialize an existing one SYNOPSIS -------- -'git-init' [-q | --quiet] [--template=] [--shared[=]] +'git-init' [-q | --quiet] [--bare] [--template=] [--shared[=]] OPTIONS @@ -20,6 +20,11 @@ OPTIONS Only print error and warning messages, all other output will be suppressed. +--bare:: + +Create a bare repository. If GIT_DIR environment is not set, it is set to the +current working directory. + --template=:: Provide the directory from which templates will be used. The default template diff --git a/git-svn.html b/git-svn.html index 16fec1961..111eb7ae8 100644 --- a/git-svn.html +++ b/git-svn.html @@ -888,10 +888,13 @@ These are only used with the dcommit and rebase commands.

-This is only used with the dcommit command. +This can be used with the dcommit and rebase commands.

-

Print out the series of git arguments that would show +

For dcommit, print out the series of git arguments that would show which diffs would be committed to SVN.

+

For rebase, display the local branch associated with the upstream svn +repository associated with the current branch and the URL of svn +repository that will be fetched from.

@@ -1171,7 +1174,7 @@ should be manually entered with a text-editor or using diff --git a/git-svn.txt b/git-svn.txt index c9e4efe7f..f4cbd2f21 100644 --- a/git-svn.txt +++ b/git-svn.txt @@ -365,11 +365,15 @@ Passed directly to git-rebase when using 'dcommit' if a -n:: --dry-run:: -This is only used with the 'dcommit' command. +This can be used with the 'dcommit' and 'rebase' commands. -Print out the series of git arguments that would show +For 'dcommit', print out the series of git arguments that would show which diffs would be committed to SVN. +For 'rebase', display the local branch associated with the upstream svn +repository associated with the current branch and the URL of svn +repository that will be fetched from. + -- ADVANCED OPTIONS diff --git a/git.html b/git.html index 3814b727f..a3ffd8cef 100644 --- a/git.html +++ b/git.html @@ -393,7 +393,7 @@ help ….

See the references above to get started using git. The following is probably more detail than necessary for a first-time user.

The git concepts chapter of the -user-manual and the Core tutorial both provide +user-manual and the gitcore-tutorial(7)[Core tutorial] both provide introductions to the underlying git architecture.

See also the howto documents for some useful examples.

@@ -1635,7 +1635,7 @@ HEAD

Terminology

-

Please see the glossary document.

+

Please see the gitglossary(7)[glossary] document.

Environment Variables

@@ -1875,7 +1875,7 @@ for further details.

More detail on the following is available from the git concepts chapter of the -user-manual and the Core tutorial.

+user-manual and the gitcore-tutorial(7)[Core tutorial].

A git project normally consists of a working directory with a ".git" subdirectory at the top level. The .git directory contains, among other things, a compressed object database representing the complete history @@ -1946,13 +1946,20 @@ General upbringing is handled by the git-list <git@vger.kernel.org>. <david@dgreaves.com>, and later enhanced greatly by the contributors on the git-list <git@vger.kernel.org>.

+

SEE ALSO

+

GIT

Part of the git(7) suite

diff --git a/git.txt b/git.txt index 7182bb7f7..dae1b4031 100644 --- a/git.txt +++ b/git.txt @@ -174,7 +174,7 @@ See the references above to get started using git. The following is probably more detail than necessary for a first-time user. The link:user-manual.html#git-concepts[git concepts chapter of the -user-manual] and the link:core-tutorial.html[Core tutorial] both provide +user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide introductions to the underlying git architecture. See also the link:howto-index.html[howto] documents for some useful @@ -374,7 +374,7 @@ Higher level SCMs may provide and manage additional information in the Terminology ----------- -Please see the link:glossary.html[glossary] document. +Please see the linkgit:gitglossary[7][glossary] document. Environment Variables @@ -518,7 +518,7 @@ Discussion[[Discussion]] More detail on the following is available from the link:user-manual.html#git-concepts[git concepts chapter of the -user-manual] and the link:core-tutorial.html[Core tutorial]. +user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial]. A git project normally consists of a working directory with a ".git" subdirectory at the top level. The .git directory contains, among other @@ -579,6 +579,13 @@ The documentation for git suite was started by David Greaves , and later enhanced greatly by the contributors on the git-list . +SEE ALSO +-------- +linkgit:gittutorial[7], linkgit:gittutorial-2[7], +linkgit:giteveryday[7], linkgit:gitcvs-migration[7], +linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], +link:user-manual.html[The Git User's Manual] + GIT --- Part of the linkgit:git[7] suite diff --git a/core-tutorial.html b/gitcore-tutorial.html similarity index 96% rename from core-tutorial.html rename to gitcore-tutorial.html index c80262f31..58468ee66 100644 --- a/core-tutorial.html +++ b/gitcore-tutorial.html @@ -226,6 +226,7 @@ td.hlist2 { @media print { div#footer-badges { display: none; } } +include::./stylesheets/xhtml11-manpage.css[] /* Workarounds for IE6's broken and incomplete CSS2. */ div.sidebar-content { @@ -255,13 +256,25 @@ div.exampleblock-content { padding-left: 0.5em; } -A git core tutorial for developers +gitcore-tutorial(7) +

SYNOPSIS

+
+

git *

-

Introduction

+

DESCRIPTION

This tutorial explains how to use the "core" git programs to set up and work with a git repository.

@@ -672,7 +685,7 @@ about the file already).

we've updated hello in the index, git-diff-files -p now shows no differences, but git-diff-index -p HEAD still *does* show that the current state is different from the state we committed. In fact, now -git-diff-index shows the same difference whether we use the —cached +git-diff-index shows the same difference whether we use the --cached flag or not, since now the index is coherent with the working tree.

Now, since we've updated hello in the index, we can commit the new version. We could do it by writing the tree by hand again, and @@ -756,7 +769,7 @@ diff-index | V

-

More interestingly, you can also give git-diff-tree the —pretty flag, +

More interestingly, you can also give git-diff-tree the --pretty flag, which tells it to also show the commit message and author and date of the commit, and you can tell it to show a whole series of diffs. Alternatively, you can tell it to be "silent", and not show the diffs at @@ -916,7 +929,7 @@ $ git-update-index --refresh It resets the index contents to HEAD, and then the git-update-index makes sure to match up all index entries with the checked-out files. If the original repository had uncommitted changes in its -working tree, git-update-index —refresh notices them and +working tree, git-update-index --refresh notices them and tells you they need to be updated.

The above can also be written as simply

@@ -1174,7 +1187,7 @@ see more complex cases.

Note
-Without the —more=1 option, git-show-branch would not output the +Without the --more=1 option, git-show-branch would not output the [master^] commit, as [mybranch] commit is a common ancestor of both master and mybranch tips. Please see git-show-branch documentation for details. @@ -1187,7 +1200,7 @@ documentation for details. If there were more commits on the master branch after the merge, the merge commit itself would not be shown by git-show-branch by -default. You would need to provide —sparse option to make the +default. You would need to provide --sparse option to make the merge commit visible in this case.
@@ -1506,7 +1519,7 @@ eventually calls merge program from RCS suite to perform a file-level 3-way merge. In this case, merge detects conflicts, and the merge result with conflict marks is left in the working tree.. This can be seen if you run ls-files -—stage again at this point:

+--stage again at this point:

$ git-ls-files --stage
@@ -1965,9 +1978,19 @@ and the reason why you preferred changes made in one side over
 the other.  Otherwise it would make the project history harder
 to follow, not easier.

+

SEE ALSO

+ +

GIT

+
+

Part of the git(7) suite.

+
diff --git a/core-tutorial.txt b/gitcore-tutorial.txt similarity index 99% rename from core-tutorial.txt rename to gitcore-tutorial.txt index b50b5dd48..5995a2e15 100644 --- a/core-tutorial.txt +++ b/gitcore-tutorial.txt @@ -1,8 +1,16 @@ -A git core tutorial for developers -================================== +gitcore-tutorial(7) +=================== -Introduction ------------- +NAME +---- +gitcore-tutorial - A git core tutorial for developers + +SYNOPSIS +-------- +git * + +DESCRIPTION +----------- This tutorial explains how to use the "core" git programs to set up and work with a git repository. @@ -1679,3 +1687,13 @@ merge two at a time, documenting how you resolved the conflicts, and the reason why you preferred changes made in one side over the other. Otherwise it would make the project history harder to follow, not easier. + +SEE ALSO +-------- +linkgit:gittutorial[7], linkgit:gittutorial-2[7], +linkgit:giteveryday[7], linkgit:gitcvs-migration[7], +link:user-manual.html[The Git User's Manual] + +GIT +--- +Part of the linkgit:git[7] suite. diff --git a/gitcvs-migration.html b/gitcvs-migration.html index 0de825b91..7625355d4 100644 --- a/gitcvs-migration.html +++ b/gitcvs-migration.html @@ -283,7 +283,7 @@ designating a single shared repository which people can synchronize with; this document explains how to do that.

Some basic familiarity with git is required. This gittutorial(7)[tutorial introduction to git] and the -git glossary should be sufficient.

+gitglossary(7)[git glossary] should be sufficient.

Developing against a shared repository

@@ -429,7 +429,10 @@ repositories without the need for a central maintainer.

SEE ALSO

@@ -439,7 +442,7 @@ repositories without the need for a central maintainer.

diff --git a/gitcvs-migration.txt b/gitcvs-migration.txt index c41080502..de02a4268 100644 --- a/gitcvs-migration.txt +++ b/gitcvs-migration.txt @@ -20,7 +20,7 @@ this document explains how to do that. Some basic familiarity with git is required. This linkgit:gittutorial[7][tutorial introduction to git] and the -link:glossary.html[git glossary] should be sufficient. +linkgit:gitglossary[7][git glossary] should be sufficient. Developing against a shared repository -------------------------------------- @@ -184,7 +184,10 @@ repositories without the need for a central maintainer. SEE ALSO -------- -linkgit:gittutorial[7], linkgit:gittutorial-2[7], +linkgit:gittutorial[7], +linkgit:gittutorial-2[7], +linkgit:gitcore-tutorial[7], +linkgit:gitglossary[7], link:everyday.html[Everyday Git], link:user-manual.html[The Git User's Manual] diff --git a/glossary.html b/gitglossary.html similarity index 92% rename from glossary.html rename to gitglossary.html index fbdc63365..b0d4c8675 100644 --- a/glossary.html +++ b/gitglossary.html @@ -226,6 +226,7 @@ td.hlist2 { @media print { div#footer-badges { display: none; } } +include::./stylesheets/xhtml11-manpage.css[] /* Workarounds for IE6's broken and incomplete CSS2. */ div.sidebar-content { @@ -255,13 +256,25 @@ div.exampleblock-content { padding-left: 0.5em; } -GIT Glossary +gitglossary(7) +

SYNOPSIS

+
+

*

-
+

DESCRIPTION

@@ -421,11 +434,10 @@ to point at the new commit.

- Directed acyclic graph. The commit objects form a + Directed acyclic graph. The commit objects form a directed acyclic graph, because they have parents (directed), and the - graph of commit objects is acyclic (there is no - chain which begins and ends with the same - object). + graph of commit objects is acyclic (there is no chain + which begins and ends with the same object).

@@ -709,9 +721,10 @@ This commit is referred to as a "merge commit", or sometimes just a

- One of the identifiers - "commit","tree","tag" or "blob" - describing the type of an object. + One of the identifiers "commit", + "tree", "tag" or + "blob" describing the type of an + object.

@@ -772,7 +785,7 @@ This commit is referred to as a "merge commit", or sometimes just a

The term pickaxe refers to an option to the diffcore routines that help select changes that add or delete a given text - string. With the —pickaxe-all option, it can be used to view the full + string. With the --pickaxe-all option, it can be used to view the full changeset that introduced or removed, say, a particular line of text. See git-diff(1).

@@ -954,7 +967,7 @@ This commit is referred to as a "merge commit", or sometimes just a parents, even though they are recorded in the commit object). This is sometimes useful when you are interested only in the recent history of a project even though the real history recorded in the upstream is much larger. A shallow repository - is created by giving the —depth option to git-clone(1), and + is created by giving the --depth option to git-clone(1), and its history can be later deepened with git-fetch(1).

@@ -1079,10 +1092,19 @@ This commit is referred to as a "merge commit", or sometimes just a
+

SEE ALSO

+ +

GIT

+
+

Part of the git(7) suite.

diff --git a/gitglossary.txt b/gitglossary.txt new file mode 100644 index 000000000..e8475a042 --- /dev/null +++ b/gitglossary.txt @@ -0,0 +1,25 @@ +gitglossary(7) +============== + +NAME +---- +gitglossary - A GIT Glossary + +SYNOPSIS +-------- +* + +DESCRIPTION +----------- + +include::glossary-content.txt[] + +SEE ALSO +-------- +linkgit:gittutorial[7], linkgit:gittutorial-2[7], +linkgit:giteveryday[7], linkgit:gitcvs-migration[7], +link:user-manual.html[The Git User's Manual] + +GIT +--- +Part of the linkgit:git[7] suite. diff --git a/gittutorial-2.html b/gittutorial-2.html index d04dbe0e6..37cc60c46 100644 --- a/gittutorial-2.html +++ b/gittutorial-2.html @@ -636,7 +636,7 @@ in the index file is identical to the one in the working directory.

In addition to being the staging area for new commits, the index file is also populated from the object database when checking out a branch, and is used to hold the trees involved in a merge operation. -See the core tutorial and the relevant man +See the gitcore-tutorial(7)[core tutorial] and the relevant man pages for details.

What next?

@@ -645,7 +645,7 @@ pages for details.

pages for any of the git commands; one good place to start would be with the commands mentioned in Everyday git. You should be able to find any unknown jargon in the -Glossary.

+gitglossary(7)[Glossary].

The Git User's Manual provides a more comprehensive introduction to git.

The gitcvs-migration(7)[CVS migration] document explains how to @@ -653,7 +653,7 @@ import a CVS repository into git, and shows how to use git in a CVS-like way.

For some interesting examples of git use, see the howtos.

-

For git developers, the Core tutorial goes +

For git developers, the gitcore-tutorial(7)[Core tutorial] goes into detail on the lower-level git mechanisms involved in, for example, creating a new commit.

@@ -661,6 +661,8 @@ example, creating a new commit.

@@ -670,7 +672,7 @@ example, creating a new commit.

diff --git a/gittutorial-2.txt b/gittutorial-2.txt index 5bbbf4305..4880ba9ae 100644 --- a/gittutorial-2.txt +++ b/gittutorial-2.txt @@ -390,7 +390,7 @@ in the index file is identical to the one in the working directory. In addition to being the staging area for new commits, the index file is also populated from the object database when checking out a branch, and is used to hold the trees involved in a merge operation. -See the link:core-tutorial.html[core tutorial] and the relevant man +See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man pages for details. What next? @@ -400,7 +400,7 @@ At this point you should know everything necessary to read the man pages for any of the git commands; one good place to start would be with the commands mentioned in link:everyday.html[Everyday git]. You should be able to find any unknown jargon in the -link:glossary.html[Glossary]. +linkgit:gitglossary[7][Glossary]. The link:user-manual.html[Git User's Manual] provides a more comprehensive introduction to git. @@ -412,7 +412,7 @@ CVS-like way. For some interesting examples of git use, see the link:howto-index.html[howtos]. -For git developers, the link:core-tutorial.html[Core tutorial] goes +For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes into detail on the lower-level git mechanisms involved in, for example, creating a new commit. @@ -420,6 +420,8 @@ SEE ALSO -------- linkgit:gittutorial[7], linkgit:gitcvs-migration[7], +linkgit:gitcore-tutorial[7], +linkgit:gitglossary[7], link:everyday.html[Everyday git], link:user-manual.html[The Git User's Manual] diff --git a/gittutorial.html b/gittutorial.html index 0f704b657..de893eb97 100644 --- a/gittutorial.html +++ b/gittutorial.html @@ -800,6 +800,8 @@ digressions that may be interesting at this point are:

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

diff --git a/gittutorial.txt b/gittutorial.txt index 898acdb53..722b32321 100644 --- a/gittutorial.txt +++ b/gittutorial.txt @@ -598,6 +598,8 @@ SEE ALSO -------- linkgit:gittutorial-2[7], linkgit:gitcvs-migration[7], +linkgit:gitcore-tutorial[7], +linkgit:gitglossary[7], link:everyday.html[Everyday git], link:user-manual.html[The Git User's Manual] diff --git a/glossary.txt b/glossary-content.txt similarity index 98% rename from glossary.txt rename to glossary-content.txt index 51b63532b..9b4a4f45e 100644 --- a/glossary.txt +++ b/glossary-content.txt @@ -1,6 +1,3 @@ -GIT Glossary -============ - [[def_alternate_object_database]]alternate object database:: Via the alternates mechanism, a <> can inherit part of its <> @@ -90,11 +87,10 @@ to point at the new commit. source code management tools. [[def_DAG]]DAG:: - Directed acyclic graph. The <> objects form a + Directed acyclic graph. The <> form a directed acyclic graph, because they have parents (directed), and the - graph of commit objects is acyclic (there is no - <> which begins and ends with the same - <>). + graph of commit objects is acyclic (there is no <> + which begins and ends with the same <>). [[def_dangling_object]]dangling object:: An <> which is not @@ -250,9 +246,10 @@ This commit is referred to as a "merge commit", or sometimes just a the <> of the object. [[def_object_type]]object type:: - One of the identifiers - "<>","<>","<>" or "<>" - describing the type of an <>. + One of the identifiers "<>", + "<>", "<>" or + "<>" describing the type of an + <>. [[def_octopus]]octopus:: To <> more than two <>. Also denotes an diff --git a/user-manual.html b/user-manual.html index 9b311aa71..67ddd6592 100644 --- a/user-manual.html +++ b/user-manual.html @@ -1949,11 +1949,10 @@ to point at the new commit.

DAG
- Directed acyclic graph. The commit objects form a + Directed acyclic graph. The commit objects form a directed acyclic graph, because they have parents (directed), and the - graph of commit objects is acyclic (there is no - chain which begins and ends with the same - object). + graph of commit objects is acyclic (there is no chain + which begins and ends with the same object).
dangling object
@@ -2132,9 +2131,10 @@ This commit is referred to as a "merge commit", or sometimes just a
object type
- One of the identifiers - "commit","tree","tag" or "blob" - describing the type of an object. + One of the identifiers "commit", + "tree", "tag" or + "blob" describing the type of an + object.
octopus
diff --git a/user-manual.txt b/user-manual.txt index fd8cdb625..bfde507e0 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -4252,7 +4252,10 @@ You see, Git is actually the best tool to find out about the source of Git itself! [[glossary]] -include::glossary.txt[] +GIT Glossary +============ + +include::glossary-content.txt[] [[git-quick-start]] Appendix A: Git Quick Reference