{"thread":{"id":"2216","subject":"[PATCH] Documentation for git-shell","startedAt":"2005-10-25T09:09:37Z","lastAt":"2005-10-25T22:03:21Z","messageCount":3,"participants":["Petr Baudis"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"10566","messageId":"20051025090937.15206.50609.stgit@machine.or.cz","threadId":"2216","inReplyTo":null,"subject":"[PATCH] Documentation for git-shell","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2005-10-25T09:09:37Z","receivedAt":"2005-10-25T09:09:37Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"This adds some simple documentation for git-shell.\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git-shell.txt |   32 ++++++++++++++++++++++++++++++++\n 1 files changed, 32 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt\nnew file mode 100644\nindex 0000000..dfdfbf6\n--- /dev/null\n+++ b/Documentation/git-shell.txt\n@@ -0,0 +1,32 @@\n+git-shell(1)\n+============\n+\n+NAME\n+----\n+git-shell - Restricted login shell for GIT over SSH only\n+\n+\n+SYNOPSIS\n+--------\n+'git-shell -c <command> <argument>'\n+\n+DESCRIPTION\n+-----------\n+This is meant to be used as a login shell for SSH accounts you want\n+to restrict to GIT pull/push access only. It permits execution only\n+of two commands (`git-receive-pack` and `git-upload-pack`) with\n+a single argument. The commands can be executed only by the '-c'\n+option; the shell is not interactive.\n+\n+Author\n+------\n+Written by Linus Torvalds <torvalds@osdl.org>\n+\n+Documentation\n+--------------\n+Documentation by Petr Baudis and the git-list <git@vger.kernel.org>.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\n+\n"},{"id":"10614","messageId":"20051025214330.GI22079@pasky.or.cz","threadId":"2216","inReplyTo":"7vsluph6vx.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] Documentation for git-shell","fromName":"Petr Baudis","fromEmail":"pasky@ucw.cz","sentAt":"2005-10-25T21:43:30Z","receivedAt":"2005-10-25T21:43:30Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"Dear diary, on Tue, Oct 25, 2005 at 06:57:06PM CEST, I got a letter\nwhere Junio C Hamano <junkio@cox.net> told me that...\n> Thanks.  I'd leave the door open for possibility of future\n> command additions by saying what *kind* of things it is meant to\n> allow spawning first and then listing what commands we\n> *currently* allow next.\n> \n> Also we need a link to this in either Ancillary (in which\n> subsection I am not sure of, though) or Synching repository\n> section of git.txt.\n\nDone.\n\n---\n\n[PATCH] Documentation for git-shell\n\nThis adds some simple documentation for git-shell.\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git-shell.txt |   35 +++++++++++++++++++++++++++++++++++\n Documentation/git.txt       |    3 +++\n 2 files changed, 38 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt\nnew file mode 100644\nindex 0000000..3f4d804\n--- /dev/null\n+++ b/Documentation/git-shell.txt\n@@ -0,0 +1,35 @@\n+git-shell(1)\n+============\n+\n+NAME\n+----\n+git-shell - Restricted login shell for GIT over SSH only\n+\n+\n+SYNOPSIS\n+--------\n+'git-shell -c <command> <argument>'\n+\n+DESCRIPTION\n+-----------\n+This is meant to be used as a login shell for SSH accounts you want\n+to restrict to GIT pull/push access only. It permits execution only\n+of server-side GIT commands implementing the pull/push functionality.\n+The commands can be executed only by the '-c' option; the shell is not\n+interactive.\n+\n+Currently, only the `git-receive-pack` and `git-upload-pack` commands\n+are permitted to be called, with a single required argument.\n+\n+Author\n+------\n+Written by Linus Torvalds <torvalds@osdl.org>\n+\n+Documentation\n+--------------\n+Documentation by Petr Baudis and the git-list <git@vger.kernel.org>.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\n+\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 796c4f6..769054b 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -182,6 +182,9 @@ gitlink:git-receive-pack[1]::\n gitlink:git-send-pack[1]::\n \tPushes to a remote repository, intelligently.\n \n+gitlink:git-shell[1]::\n+\tRestricted shell for GIT-only SSH access.\n+\n gitlink:git-ssh-fetch[1]::\n \tPulls from a remote repository over ssh connection\n \tPreviously this command was known as git-ssh-pull.\n\n\n-- \n\t\t\t\tPetr \"Pasky\" Baudis\nStuff: http://pasky.or.cz/\nVI has two modes: the one in which it beeps and the one in which\nit doesn't.\n"},{"id":"10616","messageId":"20051025220321.GJ22079@pasky.or.cz","threadId":"2216","inReplyTo":"7vsluph6vx.fsf@assigned-by-dhcp.cox.net","subject":"[PATCH] Add some missing commands to the git.txt commands list","fromName":"Petr Baudis","fromEmail":"pasky@ucw.cz","sentAt":"2005-10-25T22:03:21Z","receivedAt":"2005-10-25T22:03:21Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"Dear diary, on Tue, Oct 25, 2005 at 06:57:06PM CEST, I got a letter\nwhere Junio C Hamano <junkio@cox.net> told me that...\n> Also we need a link to this in either Ancillary (in which\n> subsection I am not sure of, though) or Synching repository\n> section of git.txt.  I think we already lack links to a couple\n> of recent commands there, so somebody needs to do another sweep\n> of git.txt to make sure everything is listed.\n\nfor i in `l Documentation/*.txt | cut -d / -f 2 | cut -d . -f 1`; do\ngrep -q $i Documentation/git.txt || echo $i; done\n\nBut really, the more you have autogenerated, the better and more\nconsistent things are. In Cogito, I have all the documentation (usage\nstrings, synopsis, description, ...) at a _single_ place and everything\nelse (from command lists to various views of the docs) is autogenerated,\nand it's a great help at making things complete and consistent. Also,\nsince it's inside of the code, people actually tend to remember to\nupdate (and write in the first place) the documentation.\n\n\nBTW, as of now, it appears that only the commands git-findtags and\ngit-fmt-merge-msg are undocumented.\n\n---\n\n[PATCH] Add some missing commands to the git.txt commands list\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git.txt |   18 ++++++++++++++++++\n 1 files changed, 18 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 769054b..054f091 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -209,6 +209,9 @@ gitlink:git-add[1]::\n \tAdd paths to the index file.\n \tPreviously this command was known as git-add-script.\n \n+gitlink:git-am[1]::\n+\tApply patches from a mailbox, but cooler.\n+\n gitlink:git-applymbox[1]::\n \tApply patches from a mailbox.\n \n@@ -262,6 +265,9 @@ gitlink:git-ls-remote[1]::\n gitlink:git-merge[1]::\n \tGrand unified merge driver.\n \n+gitlink:git-mv[1]::\n+\tMove or rename a file, a directory, or a symlink.\n+\n gitlink:git-octopus[1]::\n \tMerge more than two commits.\n \tPreviously this command was known as git-octopus-script.\n@@ -347,6 +353,9 @@ gitlink:git-relink[1]::\n \tHardlink common objects in local repositories.\n \tPreviously this command was known as git-relink-script.\n \n+gitlink:git-svnimport[1]::\n+\tImport a SVN repository into git.\n+\n gitlink:git-sh-setup[1]::\n \tCommon git shell script setup code.\n \tPreviously this command was known as git-sh-setup-script.\n@@ -355,9 +364,15 @@ gitlink:git-tag[1]::\n \tAn example script to create a tag object signed with GPG\n \tPreviously this command was known as git-tag-script.\n \n+gitlink:git-update-ref[1]::\n+\tUpdate the object name stored in a ref safely.\n+\n \n Interrogators:\n \n+gitlink:git-check-ref-format[1]::\n+\tMake sure ref name is well formed.\n+\n gitlink:git-cherry[1]::\n \tFind commits not merged upstream.\n \n@@ -395,6 +410,9 @@ gitlink:git-send-email[1]::\n \tSend patch e-mails out of \"format-patch --mbox\" output.\n \tPreviously this command was known as git-send-email-script.\n \n+gitlink:git-symbolic-refs[1]::\n+\tRead and modify symbolic refs.\n+\n gitlink:git-stripspace[1]::\n \tFilter out empty lines.\n \n\n-- \n\t\t\t\tPetr \"Pasky\" Baudis\nStuff: http://pasky.or.cz/\nVI has two modes: the one in which it beeps and the one in which\nit doesn't.\n"}]}