{"thread":{"id":"8146","subject":"Some misc Documentation patches","startedAt":"2007-05-14T14:44:50Z","lastAt":"2007-05-15T19:00:56Z","messageCount":9,"participants":["Frank Lichtenheld","Junio C Hamano"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"42119","messageId":"1179153893715-git-send-email-frank@lichtenheld.de","threadId":"8146","inReplyTo":null,"subject":"Some misc Documentation patches","fromName":"Frank Lichtenheld","fromEmail":"frank@lichtenheld.de","sentAt":"2007-05-14T14:44:50Z","receivedAt":"2007-05-14T14:44:50Z","isPatch":false,"sender":{"key":"frank@lichtenheld.de","avatar":"https://gravatar.com/avatar/b9f1d4b120e138f157c9e480d0818197c474628923786adb98f30017cdb99c3c?d=mp&s=160"},"body":"The result of me playing around with git format-patch and git-am.\n\nbuiltin-log.c: Fix typo in comment\nFound while searching for the omnious --mbox option\n\nDocumentation: format-patch has no --mbox option\nReplace --mbox with --stdout. Probably needs some more\nthought to really improve the documentation\n\ngit-am: Clean up the asciidoc documentation\nFixing some things that annoyed me while reading the man page\nand some things that I found while fixing the former.\nIf I should split that in more than one patch, please say so.\n\n Documentation/git-am.txt        |   38 ++++++++++++++++++++------------------\n Documentation/git-applymbox.txt |    2 +-\n Documentation/git-mailinfo.txt  |    3 +--\n builtin-log.c                   |    3 +--\n 4 files changed, 23 insertions(+), 23 deletions(-)\n"},{"id":"42120","messageId":"11791538933653-git-send-email-frank@lichtenheld.de","threadId":"8146","inReplyTo":"1179153893715-git-send-email-frank@lichtenheld.de","subject":"[PATCH] builtin-log.c: Fix typo in comment","fromName":"Frank Lichtenheld","fromEmail":"frank@lichtenheld.de","sentAt":"2007-05-14T14:44:51Z","receivedAt":"2007-05-14T14:44:51Z","isPatch":true,"sender":{"key":"frank@lichtenheld.de","avatar":"https://gravatar.com/avatar/b9f1d4b120e138f157c9e480d0818197c474628923786adb98f30017cdb99c3c?d=mp&s=160"},"body":"s/fmt-patch/format-patch/\n\nSigned-off-by: Frank Lichtenheld <frank@lichtenheld.de>\n---\n builtin-log.c |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/builtin-log.c b/builtin-log.c\nindex 38bf52f..3744712 100644\n--- a/builtin-log.c\n+++ b/builtin-log.c\n@@ -454,7 +454,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)\n \n \t/*\n \t * Parse the arguments before setup_revisions(), or something\n-\t * like \"git fmt-patch -o a123 HEAD^..\" may fail; a123 is\n+\t * like \"git format-patch -o a123 HEAD^..\" may fail; a123 is\n \t * possibly a valid SHA1.\n \t */\n \tfor (i = 1, j = 1; i < argc; i++) {\n-- \n1.5.1.4\n"},{"id":"42122","messageId":"11791538941530-git-send-email-frank@lichtenheld.de","threadId":"8146","inReplyTo":"1179153893715-git-send-email-frank@lichtenheld.de","subject":"[PATCH] Documentation: format-patch has no --mbox option","fromName":"Frank Lichtenheld","fromEmail":"frank@lichtenheld.de","sentAt":"2007-05-14T14:44:52Z","receivedAt":"2007-05-14T14:44:52Z","isPatch":true,"sender":{"key":"frank@lichtenheld.de","avatar":"https://gravatar.com/avatar/b9f1d4b120e138f157c9e480d0818197c474628923786adb98f30017cdb99c3c?d=mp&s=160"},"body":"git-applymbox and git-mailinfo refer to a --mbox\noption of git-format-patch. But there is no such\noption AFAICT. mbox output can produced with\nformat-patch --stdout.\n\nThis patch only replaces --mbox with --stdout.\nSome further explanation and/or format-patch\narguments (e.g. -k) might be needed.\n\nSigned-off-by: Frank Lichtenheld <frank@lichtenheld.de>\n---\n Documentation/git-applymbox.txt |    2 +-\n Documentation/git-mailinfo.txt  |    2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-applymbox.txt b/Documentation/git-applymbox.txt\nindex 3bc92d8..761ca3e 100644\n--- a/Documentation/git-applymbox.txt\n+++ b/Documentation/git-applymbox.txt\n@@ -31,7 +31,7 @@ OPTIONS\n \twhitespaces, (3) '[' up to ']', typically '[PATCH]', and\n \tthen prepends \"[PATCH] \".  This flag forbids this\n \tmunging, and is most useful when used to read back 'git\n-\tformat-patch --mbox' output.\n+\tformat-patch --stdout' output.\n \n -m::\n \tPatches are applied with `git-apply` command, and unless\ndiff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt\nindex ba18133..d49eee9 100644\n--- a/Documentation/git-mailinfo.txt\n+++ b/Documentation/git-mailinfo.txt\n@@ -30,7 +30,7 @@ OPTIONS\n \twhitespaces, (3) '[' up to ']', typically '[PATCH]', and\n \tthen prepends \"[PATCH] \".  This flag forbids this\n \tmunging, and is most useful when used to read back 'git\n-\tformat-patch --mbox' output.\n+\tformat-patch --stdout' output.\n \n -u::\n \tThe commit log message, author name and author email are\n-- \n1.5.1.4\n"},{"id":"42121","messageId":"11791538941022-git-send-email-frank@lichtenheld.de","threadId":"8146","inReplyTo":"1179153893715-git-send-email-frank@lichtenheld.de","subject":"[PATCH] git-am: Clean up the asciidoc documentation","fromName":"Frank Lichtenheld","fromEmail":"frank@lichtenheld.de","sentAt":"2007-05-14T14:44:53Z","receivedAt":"2007-05-14T14:44:53Z","isPatch":true,"sender":{"key":"frank@lichtenheld.de","avatar":"https://gravatar.com/avatar/b9f1d4b120e138f157c9e480d0818197c474628923786adb98f30017cdb99c3c?d=mp&s=160"},"body":"Add --keep to synopsis.\nThe synopsys used a mix of tabs and spaces, unified\nto use only spaces.\n\nShuffle options around in synopsys and description\nfor grouping them logically.\n\nAdd more gitlink references to other commands.\n\nVarious grammatical fixes and improvements.\n\nSigned-off-by: Frank Lichtenheld <frank@lichtenheld.de>\n---\n Documentation/git-am.txt |   37 ++++++++++++++++++++-----------------\n 1 files changed, 20 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/git-am.txt b/Documentation/git-am.txt\nindex f0405a3..0bc9123 100644\n--- a/Documentation/git-am.txt\n+++ b/Documentation/git-am.txt\n@@ -9,9 +9,10 @@ git-am - Apply a series of patches from a mailbox\n SYNOPSIS\n --------\n [verse]\n-'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]\n-         [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]\n-\t <mbox>...\n+'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]\n+         [--3way] [--interactive] [--binary]\n+         [--whitespace=<option>] [-C<n>] [-p<n>]\n+         <mbox>...\n 'git-am' [--skip | --resolved]\n \n DESCRIPTION\n@@ -40,7 +41,7 @@ OPTIONS\n -u, --utf8::\n \tPass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).\n \tThe proposed commit log message taken from the e-mail\n-\tare re-coded into UTF-8 encoding (configuration variable\n+\tis re-coded into UTF-8 encoding (configuration variable\n \t`i18n.commitencoding` can be used to specify project's\n \tpreferred encoding if it is not UTF-8).\n +\n@@ -51,30 +52,32 @@ default.   You could use `--no-utf8` to override this.\n \tPass `-n` flag to `git-mailinfo` (see\n \tgitlink:git-mailinfo[1]).\n \n--b, --binary::\n-\tPass `--allow-binary-replacement` flag to `git-apply`\n-\t(see gitlink:git-apply[1]).\n-\n -3, --3way::\n \tWhen the patch does not apply cleanly, fall back on\n \t3-way merge, if the patch records the identity of blobs\n \tit is supposed to apply to, and we have those blobs\n-\tlocally.\n+\tavailable locally.\n \n---skip::\n-\tSkip the current patch.  This is only meaningful when\n-\trestarting an aborted patch.\n+-b, --binary::\n+\tPass `--allow-binary-replacement` flag to `git-apply`\n+\t(see gitlink:git-apply[1]).\n \n --whitespace=<option>::\n-\tThis flag is passed to the `git-apply` program that applies\n+\tThis flag is passed to the `git-apply` (see gitlink:git-apply[1])\n+\tprogram that applies\n \tthe patch.\n \n -C<n>, -p<n>::\n-\tThese flags are passed to the `git-apply` program that applies\n+\tThese flags are passed to the `git-apply` (see gitlink:git-apply[1])\n+\tprogram that applies\n \tthe patch.\n \n -i, --interactive::\n-\tRun interactively, just like git-applymbox.\n+\tRun interactively, just like `git-applymbox` (see gitlink:git-applymbox[1]).\n+\n+--skip::\n+\tSkip the current patch.  This is only meaningful when\n+\trestarting an aborted patch.\n \n -r, --resolved::\n \tAfter a patch failure (e.g. attempting to apply\n@@ -99,7 +102,7 @@ message, and commit author time is taken from the \"Date: \" line\n of the message.  The \"Subject: \" line is used as the title of\n the commit, after stripping common prefix \"[PATCH <anything>]\".\n It is supposed to describe what the commit is about concisely as\n-a one line text.\n+an one line text.\n \n The body of the message (iow, after a blank line that terminates\n RFC2822 headers) can begin with \"Subject: \" and \"From: \" lines\n@@ -126,7 +129,7 @@ to crunch.  Upon seeing the first patch that does not apply, it\n aborts in the middle, just like 'git-applymbox' does.  You can\n recover from this in one of two ways:\n \n-. skip the current one by re-running the command with '--skip'\n+. skip the current patch by re-running the command with '--skip'\n   option.\n \n . hand resolve the conflict in the working directory, and update\n-- \n1.5.1.4\n"},{"id":"42176","messageId":"7vd513lztp.fsf@assigned-by-dhcp.cox.net","threadId":"8146","inReplyTo":"11791538941022-git-send-email-frank@lichtenheld.de","subject":"Re: [PATCH] git-am: Clean up the asciidoc documentation","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-05-15T00:01:38Z","receivedAt":"2007-05-15T00:01:38Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Frank Lichtenheld <frank@lichtenheld.de> writes:\n\n>  -i, --interactive::\n> -\tRun interactively, just like git-applymbox.\n> +\tRun interactively, just like `git-applymbox` (see gitlink:git-applymbox[1]).\n\nThis is an unclear description from the original, but I think we\nshould say just like `git-applybox -i`, or drop this altogether.\n\n> @@ -99,7 +102,7 @@ message, and commit author time is taken from the \"Date: \" line\n>  of the message.  The \"Subject: \" line is used as the title of\n>  the commit, after stripping common prefix \"[PATCH <anything>]\".\n>  It is supposed to describe what the commit is about concisely as\n> -a one line text.\n> +an one line text.\n\nI think 'one' does not begin with a vowel.\n\nOther than that, I would agree everything in your update is a\nclear improvement.\n"},{"id":"42177","messageId":"7v8xbrlzqk.fsf@assigned-by-dhcp.cox.net","threadId":"8146","inReplyTo":"11791538941530-git-send-email-frank@lichtenheld.de","subject":"Re: [PATCH] Documentation: format-patch has no --mbox option","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-05-15T00:03:31Z","receivedAt":"2007-05-15T00:03:31Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Frank Lichtenheld <frank@lichtenheld.de> writes:\n\n> git-applymbox and git-mailinfo refer to a --mbox\n> option of git-format-patch. But there is no such\n> option AFAICT. mbox output can produced with\n> format-patch --stdout.\n>\n> This patch only replaces --mbox with --stdout.\n> Some further explanation and/or format-patch\n> arguments (e.g. -k) might be needed.\n\nI would agree.  \"Reads single mbox with one or more patches in\nit, without munging the subject line\" is what it really does, so\nwe obviously mean \"--stdout -k >mbox\" here.\n"},{"id":"42180","messageId":"7vveevkkdc.fsf@assigned-by-dhcp.cox.net","threadId":"8146","inReplyTo":"7v8xbrlzqk.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] Documentation: format-patch has no --mbox option","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-05-15T00:20:47Z","receivedAt":"2007-05-15T00:20:47Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Junio C Hamano <junkio@cox.net> writes:\n\n> Frank Lichtenheld <frank@lichtenheld.de> writes:\n>\n>> git-applymbox and git-mailinfo refer to a --mbox\n>> option of git-format-patch. But there is no such\n>> option AFAICT. mbox output can produced with\n>> format-patch --stdout.\n>>\n>> This patch only replaces --mbox with --stdout.\n>> Some further explanation and/or format-patch\n>> arguments (e.g. -k) might be needed.\n>\n> I would agree.  \"Reads single mbox with one or more patches in\n> it, without munging the subject line\" is what it really does, so\n> we obviously mean \"--stdout -k >mbox\" here.\n\nCome to think of it, \"no munging of Subject lines\" is orthogonal\nto the number of patches in a file, so it should say that the\noption corresponds to -k in format-patch, I think.\n\nSo, I think we can just do s/--mbox/-k/, instead of s/--mbox/--stdout/\nwhich is what you did.\n"},{"id":"42215","messageId":"20070515122357.GF5272@planck.djpig.de","threadId":"8146","inReplyTo":"7vd513lztp.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] git-am: Clean up the asciidoc documentation","fromName":"Frank Lichtenheld","fromEmail":"frank@lichtenheld.de","sentAt":"2007-05-15T12:23:57Z","receivedAt":"2007-05-15T12:23:57Z","isPatch":true,"sender":{"key":"frank@lichtenheld.de","avatar":"https://gravatar.com/avatar/b9f1d4b120e138f157c9e480d0818197c474628923786adb98f30017cdb99c3c?d=mp&s=160"},"body":"On Mon, May 14, 2007 at 05:01:38PM -0700, Junio C Hamano wrote:\n> Frank Lichtenheld <frank@lichtenheld.de> writes:\n> \n> >  -i, --interactive::\n> > -\tRun interactively, just like git-applymbox.\n> > +\tRun interactively, just like `git-applymbox` (see gitlink:git-applymbox[1]).\n> \n> This is an unclear description from the original, but I think we\n> should say just like `git-applybox -i`, or drop this altogether.\n\nHmm, your comment doesn't make any sense to me, because applymbox has\nno -i option.\n\nGruesse,\n-- \nFrank Lichtenheld <frank@lichtenheld.de>\nwww: http://www.djpig.de/\n"},{"id":"42242","messageId":"7vtzudj4if.fsf@assigned-by-dhcp.cox.net","threadId":"8146","inReplyTo":"20070515122357.GF5272@planck.djpig.de","subject":"Re: [PATCH] git-am: Clean up the asciidoc documentation","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-05-15T19:00:56Z","receivedAt":"2007-05-15T19:00:56Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Frank Lichtenheld <frank@lichtenheld.de> writes:\n\n> On Mon, May 14, 2007 at 05:01:38PM -0700, Junio C Hamano wrote:\n>> Frank Lichtenheld <frank@lichtenheld.de> writes:\n>> \n>> >  -i, --interactive::\n>> > -\tRun interactively, just like git-applymbox.\n>> > +\tRun interactively, just like `git-applymbox` (see gitlink:git-applymbox[1]).\n>> \n>> This is an unclear description from the original, but I think we\n>> should say just like `git-applybox -i`, or drop this altogether.\n>\n> Hmm, your comment doesn't make any sense to me, because applymbox has\n> no -i option.\n\nAh, my braino.  Thanks.\n\nWe are not encouraging applymbox to new users anyway, so I'd\njust drop the whole \", just like\" business.\n"}]}