Subject: Re: [PATCH 1/2] shell doc: emphasize purpose and security model

From: Junio C Hamano <[email-masked]>
Date: Sun, 10 Feb 2013 23:10:44 -0800

Jonathan Nieder <[email-masked]> writes:

> diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt
> index 9b925060..4fe93203 100644
> --- a/Documentation/git-shell.txt
> +++ b/Documentation/git-shell.txt
> @@ -9,25 +9,61 @@ git-shell - Restricted login shell for Git-only SSH access
>  SYNOPSIS
>  --------
>  [verse]
> -'git shell' [-c <command> <argument>]
> +'chsh' -s $(which git-shell) git

<review type="nitpick" mode="posix-police">
Please don't use "which" in scripts.  Perhaps "command -v" is more
suitable here.
</review>

Otherwise looks good to me.  Thanks.

> +'git clone' `git@localhost:/path/to/repo.git`
> +'ssh' `git@localhost`
>  
>  DESCRIPTION
>  -----------
>  
> +This is a login shell for SSH accounts to provide restricted Git access.
> +It permits execution only of server-side Git commands implementing the
> +pull/push functionality, plus custom commands present in a subdirectory
> +named `git-shell-commands` in the user's home directory.
> +
> +COMMANDS
> +--------
> +
> +'git shell' accepts the following commands after the '-c' option:
> +
> +'git receive-pack <argument>'::
> +'git upload-pack <argument>'::
> +'git upload-archive <argument>'::
> +	Call the corresponding server-side command to support
> +	the client's 'git push', 'git fetch', or 'git archive --remote'
> +	request.
> +'cvs server'::
> +	Imitate a CVS server.  See linkgit:git-cvsserver[1].
> +
> +If a `~/git-shell-commands` directory is present, 'git shell' will
> +also handle other, custom commands by running
> +"`git-shell-commands/<command> <arguments>`" from the user's home
> +directory.
> +
> +INTERACTIVE USE
> +---------------
> +
> +By default, the commands above can be executed only with the '-c'
> +option; the shell is not interactive.
> +
> +If a `~/git-shell-commands` directory is present, 'git shell'
> +can also be run interactively (with no arguments).  If a `help`
> +command is present in the `git-shell-commands` directory, it is
> +run to provide the user with an overview of allowed actions.  Then a
> +"`git> `" prompt is presented at which one can enter any of the
> +commands from the `git-shell-commands` directory, or `exit` to close
> +the connection.
> +
> +Generally this mode is used as an administrative interface to allow
> +users to list repositories they have access to, create, delete, or
> +rename repositories, or change repository descriptions and
> +permissions.
> +
> +SEE ALSO
> +--------
> +ssh(1),
> +linkgit:git-daemon[1],
> +contrib/git-shell-commands/README
>  
>  GIT
>  ---