{"thread":{"id":"2171","subject":"[PATCH 1/2] Brief documentation for the mysterious git-am script","startedAt":"2005-10-21T00:28:42Z","lastAt":"2005-10-21T00:28:45Z","messageCount":2,"participants":["Petr Baudis"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"10386","messageId":"20051021002842.26819.56707.stgit@machine.or.cz","threadId":"2171","inReplyTo":null,"subject":"[PATCH 1/2] Brief documentation for the mysterious git-am script","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2005-10-21T00:28:42Z","receivedAt":"2005-10-21T00:28:42Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"The git-am script is nowhere called and nowhere (including itself)\nexplained, and the name isn't helpful either. For those like me who will\nwonder what is it about, add some documentation stub for it to the\ndocumentation.\n\nI probably got something wrong and I don't feel like investigating all the\noptions - this is just kind of \"emergency\" docs.\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git-am.txt        |   51 +++++++++++++++++++++++++++++++++++++++\n Documentation/git-applymbox.txt |    2 +-\n git-applymbox.sh                |    2 ++\n 3 files changed, 54 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\nnew file mode 100644\nindex 0000000..c73a8c5\n--- /dev/null\n+++ b/Documentation/git-am.txt\n@@ -0,0 +1,51 @@\n+git-am(1)\n+================\n+\n+NAME\n+----\n+git-am - Apply a series of patches in a mailbox\n+\n+\n+SYNOPSIS\n+--------\n+'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>\n+'git-am' [--skip]\n+\n+DESCRIPTION\n+-----------\n+Splits mail messages in a mailbox into commit log message,\n+authorship information and patches, and applies them to the\n+current branch.\n+\n+This is the replacement for the 'git-applymbox' script.\n+Unlike git-applymbox, it can take more than one mailbox file from\n+the command line, as well as reading from the standard input when\n+'-' is specified. Other differences include changed parameter names\n+and less descriptive command name.\n+\n+\n+When initially invoking it, you give it name of the mailbox to crunch.\n+The usage hints that it might get interrupted and you will want to\n+resume the last round of applying - to do that, pass it no mailbox\n+name, and optionally the mysterious '--skip' parameter.\n+\n+\n+SEE ALSO\n+--------\n+gitlink:git-applymbox[1], gitlink:git-applypatch[1].\n+\n+\n+Author\n+------\n+Written by Junio C Hamano <junkio@cox.net>\n+\n+Documentation\n+--------------\n+Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.\n+\n+This manual page is a stub. You can help the git documentation by expanding it.\n+\n+GIT\n+---\n+Part of the gitlink:git[7] suite\n+\ndiff --git a/Documentation/git-applymbox.txt b/Documentation/git-applymbox.txt\nindex 8f01ca6..f74c6a4 100644\n--- a/Documentation/git-applymbox.txt\n+++ b/Documentation/git-applymbox.txt\n@@ -75,7 +75,7 @@ OPTIONS\n \n SEE ALSO\n --------\n-gitlink:git-applypatch[1].\n+gitlink:git-am[1], gitlink:git-applypatch[1].\n \n \n Author\ndiff --git a/git-applymbox.sh b/git-applymbox.sh\nindex 4e77132..6de6932 100755\n--- a/git-applymbox.sh\n+++ b/git-applymbox.sh\n@@ -15,6 +15,8 @@\n ## Pay a special attention to the commit log message if you do this and\n ## use a Signoff_file, because applypatch wants to append the sign-off\n ## message to msg-clean every time it is run.\n+##\n+## git-am is supposed to be the newer and better tool for this job.\n \n . git-sh-setup || die \"Not a git archive\"\n \n"},{"id":"10387","messageId":"20051021002845.26819.46168.stgit@machine.or.cz","threadId":"2171","inReplyTo":"20051021002842.26819.56707.stgit@machine.or.cz","subject":"[PATCH 2/2] Update git-daemon's documentation wrt. new options","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2005-10-21T00:28:45Z","receivedAt":"2005-10-21T00:28:45Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"New options --timeout, --init-timeout, --export-all and whitelist support\nwere added to git-daemon, but noone bothered to also add the proper\ndocumentation. This patch aims to fix that.\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git-daemon.txt |   22 ++++++++++++++++++++--\n 1 files changed, 20 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt\nindex a013a58..67c5f22 100644\n--- a/Documentation/git-daemon.txt\n+++ b/Documentation/git-daemon.txt\n@@ -7,7 +7,8 @@ git-daemon - A really simple server for \n \n SYNOPSIS\n --------\n-'git-daemon' [--verbose] [--syslog] [--inetd | --port=n]\n+'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]\n+             [--timeout=n] [--init-timeout=n] [directory...]\n \n DESCRIPTION\n -----------\n@@ -20,18 +21,35 @@ what directory to upload, and it verifie\n \n It verifies that the directory has the magic file \"git-daemon-export-ok\", and\n it will refuse to export any git directory that hasn't explicitly been marked\n-for export this way.\n+for export this way (unless the '--export-all' parameter is specified). If you\n+pass some directory paths as 'git-daemon' arguments, you can further restrict\n+the offers to a whitelist comprising of those.\n \n This is ideally suited for read-only updates, ie pulling from git repositories.\n \n OPTIONS\n -------\n+--export-all::\n+\tAllow pulling from all directories that look like GIT repositories\n+\t(have the 'objects' subdirectory and a 'HEAD' file), even if they\n+\tdo not have the 'git-daemon-export-ok' file.\n+\n --inetd::\n \tHave the server run as an inetd service.\n \n --port::\n \tListen on an alternative port.\n \n+--init-timeout::\n+\tTimeout between the moment the connection is established and the\n+\tclient request is received (typically a rather low value, since\n+\tthat should be basically immediate).\n+\n+--timeout::\n+\tTimeout for specific client sub-requests. This includes the time\n+\tit takes for the server to process the sub-request and time spent\n+\twaiting for next client's request.\n+\n --syslog::\n \tLog to syslog instead of stderr. Note that this option does not imply\n \t--verbose, thus by default only error conditions will be logged.\n"}]}