[PATCH 3/3] doc/remote-helpers: document the gitdir feature
- From
Dmitry Ivankov <divanorama@gmail.com>
- Date
- Jul 12, 2011, 15:10 UTC
- Message-ID
- <1310483428-29833-4-git-send-email-divanorama@gmail.com>
- In-Reply-To
- <1310483428-29833-1-git-send-email-divanorama@gmail.com>
The gitdir capability is recognized by git and can be used to tell the helper where the .git directory is. But it is not mentioned in the documentation.
Document the gitdir feature. Upon reading this capability transport-helper sends out "gitdir path_to_dot_git" command to the helper. Which looks exactly like sending a command. So let's call this a command.
Signed-off-by: Dmitry Ivankov <divanorama@gmail.com> --- Documentation/git-remote-helpers.txt | 15 +++++++++++++++ 1 files changed, 15 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-remote-helpers.txt b/Documentation/git-remote-helpers.txt index 58f6ad4..a16a5e5 100644 --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -159,6 +159,14 @@ Supported if the helper has the "import" capability. + Supported if the helper has the "connect" capability. +'gitdir' <path>:: + Tells helper the location of current repository .git + directory. The path is absolute. The command is issued + immediately after "gitdir" capability line is read by + the caller. ++ +Supported if the helper has the "gitdir" capability. + If a fatal error occurs, the program writes the error message to stderr and exits. The caller should expect that a suitable error message has been printed if the child closes the connection without @@ -175,6 +183,7 @@ CAPABILITIES 'push':: 'import':: 'connect':: +'gitdir':: This helper supports the corresponding command with the same name. 'refspec' 'spec':: @@ -187,6 +196,12 @@ CAPABILITIES all, it must cover all refs reported by the list command; if it is not used, it is effectively "{asterisk}:{asterisk}" +'gitdir':: + The helper wants to know .git directory location. The gitdir + command is sent immediately after reading this capability. + The helper can read it immediately too or it can proceed with + reporting other capabilities and read it as a next command. + REF LIST ATTRIBUTES -------------------
-- 1.7.3.4