Documentation/remote-helpers: explain capabilities first
authorJonathan Nieder <jrnieder@gmail.com>
Tue, 30 Aug 2011 03:56:08 +0000 (22:56 -0500)
committerJunio C Hamano <gitster@pobox.com>
Tue, 30 Aug 2011 04:25:57 +0000 (21:25 -0700)
commitb4fc8d6ac638723e4f4452752f8fb41efe1ec356
tree2eac2b46e25dfd451a1372900815341e1296cd43
parent826603d11813e56452dca52c9509e7a3d6a9b900
Documentation/remote-helpers: explain capabilities first

The current remote helper documentation is from the perspective of
git, so to speak: it presents a full menu of commands for a person
invoking a remote helper to choose from.  In practice, that's less
useful than it could be, since the daunted novice remote-helper author
probably just wanted a list of commands needs to implement to get
started.  So preface the command list with an overview of each
capability, its purpose, and what commands it requires.

As a side effect, this makes it a little clearer that git doesn't
choose arbitrary commands to run, even if the remote helper advertises
all capabilities --- instead, there are well defined command sequences
for various tasks.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-remote-helpers.txt