summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorEric W. Biederman <ebiederm@xmission.com>2005-07-15 00:55:09 (GMT)
committerLinus Torvalds <torvalds@g5.osdl.org>2005-07-15 17:00:35 (GMT)
commitaed022ab4ca1055e1c962b73e14dbf41380f84a9 (patch)
treebf985ca03841840bc8ea3fc6620f192a8c83c833 /Documentation
parent7a868a84143c0bad2dce3fd0337320524436da27 (diff)
downloadgit-aed022ab4ca1055e1c962b73e14dbf41380f84a9.zip
git-aed022ab4ca1055e1c962b73e14dbf41380f84a9.tar.gz
git-aed022ab4ca1055e1c962b73e14dbf41380f84a9.tar.bz2
[PATCH] Add git-var a tool for reading interesting git variables.
Sharing code between shell scripts and C is a challenge. The program git-var allows us to have a set of named values that a shell script can interrogate and a normal C program can simply call the functions that compute them. Allowing sharing when computing plain test values. Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-var.txt60
-rw-r--r--Documentation/git.txt3
2 files changed, 63 insertions, 0 deletions
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
new file mode 100644
index 0000000..5a27d44
--- /dev/null
+++ b/Documentation/git-var.txt
@@ -0,0 +1,60 @@
+git-var(1)
+==================
+v0.1, July 2005
+
+NAME
+----
+git-var - Print the git users identity
+
+
+SYNOPSIS
+--------
+git-var [ -l | <variable> ]
+
+DESCRIPTION
+-----------
+Prints a git logical variable.
+
+-l causes the logical variables to be listed.
+
+EXAMPLE
+--------
+$git-var GIT_AUTHOR_IDENT
+
+Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600
+
+
+VARIABLES
+----------
+GIT_AUTHOR_IDENT
+ The author of a piece of code.
+
+GIT_COMMITTER_IDENT
+ The person who put a piece of code into git.
+
+Diagnostics
+-----------
+You don't exist. Go away!::
+ The passwd(5) gecos field couldn't be read
+Your parents must have hated you!::
+ The password(5) gecos field is longer than a giant static buffer.
+Your sysadmin must hate you!::
+ The password(5) name field is longer than a giant static buffer.
+
+See Also
+--------
+link:git-commit-tree.html[git-commit-tree]
+link:git-tag-script.html[git-tag-script]
+
+Author
+------
+Written by Eric Biederman <ebiederm@xmission.com>
+
+Documentation
+--------------
+Documentation by Eric Biederman and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
+
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 9e34146..916a0b7 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -111,6 +111,9 @@ link:git-tar-tree.html[git-tar-tree]::
link:git-unpack-file.html[git-unpack-file]::
Creates a temporary file with a blob's contents
+link:git-var.html[git-var]::
+ Displays a git logical variable
+
link:git-verify-pack.html[git-verify-pack]::
Validates packed GIT archive files