git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Max Horn <max@quendi.de>
To: git@vger.kernel.org
Cc: Max Horn <max@quendi.de>
Subject: [PATCH v2 0/6] Improve remote helper documentation
Date: Wed, 28 Nov 2012 00:03:20 +0100	[thread overview]
Message-ID: <1354057407-83151-1-git-send-email-max@quendi.de> (raw)

Various remote helper capabilities and commands were not
documented, in particular 'export', or documented in a misleading
way (e.g. 'for-push' was listed as a ref attribute understood by
git, which is not the case). This patch series changes that, and
also address some other things in the remote helper documentation
that I found jarring when reading through it.

Note that the description of export and (im|ex)port-marks probably can be
improved, and I hope that somebody who knows more about them
than me and/or is better at writing documentation will do just that.
But I felt it was better to provide something than to do nothing
and only complain, as I did previously on this subject ;-).

Max Horn (6):
  git-remote-helpers.txt: document invocation before input format
  git-remote-helpers.txt: document missing capabilities
  git-remote-helpers.txt: minor grammar fix
  git-remote-helpers.txt: rearrange description of capabilities
  git-remote-helpers.txt: clarify command <-> capability correspondences
  git-remote-helpers.txt: clarify options & ref list attributes

 Documentation/git-remote-helpers.txt | 245 ++++++++++++++++++++---------------
 1 file changed, 140 insertions(+), 105 deletions(-)

-- 
1.8.0.393.gcc9701d

             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 Max Horn [this message]
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 ` [PATCH v2 6/6] git-remote-helpers.txt: clarify options & ref list attributes Max Horn
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-1-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).