* Re: [PATCH] Documentation for git-shell
[not found] ` <7vsluph6vx.fsf@assigned-by-dhcp.cox.net>
@ 2005-10-25 21:43 ` Petr Baudis
2005-10-25 22:03 ` [PATCH] Add some missing commands to the git.txt commands list Petr Baudis
1 sibling, 0 replies; 3+ messages in thread
From: Petr Baudis @ 2005-10-25 21:43 UTC (permalink / raw)
To: Junio C Hamano; +Cc: gti
Dear diary, on Tue, Oct 25, 2005 at 06:57:06PM CEST, I got a letter
where Junio C Hamano <junkio@cox.net> told me that...
> Thanks. I'd leave the door open for possibility of future
> command additions by saying what *kind* of things it is meant to
> allow spawning first and then listing what commands we
> *currently* allow next.
>
> Also we need a link to this in either Ancillary (in which
> subsection I am not sure of, though) or Synching repository
> section of git.txt.
Done.
---
[PATCH] Documentation for git-shell
This adds some simple documentation for git-shell.
Signed-off-by: Petr Baudis <pasky@suse.cz>
---
Documentation/git-shell.txt | 35 +++++++++++++++++++++++++++++++++++
Documentation/git.txt | 3 +++
2 files changed, 38 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt
new file mode 100644
index 0000000..3f4d804
--- /dev/null
+++ b/Documentation/git-shell.txt
@@ -0,0 +1,35 @@
+git-shell(1)
+============
+
+NAME
+----
+git-shell - Restricted login shell for GIT over SSH only
+
+
+SYNOPSIS
+--------
+'git-shell -c <command> <argument>'
+
+DESCRIPTION
+-----------
+This is meant to be used as a login shell for SSH accounts you want
+to restrict to GIT pull/push access only. It permits execution only
+of server-side GIT commands implementing the pull/push functionality.
+The commands can be executed only by the '-c' option; the shell is not
+interactive.
+
+Currently, only the `git-receive-pack` and `git-upload-pack` commands
+are permitted to be called, with a single required argument.
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+Documentation
+--------------
+Documentation by Petr Baudis and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 796c4f6..769054b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -182,6 +182,9 @@ gitlink:git-receive-pack[1]::
gitlink:git-send-pack[1]::
Pushes to a remote repository, intelligently.
+gitlink:git-shell[1]::
+ Restricted shell for GIT-only SSH access.
+
gitlink:git-ssh-fetch[1]::
Pulls from a remote repository over ssh connection
Previously this command was known as git-ssh-pull.
--
Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
VI has two modes: the one in which it beeps and the one in which
it doesn't.
^ permalink raw reply related [flat|nested] 3+ messages in thread* [PATCH] Add some missing commands to the git.txt commands list
[not found] ` <7vsluph6vx.fsf@assigned-by-dhcp.cox.net>
2005-10-25 21:43 ` Petr Baudis
@ 2005-10-25 22:03 ` Petr Baudis
1 sibling, 0 replies; 3+ messages in thread
From: Petr Baudis @ 2005-10-25 22:03 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
Dear diary, on Tue, Oct 25, 2005 at 06:57:06PM CEST, I got a letter
where Junio C Hamano <junkio@cox.net> told me that...
> Also we need a link to this in either Ancillary (in which
> subsection I am not sure of, though) or Synching repository
> section of git.txt. I think we already lack links to a couple
> of recent commands there, so somebody needs to do another sweep
> of git.txt to make sure everything is listed.
for i in `l Documentation/*.txt | cut -d / -f 2 | cut -d . -f 1`; do
grep -q $i Documentation/git.txt || echo $i; done
But really, the more you have autogenerated, the better and more
consistent things are. In Cogito, I have all the documentation (usage
strings, synopsis, description, ...) at a _single_ place and everything
else (from command lists to various views of the docs) is autogenerated,
and it's a great help at making things complete and consistent. Also,
since it's inside of the code, people actually tend to remember to
update (and write in the first place) the documentation.
BTW, as of now, it appears that only the commands git-findtags and
git-fmt-merge-msg are undocumented.
---
[PATCH] Add some missing commands to the git.txt commands list
Signed-off-by: Petr Baudis <pasky@suse.cz>
---
Documentation/git.txt | 18 ++++++++++++++++++
1 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 769054b..054f091 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -209,6 +209,9 @@ gitlink:git-add[1]::
Add paths to the index file.
Previously this command was known as git-add-script.
+gitlink:git-am[1]::
+ Apply patches from a mailbox, but cooler.
+
gitlink:git-applymbox[1]::
Apply patches from a mailbox.
@@ -262,6 +265,9 @@ gitlink:git-ls-remote[1]::
gitlink:git-merge[1]::
Grand unified merge driver.
+gitlink:git-mv[1]::
+ Move or rename a file, a directory, or a symlink.
+
gitlink:git-octopus[1]::
Merge more than two commits.
Previously this command was known as git-octopus-script.
@@ -347,6 +353,9 @@ gitlink:git-relink[1]::
Hardlink common objects in local repositories.
Previously this command was known as git-relink-script.
+gitlink:git-svnimport[1]::
+ Import a SVN repository into git.
+
gitlink:git-sh-setup[1]::
Common git shell script setup code.
Previously this command was known as git-sh-setup-script.
@@ -355,9 +364,15 @@ gitlink:git-tag[1]::
An example script to create a tag object signed with GPG
Previously this command was known as git-tag-script.
+gitlink:git-update-ref[1]::
+ Update the object name stored in a ref safely.
+
Interrogators:
+gitlink:git-check-ref-format[1]::
+ Make sure ref name is well formed.
+
gitlink:git-cherry[1]::
Find commits not merged upstream.
@@ -395,6 +410,9 @@ gitlink:git-send-email[1]::
Send patch e-mails out of "format-patch --mbox" output.
Previously this command was known as git-send-email-script.
+gitlink:git-symbolic-refs[1]::
+ Read and modify symbolic refs.
+
gitlink:git-stripspace[1]::
Filter out empty lines.
--
Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
VI has two modes: the one in which it beeps and the one in which
it doesn't.
^ permalink raw reply related [flat|nested] 3+ messages in thread