From 3a97102af4a6f91d1bbedf8e7b75d34633822ffa Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 18 Nov 2006 22:17:58 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.4.4-ge3d4 --- git-apply.html | 4 +- git-apply.txt | 2 +- git-runstatus.html | 362 +++++++++++++++++++++++++++++++++++++++++ git-runstatus.txt | 69 ++++++++ git.html | 10 +- git.txt | 3 + glossary.html | 14 +- glossary.txt | 7 + repository-layout.html | 16 +- repository-layout.txt | 14 +- 10 files changed, 485 insertions(+), 16 deletions(-) create mode 100644 git-runstatus.html create mode 100644 git-runstatus.txt diff --git a/git-apply.html b/git-apply.html index 18c90e94a..f71e40775 100644 --- a/git-apply.html +++ b/git-apply.html @@ -531,7 +531,7 @@ discouraged.

---inacurate-eof +--inaccurate-eof

@@ -582,7 +582,7 @@ apply.whitespace

diff --git a/git-apply.txt b/git-apply.txt index d9137c748..2cc32d1c5 100644 --- a/git-apply.txt +++ b/git-apply.txt @@ -150,7 +150,7 @@ discouraged. * `strip` outputs warnings for a few such errors, strips out the trailing whitespaces and applies the patch. ---inacurate-eof:: +--inaccurate-eof:: Under certain circumstances, some versions of diff do not correctly detect a missing new-line at the end of the file. As a result, patches created by such diff programs do not record incomplete lines diff --git a/git-runstatus.html b/git-runstatus.html new file mode 100644 index 000000000..ccbb05dc7 --- /dev/null +++ b/git-runstatus.html @@ -0,0 +1,362 @@ + + + + + + +git-runstatus(1) + + + +

SYNOPSIS

+
+

git-runstatus [--color|--nocolor] [--amend] [--verbose] [--untracked]

+
+

DESCRIPTION

+
+

Examines paths in the working tree that has changes unrecorded +to the index file, and changes between the index file and the +current HEAD commit. The former paths are what you _could_ +commit by running git-update-index before running git +commit, and the latter paths are what you _would_ commit by +running git commit.

+

If there is no path that is different between the index file and +the current HEAD commit, the command exits with non-zero status.

+

Note that this is _not_ the user level command you would want to +run from the command line. Use git-status instead.

+
+

OPTIONS

+
+
+
+--color +
+
+

+ Show colored status, highlighting modified file names. +

+
+
+--nocolor +
+
+

+ Turn off coloring. +

+
+
+--amend +
+
+

+ Show status based on HEAD^1, not HEAD, i.e. show what + git-commit --amend would do. +

+
+
+--verbose +
+
+

+ Show unified diff of all file changes. +

+
+
+--untracked +
+
+

+ Show files in untracked directories, too. Without this + option only its name and a trailing slash are displayed + for each untracked directory. +

+
+
+
+

OUTPUT

+
+

The output from this command is designed to be used as a commit +template comments, and all the output lines are prefixed with #.

+
+

Author

+
+

Originally written by Linus Torvalds <torvalds@osdl.org> as part +of git-commit, and later rewritten in C by Jeff King.

+
+

Documentation

+
+

Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.

+
+

GIT

+
+

Part of the git(7) suite

+
+ + + diff --git a/git-runstatus.txt b/git-runstatus.txt new file mode 100644 index 000000000..89d7b9273 --- /dev/null +++ b/git-runstatus.txt @@ -0,0 +1,69 @@ +git-runstatus(1) +================ + +NAME +---- +git-runstatus - A helper for git-status and git-commit + + +SYNOPSIS +-------- +'git-runstatus' [--color|--nocolor] [--amend] [--verbose] [--untracked] + + +DESCRIPTION +----------- +Examines paths in the working tree that has changes unrecorded +to the index file, and changes between the index file and the +current HEAD commit. The former paths are what you _could_ +commit by running 'git-update-index' before running 'git +commit', and the latter paths are what you _would_ commit by +running 'git commit'. + +If there is no path that is different between the index file and +the current HEAD commit, the command exits with non-zero status. + +Note that this is _not_ the user level command you would want to +run from the command line. Use 'git-status' instead. + + +OPTIONS +------- +--color:: + Show colored status, highlighting modified file names. + +--nocolor:: + Turn off coloring. + +--amend:: + Show status based on HEAD^1, not HEAD, i.e. show what + 'git-commit --amend' would do. + +--verbose:: + Show unified diff of all file changes. + +--untracked:: + Show files in untracked directories, too. Without this + option only its name and a trailing slash are displayed + for each untracked directory. + + +OUTPUT +------ +The output from this command is designed to be used as a commit +template comments, and all the output lines are prefixed with '#'. + + +Author +------ +Originally written by Linus Torvalds as part +of git-commit, and later rewritten in C by Jeff King. + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the gitlink:git[7] suite + diff --git a/git.html b/git.html index 5948232ed..7e2f436f4 100644 --- a/git.html +++ b/git.html @@ -940,6 +940,14 @@ ancillary user utilities.

+git-runstatus(1) +
+
+

+ A helper for git-status and git-commit. +

+
+
git-send-email(1)
@@ -2206,7 +2214,7 @@ contributors on the git-list <git@vger.kernel.org>.

diff --git a/git.txt b/git.txt index 52bc05ad5..619d65685 100644 --- a/git.txt +++ b/git.txt @@ -302,6 +302,9 @@ gitlink:git-request-pull[1]:: gitlink:git-rev-parse[1]:: Pick out and massage parameters. +gitlink:git-runstatus[1]:: + A helper for git-status and git-commit. + gitlink:git-send-email[1]:: Send patch e-mails out of "format-patch --mbox" output. diff --git a/glossary.html b/glossary.html index cb6ad8d6f..d3ba43928 100644 --- a/glossary.html +++ b/glossary.html @@ -860,6 +860,18 @@ div.exampleblock-content {

+symref +
+
+

+ Symbolic reference: instead of containing the SHA1 id + itself, it is of the format ref: refs/some/thing and when + referenced, it recursively dereferences to this reference. HEAD is a + prime example of a symref. Symbolic references are + manipulated with the ref.html">git-symbolic-ref(1) command. +

+
+
tag
@@ -968,7 +980,7 @@ the git-list <git@vger.kernel.org>.

diff --git a/glossary.txt b/glossary.txt index 7e560b0ee..894883d7b 100644 --- a/glossary.txt +++ b/glossary.txt @@ -282,6 +282,13 @@ SCM:: SHA1:: Synonym for object name. +symref:: + Symbolic reference: instead of containing the SHA1 id itself, it + is of the format 'ref: refs/some/thing' and when referenced, it + recursively dereferences to this reference. 'HEAD' is a prime + example of a symref. Symbolic references are manipulated with + the gitlink:git-symbolic-ref[1] command. + topic branch:: A regular git branch that is used by a developer to identify a conceptual line of development. Since branches diff --git a/repository-layout.html b/repository-layout.html index 90918067e..b3bff63be 100644 --- a/repository-layout.html +++ b/repository-layout.html @@ -390,12 +390,16 @@ HEAD

- A symlink of the form refs/heads/name to point at - the current branch, if exists. It does not mean much if - the repository is not associated with any working tree + A symref (see glossary) to the refs/heads/ namespace + describing the currently active branch. It does not mean + much if the repository is not associated with any working tree (i.e. a bare repository), but a valid git repository - must have such a symlink here. It is legal if the - named branch name does not (yet) exist. + must have the HEAD file; some porcelains may use it to + guess the designated "default" branch of the repository + (usually master). It is legal if the named branch + name does not (yet) exist. In some legacy setups, it is + a symbolic link instead of a symref that points at the current + branch.

@@ -523,7 +527,7 @@ logs/refs/tags/name diff --git a/repository-layout.txt b/repository-layout.txt index 275d18bb5..6d8c58ed2 100644 --- a/repository-layout.txt +++ b/repository-layout.txt @@ -70,12 +70,16 @@ refs/tags/`name`:: object, or a tag object that points at a commit object). HEAD:: - A symlink of the form `refs/heads/'name'` to point at - the current branch, if exists. It does not mean much if - the repository is not associated with any working tree + A symref (see glossary) to the `refs/heads/` namespace + describing the currently active branch. It does not mean + much if the repository is not associated with any working tree (i.e. a 'bare' repository), but a valid git repository - *must* have such a symlink here. It is legal if the - named branch 'name' does not (yet) exist. + *must* have the HEAD file; some porcelains may use it to + guess the designated "default" branch of the repository + (usually 'master'). It is legal if the named branch + 'name' does not (yet) exist. In some legacy setups, it is + a symbolic link instead of a symref that points at the current + branch. branches:: A slightly deprecated way to store shorthands to be used -- 2.26.2