From: Junio C Hamano Date: Thu, 2 Nov 2006 00:22:59 +0000 (+0000) Subject: Autogenerated man pages for v1.4.3.3-g7854 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e50537c976962a59e4b0662ee17759ab6d42d914;p=git.git Autogenerated man pages for v1.4.3.3-g7854 --- diff --git a/man1/git-pack-objects.1 b/man1/git-pack-objects.1 index c2c6749a0..b4b7e2cd8 100755 --- a/man1/git-pack-objects.1 +++ b/man1/git-pack-objects.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-PACK\-OBJECTS" "1" "10/23/2006" "" "" +.TH "GIT\-PACK\-OBJECTS" "1" "11/02/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -30,7 +30,7 @@ In a packed archive, an object is either stored as a compressed whole, or as a d .SH "OPTIONS" .TP base\-name -Write into a pair of files (.pack and .idx), using to determine the name of the created file. When this option is used, the two files are written in \-.{pack,idx} files. is a hash of object names (currently in random order so it does not have any useful meaning) to make the resulting filename reasonably unique, and written to the standard output of the command. +Write into a pair of files (.pack and .idx), using to determine the name of the created file. When this option is used, the two files are written in \-.{pack,idx} files. is a hash of the sorted object names to make the resulting filename based on the pack content, and written to the standard output of the command. .TP \-\-stdout Write the pack contents (what would have been written to .pack file) out to the standard output. diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index 29305528b..cb8b48c2d 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-REPO\-CONFIG" "1" "10/24/2006" "" "" +.TH "GIT\-REPO\-CONFIG" "1" "11/02/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -218,9 +218,13 @@ core.preferSymlinkRefs Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link. .TP core.logAllRefUpdates -If true, -git\-update\-ref -will append a line to "$GIT_DIR/logs/" listing the new SHA1 and the date/time of the update. If the file does not exist it will be created automatically. This information can be used to determine what commit was the tip of a branch "2 days ago". This value is false by default (no logging). +Updates to a ref is logged to the file "$GIT_DIR/logs/", by appending the new and old SHA1, the date/time and the reason of the update, but only when the file exists. If this configuration variable is set to true, missing "$GIT_DIR/logs/" file is automatically created for branch heads. +.sp +.nf +This information can be used to determine what commit +was the tip of a branch "2 days ago". This value is +false by default (no automated creation of log files). +.fi .TP core.repositoryFormatVersion Internal variable identifying the repository format and layout version. diff --git a/man1/git-show-ref.1 b/man1/git-show-ref.1 new file mode 100755 index 000000000..961139791 --- /dev/null +++ b/man1/git-show-ref.1 @@ -0,0 +1,127 @@ +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "GIT\-SHOW\-REF" "1" "11/02/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-show\-ref \- List references in a local repository +.SH "SYNOPSIS" +.sp +.nf +\fIgit\-show\-ref\fR [\-q|\-\-quiet] [\-\-verify] [\-h|\-\-head] [\-d|\-\-dereference] + [\-s|\-\-hash] [\-\-abbrev] [\-\-tags] [\-\-heads] [\-\-] \&... +.fi +.SH "DESCRIPTION" +Displays references available in a local repository along with the associated commit IDs. Results can be filtered using a pattern and tags can be dereferenced into object IDs. Additionally, it can be used to test whether a particular ref exists. +.sp +Use of this utility is encouraged in favor of directly accessing files under in the .git directory. +.sp +.SH "OPTIONS" +.TP +\-h, \-\-head +Show the HEAD reference. +.TP +\-\-tags, \-\-heads +Limit to only "refs/heads" and "refs/tags", respectively. These options are not mutually exclusive; when given both, references stored in "refs/heads" and "refs/tags" are displayed. +.TP +\-d, \-\-dereference +Dereference tags into object IDs as well. They will be shown with "^{}" appended. +.TP +\-s, \-\-hash +Only show the SHA1 hash, not the reference name. When also using \-\-dereference the dereferenced tag will still be shown after the SHA1. +.TP +\-\-verify +Enable stricter reference checking by requiring an exact ref path. Aside from returning an error code of 1, it will also print an error message if +\fI\-\-quiet\fR +was not specified. +.TP +\-\-abbrev, \-\-abbrev=len +Abbreviate the object name. When using +\-\-hash, you do not have to say +\-\-hash \-\-abbrev; +\-\-hash=len +would do. +.TP +\-q, \-\-quiet +Do not print any results to stdout. When combined with +\fI\-\-verify\fR +this can be used to silently check if a reference exists. +.TP + +Show references matching one or more patterns. +.SH "OUTPUT" +The output is in the format: \fI\fR \fI\fR \fI\fR. +.sp +.sp +.nf +$ git show\-ref \-\-head \-\-dereference +832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD +832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master +832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin +3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c +6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{} +055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4 +423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{} +... +.fi +When using \-\-hash (and not \-\-dereference) the output format is: \fI\fR +.sp +.sp +.nf +$ git show\-ref \-\-heads \-\-hash +2e3ba0114a1f52b47df29743d6915d056be13278 +185008ae97960c8d551adcd9e23565194651b5d1 +03adf42c988195b50e1a1935ba5fcbc39b2b029b +... +.fi +.SH "EXAMPLE" +To show all references called "master", whether tags or heads or anything else, and regardless of how deep in the reference naming hierarchy they are, use: +.sp +.sp +.nf + git show\-ref master +.fi +This will show "refs/heads/master" but also "refs/remote/other\-repo/master", if such references exists. +.sp +When using the \fI\-\-verify\fR flag, the command requires an exact path: +.sp +.sp +.nf + git show\-ref \-\-verify refs/heads/master +.fi +will only match the exact branch called "master". +.sp +If nothing matches, \fBgit\-show\-ref\fR(1) will return an error code of 1, and in the case of verification, it will show an error message. +.sp +For scripting, you can ask it to be quiet with the "\-\-quiet" flag, which allows you to do things like +.sp +.sp +.nf + git\-show\-ref \-\-quiet \-\-verify \-\- "refs/heads/$headname" || + echo "$headname is not a valid branch" +.fi +to check whether a particular branch exists or not (notice how we don't actually want to show any results, and we want to use the full refname for it in order to not trigger the problem with ambiguous partial matches). +.sp +To show only tags, or only proper branch heads, use "\-\-tags" and/or "\-\-heads" respectively (using both means that it shows tags and heads, but not other random references under the refs/ subdirectory). +.sp +To do automatic tag object dereferencing, use the "\-d" or "\-\-dereference" flag, so you can do +.sp +.sp +.nf + git show\-ref \-\-tags \-\-dereference +.fi +to get a listing of all tags together with what they dereference. +.sp +.SH "SEE ALSO" +\fBgit\-ls\-remote\fR(1), \fBgit\-peek\-remote\fR(1) +.sp +.SH "AUTHORS" +Written by Linus Torvalds . Man page by Jonas Fonseca . +.sp +.SH "GIT" +Part of the \fBgit\fR(7) suite +.sp diff --git a/man1/git-update-ref.1 b/man1/git-update-ref.1 index d86d9d1d8..eb39badb9 100755 --- a/man1/git-update-ref.1 +++ b/man1/git-update-ref.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-UPDATE\-REF" "1" "10/03/2006" "" "" +.TH "GIT\-UPDATE\-REF" "1" "11/02/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,12 +10,12 @@ .SH "NAME" git\-update\-ref \- update the object name stored in a ref safely .SH "SYNOPSIS" -\fIgit\-update\-ref\fR [\-m ] [] +\fIgit\-update\-ref\fR [\-m ] (\-d | []) .sp .SH "DESCRIPTION" Given two arguments, stores the in the , possibly dereferencing the symbolic refs. E.g. git\-update\-ref HEAD updates the current branch head to the new object. .sp -Given three arguments, stores the in the , possibly dereferencing the symbolic refs, after verifying that the current value of the matches . E.g. git\-update\-ref refs/heads/master updates the master branch head to only if its current value is . +Given three arguments, stores the in the , possibly dereferencing the symbolic refs, after verifying that the current value of the matches . E.g. git\-update\-ref refs/heads/master updates the master branch head to only if its current value is . You can specify 40 "0" or an empty string as to make sure that the ref you are creating does not exist. .sp It also allows a "ref" file to be a symbolic pointer to another ref file by starting with the four\-byte header sequence of "ref:". .sp @@ -35,6 +35,8 @@ echo "$head" > "$GIT_DIR/HEAD" .fi both from a symlink following standpoint \fBand\fR an error checking standpoint. The "refs/" rule for symlinks means that symlinks that point to "outside" the tree are safe: they'll be followed for reading but not for writing (so we'll never write through a ref symlink to some other tree, if you have copied a whole archive by creating a symlink tree). .sp +With \-d flag, it deletes the named after verifying it still contains . +.sp .SH "LOGGING UPDATES" If config parameter "core.logAllRefUpdates" is true or the file "$GIT_DIR/logs/" exists then git\-update\-ref will append a line to the log file "$GIT_DIR/logs/" (dereferencing all symbolic refs before creating the log name) describing the change in ref value. Log lines are formatted as: .sp