summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-09-07 21:08:38 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-09-07 21:20:57 (GMT)
commit5077fa9c1e3af760dd3573ac94be6cb27ad74849 (patch)
tree5dce5d7765e1848ddd98e168498afd4bc98256d5 /Documentation
parent597c9cc540c2ca5d0b0eeaa3f453dffa14afab6d (diff)
downloadgit-5077fa9c1e3af760dd3573ac94be6cb27ad74849.zip
git-5077fa9c1e3af760dd3573ac94be6cb27ad74849.tar.gz
git-5077fa9c1e3af760dd3573ac94be6cb27ad74849.tar.bz2
Documentation updates.
parse-remote and rev-parse gets full documentation. Add skeleton for archimport. Link them from the main git(7) page. Also move git-daemon and git-request-pull out of 'undocumented' section. Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-archimport-script.txt42
-rw-r--r--Documentation/git-parse-remote-script.txt48
-rw-r--r--Documentation/git-rev-parse.txt65
-rw-r--r--Documentation/git.txt30
4 files changed, 167 insertions, 18 deletions
diff --git a/Documentation/git-archimport-script.txt b/Documentation/git-archimport-script.txt
new file mode 100644
index 0000000..134fbed
--- /dev/null
+++ b/Documentation/git-archimport-script.txt
@@ -0,0 +1,42 @@
+git-archimport-script(1)
+========================
+
+NAME
+----
+git-archimport-script - Import an arch repository into git
+
+
+SYNOPSIS
+--------
+`git-archimport-script` [--option...] <args>
+
+DESCRIPTION
+-----------
+The script expects you to provide the key roots where it can start the
+import from an 'initial import' or 'tag' type of Arch commit. It will
+then follow all the branching and tagging within the provided roots.
+
+It will die if it sees branches that have different roots.
+
+
+OPTIONS
+-------
+--option::
+ Some option not yet documented.
+
+<args>...::
+ Some argument not yet documented.
+
+
+Author
+------
+Written by Martin Langhoff <martin@catalyst.net.nz>.
+
+Documentation
+--------------
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
+
diff --git a/Documentation/git-parse-remote-script.txt b/Documentation/git-parse-remote-script.txt
new file mode 100644
index 0000000..d6e551f
--- /dev/null
+++ b/Documentation/git-parse-remote-script.txt
@@ -0,0 +1,48 @@
+git-parse-remote-script(1)
+==========================
+
+NAME
+----
+git-parse-remote-script - Routines to help parsing $GIT_DIR/remotes/
+
+
+SYNOPSIS
+--------
+'. git-parse-remote-script'
+
+DESCRIPTION
+-----------
+This script is included in various scripts to supply
+routines to parse files under $GIT_DIR/remotes/ and
+$GIT_DIR/branches/.
+
+The primary entry points are:
+
+get_remote_refs_for_fetch::
+ Given the list of user-supplied `<repo> <refspec>...`,
+ return the list of refs to fetch after canonicalizing
+ them into `$GIT_DIR` relative paths
+ (e.g. `refs/heads/foo`). When `<refspec>...` is empty
+ the returned list of refs consists of the defaults
+ for the given `<repo>`, if specified in
+ `$GIT_DIR/remotes/` or `$GIT_DIR/branches/`.
+
+get_remote_refs_for_push::
+ Given the list of user-supplied `<repo> <refspec>...`,
+ return the list of refs to push in a form suitable to be
+ fed to the `git-send-pack` command. When `<refspec>...`
+ is empty the returned list of refs consists of the
+ defaults for the given `<repo>`, if specified in
+ `$GIT_DIR/remotes/`.
+
+Author
+------
+Written by Junio C Hamano.
+
+Documentation
+--------------
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 592c2bd..fa64c5a 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -3,7 +3,7 @@ git-rev-parse(1)
NAME
----
-git-rev-parse - Some git command not yet documented.
+git-rev-parse - Pick out and massage parameters.
SYNOPSIS
@@ -12,21 +12,74 @@ SYNOPSIS
DESCRIPTION
-----------
-Does something not yet documented.
+
+Many git Porcelainish commands take mixture of flags
+(i.e. parameters that begin with a dash '-') and parameters
+meant for underlying `git-rev-list` command they use internally
+and flags and parameters for other commands they use as the
+downstream of `git-rev-list`. This command is used to
+distinguish between them.
OPTIONS
-------
---option::
- Some option not yet documented.
+--revs-only::
+ Do not output flags and parameters not meant for
+ `git-rev-list` command.
+
+--no-revs::
+ Do not output flags and parameters meant for
+ `git-rev-list` command.
+
+--flags::
+ Do not output non-flag parameters.
+
+--no-flags::
+ Do not output flag parameters.
+
+--default <arg>::
+ If there is no parameter given by the user, use `<arg>`
+ instead.
+
+--verify::
+ The parameter given must be usable as a single, valid
+ object name. Otherwise barf and abort.
+
+--sq::
+ Usually the output is made one line per flag and
+ parameter. This option makes output a single line,
+ properly quoted for consumption by shell. Useful when
+ you expect your parameter to contain whitespaces and
+ newlines (e.g. when using pickaxe `-S` with
+ `git-diff-\*`).
+
+--not::
+ When showing object names, prefix them with '^' and
+ strip '^' prefix from the object names that already have
+ one.
+
+--symbolic::
+ Usually the object names are output in SHA1 form (with
+ possible '^' prefix); this option makes them output in a
+ form as close to the original input as possible.
+
+
+--all::
+ Show all refs found in `$GIT_DIR/refs`.
+
+--show-prefix::
+ When the command is invoked from a directory show the
+ path of the current directory relative to the top-level
+ directory.
<args>...::
- Some argument not yet documented.
+ Flags and parameters to be parsed.
Author
------
-Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
+Written by Linus Torvalds <torvalds@osdl.org> and
+Junio C Hamano <junkio@cox.net>
Documentation
--------------
diff --git a/Documentation/git.txt b/Documentation/git.txt
index b10edff..b984cd5 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -274,6 +274,9 @@ Manipulators:
link:git-applypatch.html[git-applypatch]::
Apply one patch extracted from an e-mail.
+link:git-archimport-script.html[git-archimport-script]::
+ Import an arch repository into git.
+
link:git-convert-cache.html[git-convert-cache]::
Converts old-style GIT repository
@@ -304,9 +307,15 @@ link:git-cherry.html[git-cherry]::
link:git-count-objects-script.html[git-count-objects-script]::
Count unpacked number of objects and their disk consumption.
+link:git-daemon.html[git-daemon]::
+ A really simple server for GIT repositories.
+
link:git-diff-helper.html[git-diff-helper]::
Generates patch format output for git-diff-*
+link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
+ Extract commit ID from an archive created using git-tar-tree.
+
link:git-mailinfo.html[git-mailinfo]::
Extracts patch from a single e-mail message.
@@ -316,12 +325,18 @@ link:git-mailsplit.html[git-mailsplit]::
link:git-patch-id.html[git-patch-id]::
Compute unique ID for a patch.
+link:git-parse-remote-script.html[git-parse-remote-script]::
+ Routines to help parsing $GIT_DIR/remotes/
+
+link:git-request-pull-script.html[git-request-pull-script]::
+ git-request-pull-script.
+
+link:git-rev-parse.html[git-rev-parse]::
+ Pick out and massage parameters.
+
link:git-send-email-script.html[git-send-email]::
Send patch e-mails out of "format-patch --mbox" output.
-link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
- Extract commit ID from an archive created using git-tar-tree.
-
Commands not yet documented
---------------------------
@@ -331,24 +346,15 @@ link:git-build-rev-cache.html[git-build-rev-cache]::
link:git-checkout-script.html[git-checkout-script]::
git-checkout-script.
-link:git-daemon.html[git-daemon]::
- git-daemon.
-
link:git-diff-script.html[git-diff-script]::
git-diff-script.
link:git-format-patch-script.html[git-format-patch-script]::
git-format-patch-script.
-link:git-request-pull-script.html[git-request-pull-script]::
- git-request-pull-script.
-
link:git-reset-script.html[git-reset-script]::
git-reset-script.
-link:git-rev-parse.html[git-rev-parse]::
- git-rev-parse.
-
link:git-show-rev-cache.html[git-show-rev-cache]::
git-show-rev-cache.