From: Max Horn <max@quendi.de>
To: git@vger.kernel.org
Cc: Max Horn <max@quendi.de>
Subject: [PATCH v2 6/6] git-remote-helpers.txt: clarify options & ref list attributes
Date: Wed, 28 Nov 2012 00:03:26 +0100 [thread overview]
Message-ID: <1354057407-83151-7-git-send-email-max@quendi.de> (raw)
In-Reply-To: <1354057407-83151-1-git-send-email-max@quendi.de>
The documentation was misleading in that it gave the impression that
'for-push' could be used as a ref attribute in the output of the
'list' command. That is wrong.
Also, explicitly point out the connection between the commands
'list' and 'options' on the one hand, and the sections
'REF LIST ATTRIBUTES' and 'OPTIONS' on the other hand.
Signed-off-by: Max Horn <max@quendi.de>
---
Documentation/git-remote-helpers.txt | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt
index 023dcca..e1df01d 100644
--- a/Documentation/git-remote-helpers.txt
+++ b/Documentation/git-remote-helpers.txt
@@ -227,6 +227,8 @@ Support for this command is mandatory.
the name; unrecognized attributes are ignored. The list ends
with a blank line.
+
+See REF LIST ATTRIBUTES for a list of currently defined options.
++
Supported if the helper has the "fetch" or "import" capability.
'list for-push'::
@@ -248,6 +250,8 @@ Supported if the helper has the "push" or "export" capability.
for it). Options should be set before other commands,
and may influence the behavior of those commands.
+
+See OPTIONS for a list of currently defined options.
++
Supported if the helper has the "option" capability.
'fetch' <sha1> <name>::
@@ -256,7 +260,7 @@ Supported if the helper has the "option" capability.
per line, terminated with a blank line.
Outputs a single blank line when all fetch commands in the
same batch are complete. Only objects which were reported
- in the ref list with a sha1 may be fetched this way.
+ in the output of 'list' with a sha1 may be fetched this way.
+
Optionally may output a 'lock <file>' line indicating a file under
GIT_DIR/objects/pack which is keeping a pack until refs can be
@@ -360,10 +364,9 @@ capabilities reported by the helper.
REF LIST ATTRIBUTES
-------------------
-'for-push'::
- The caller wants to use the ref list to prepare push
- commands. A helper might chose to acquire the ref list by
- opening a different type of connection to the destination.
+The 'list' command produces a list of refs in which each ref
+may be followed by a list of attributes. The following ref list
+attributes are defined.
'unchanged'::
This ref is unchanged since the last import or fetch, although
@@ -371,6 +374,10 @@ REF LIST ATTRIBUTES
OPTIONS
-------
+
+The following options are defined and (under suitable circumstances)
+set by git if the remote helper has the 'option' capability.
+
'option verbosity' <n>::
Changes the verbosity of messages displayed by the helper.
A value of 0 for <n> means that processes operate
--
1.8.0.393.gcc9701d
next prev parent reply other threads:[~2012-11-27 23:04 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-11-27 23:03 [PATCH v2 0/6] Improve remote helper documentation Max Horn
2012-11-27 23:03 ` [PATCH v2 1/6] git-remote-helpers.txt: document invocation before input format Max Horn
2012-12-12 22:14 ` Felipe Contreras
2012-12-12 22:58 ` Max Horn
2012-12-12 23:00 ` Felipe Contreras
2012-12-12 23:05 ` Max Horn
2012-12-12 23:13 ` Junio C Hamano
2012-12-12 23:15 ` Max Horn
2012-12-12 23:03 ` Junio C Hamano
2012-11-27 23:03 ` [PATCH v2 2/6] git-remote-helpers.txt: document missing capabilities Max Horn
2012-11-27 23:03 ` [PATCH v2 3/6] git-remote-helpers.txt: minor grammar fix Max Horn
2012-11-27 23:03 ` [PATCH v2 4/6] git-remote-helpers.txt: rearrange description of capabilities Max Horn
2012-11-27 23:03 ` [PATCH v2 5/6] git-remote-helpers.txt: clarify command <-> capability correspondences Max Horn
2012-11-27 23:03 ` Max Horn [this message]
2012-11-27 23:03 ` [PATCH 6/6] git-remote-helpers.txt: clarify ref list attributes, link to subsections Max Horn
2012-11-27 23:06 ` Max Horn
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1354057407-83151-7-git-send-email-max@quendi.de \
--to=max@quendi.de \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).