[PATCH v2 0/6] Improve remote helper documentation
- From
Max Horn <max@quendi.de>
- Date
- Nov 27, 2012, 23:03 UTC
- Message-ID
- <1354057407-83151-1-git-send-email-max@quendi.de>
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