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 0/6] Improve remote helper documentation
Date: Tue, 27 Nov 2012 18:44:33 +0100	[thread overview]
Message-ID: <1354038279-76475-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):
  Document invocation first, then input format
  Document missing remote helper capabilities
  Fix grammar
  Rearrange the description of remote helper capabilities
  Make clearer which commands must be supported for which capabilities
  Remove 'for-push' from ref list attributes list, link to subsections

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

-- 
1.8.0.393.gcc9701d

             reply	other threads:[~2012-11-27 17:45 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-27 17:44 Max Horn [this message]
2012-11-27 17:44 ` [PATCH 1/6] Document invocation first, then input format Max Horn
2012-11-27 17:44 ` [PATCH 2/6] Document missing remote helper capabilities Max Horn
2012-11-27 17:44 ` [PATCH 3/6] Fix grammar Max Horn
2012-11-27 20:39   ` Junio C Hamano
2012-11-27 21:23     ` Max Horn
2012-11-27 22:02       ` Junio C Hamano
2012-11-27 17:44 ` [PATCH 4/6] Rearrange the description of remote helper capabilities Max Horn
2012-11-27 17:44 ` [PATCH 5/6] Make clearer which commands must be supported for which capabilities Max Horn
2012-11-27 17:44 ` [PATCH 6/6] Remove 'for-push' from ref list attributes list, link to subsections Max Horn
2012-12-07 19:09 ` [PATCH 0/6] Improve remote helper documentation Junio C Hamano
2012-12-07 20:26   ` Sverre Rabbelier
2012-12-07 21:41   ` Max Horn
2012-12-07 21:52     ` Junio C Hamano
2012-12-07 22:38       ` Max Horn
2012-12-12 22:22   ` Felipe Contreras

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=1354038279-76475-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).