{"thread":{"id":"13714","subject":"[PATCH] Revision waling documentation: fix a typo","startedAt":"2008-05-28T22:08:15Z","lastAt":"2008-05-31T00:18:08Z","messageCount":11,"participants":["Miklos Vajna","Johannes Schindelin","Junio C Hamano","Petr Baudis"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"77982","messageId":"1212012495-5782-1-git-send-email-vmiklos@frugalware.org","threadId":"13714","inReplyTo":null,"subject":"[PATCH] Revision waling documentation: fix a typo","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-28T22:08:15Z","receivedAt":"2008-05-28T22:08:15Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"Signed-off-by: Miklos Vajna \n---\n Documentation/technical/api-revision-walking.txt | 2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/technical/api-revision-walking.txt b/Documentation/technical/api-revision-walking.txt\nindex 01a2455..c0797d3 100644\n--- a/Documentation/technical/api-revision-walking.txt\n+++ b/Documentation/technical/api-revision-walking.txt\n@@ -4,6 +4,6 @@ revision walking API\n Talk about , things like:\n \n * two diff_options, one for path limiting, another for output;\n-* calling sequence: init_revisions(), setup_revsions(), get_revision();\n+* calling sequence: init_revisions(), setup_revisions(), get_revision();\n \n (Linus, JC, Dscho)\n-- \n1.5.6.rc0.dirty\n"},{"id":"78032","messageId":"alpine.DEB.1.00.0805291336270.13507@racer.site.net","threadId":"13714","inReplyTo":"1212012495-5782-1-git-send-email-vmiklos@frugalware.org","subject":"Re: [PATCH] Revision waling documentation: fix a typo","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2008-05-29T12:36:44Z","receivedAt":"2008-05-29T12:36:44Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nyou meant \"walking\" instead of \"waling\", right? ;-)\n\nCiao,\nDscho\n"},{"id":"78058","messageId":"20080529164555.GP27724@genesis.frugalware.org","threadId":"13714","inReplyTo":"alpine.DEB.1.00.0805291336270.13507@racer.site.net","subject":"Re: [PATCH] Revision waling documentation: fix a typo","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-29T16:45:55Z","receivedAt":"2008-05-29T16:45:55Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"On Thu, May 29, 2008 at 01:36:44PM +0100, Johannes Schindelin wrote:\n> you meant \"walking\" instead of \"waling\", right? ;-)\n\nHeh, sure! Should I resend the patch fix a fixed title?\n"},{"id":"78076","messageId":"7vzlq9nel7.fsf@gitster.siamese.dyndns.org","threadId":"13714","inReplyTo":"20080529164555.GP27724@genesis.frugalware.org","subject":"Re: [PATCH] Revision waling documentation: fix a typo","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-29T18:35:16Z","receivedAt":"2008-05-29T18:35:16Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Miklos Vajna writes:\n\n> On Thu, May 29, 2008 at 01:36:44PM +0100, Johannes Schindelin wrote:\n>> you meant \"walking\" instead of \"waling\", right? ;-)\n>\n> Heh, sure! Should I resend the patch fix a fixed title?\n\nPlease don't.\n\nI do not want to apply a patch _from you_ to that file unless it actually\nadds meat to the description --- I know you know git better than doing\njust a typofix to a placeholder.\n\nAlso why did I have to fix my To: header when I tried to respond to your\nmessage?\n"},{"id":"78088","messageId":"1212098185-8437-1-git-send-email-vmiklos@frugalware.org","threadId":"13714","inReplyTo":"7vzlq9nel7.fsf@gitster.siamese.dyndns.org","subject":"[PATCH] Revision walking documentation: document most important functions","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-29T21:56:25Z","receivedAt":"2008-05-29T21:56:25Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"Unfortunately the list is not complete, but includes the essential ones.\n\nSigned-off-by: Miklos Vajna \n---\n\nOn Thu, May 29, 2008 at 11:35:16AM -0700, Junio C Hamano wrote:\n> I do not want to apply a patch _from you_ to that file unless it\n> actually\n> adds meat to the description --- I know you know git better than doing\n> just a typofix to a placeholder.\n\nHere is a start. To be honest I never used the functions I did not\ndocument, so I don't have too much idea what they do (not counting\nreading the source ;-) ), so I thought it's better if I leave them\nexcluded from the list.\n\n> Also why did I have to fix my To: header when I tried to respond to\n> your\n> message?\n\nHm, I sent the patch using git-send-email, adding the Cc line manually\nand having your address in sendemail.to, so I don't know exactly what\ncan be special in this setup.\n\n Documentation/technical/api-revision-walking.txt | 57 +++++++++++++++++++++-\n 1 files changed, 56 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/technical/api-revision-walking.txt b/Documentation/technical/api-revision-walking.txt\nindex 01a2455..f073ee3 100644\n--- a/Documentation/technical/api-revision-walking.txt\n+++ b/Documentation/technical/api-revision-walking.txt\n@@ -1,9 +1,64 @@\n revision walking API\n ====================\n \n+The revision walking API offers functions to build a list of revisions\n+and then iterate over that list.\n+\n+The walking API has a given calling sequence: first you need to\n+initialize a rev_info structure, then add revisions to control what kind\n+of revision list do you want to get, finally you can iterate over the\n+revision list.\n+\n+Functions\n+---------\n+\n+`init_revisions`::\n+\n+\tInitialize a rev_info structure with default values. The second\n+\tparameter may be NULL or can be prefix path, and then the `.prefix`\n+\tvariable will be set to it. This is typically the first function you\n+\twant to call when you want to deal with a revision list. After calling\n+\tthis function, you are free to customize options, like set\n+\t`.ignore_merges` to 0 if you don't want to ignore merges, and so on. See\n+\t`revision.h` for a complete list of available options.\n+\n+`add_pending_object`::\n+\n+\tThis function can be used if you want to add commit objects as revision\n+\tinformation. You can use the `UNINTERESTING` object flag to indicate if\n+\tyou want to include or exclude the given commit (and commits reachable\n+\tfrom the given commit) from the revision list.\n++\n+NOTE: If you have the commits as a string list then you probably want to\n+use setup_revisions(), instead of parsing each string and using this\n+function.\n+\n+`setup_revisions`::\n+\n+\tParse revision information, filling in the `rev_info` structure, and\n+\tremoving the used arguments from the argument list. Returns the number\n+\tof arguments left that weren't recognized, which are also moved to the\n+\thead of the argument list. The last parameter is used in case no\n+\tparameter given by the first two arguments.\n+\n+`prepare_revision_walk`::\n+\n+\tPrepares the rev_info structure for a walk. You should check if it\n+\treturns any error (positive return code) and if it does not, you can\n+\tstart using get_revision() to do the iteration.\n+\n+`get_revision`::\n+\n+\tTakes a pointer to a `rev_info` structure and iterates over it,\n+\treturning a `struct commit *` each time you call it. The end of the\n+\trevision list is indicated by returning a NULL pointer.\n+\n+Data structures\n+---------------\n+\n Talk about , things like:\n \n * two diff_options, one for path limiting, another for output;\n-* calling sequence: init_revisions(), setup_revsions(), get_revision();\n+* remaining functions;\n \n (Linus, JC, Dscho)\n-- \n1.5.6.rc0.dirty\n"},{"id":"78097","messageId":"7vmym8oezm.fsf@gitster.siamese.dyndns.org","threadId":"13714","inReplyTo":"1212098185-8437-1-git-send-email-vmiklos@frugalware.org","subject":"Re: [PATCH] Revision walking documentation: document most important functions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-29T23:41:17Z","receivedAt":"2008-05-29T23:41:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Miklos Vajna writes:\n\n> Unfortunately the list is not complete, but includes the essential ones.\n>\n> Signed-off-by: Miklos Vajna \n> ---\n>\n> On Thu, May 29, 2008 at 11:35:16AM -0700, Junio C Hamano wrote:\n>> I do not want to apply a patch _from you_ to that file unless it\n>> actually\n>> adds meat to the description --- I know you know git better than doing\n>> just a typofix to a placeholder.\n>\n> Here is a start. To be honest I never used the functions I did not\n> document, so I don't have too much idea what they do (not counting\n> reading the source ;-) ), so I thought it's better if I leave them\n> excluded from the list.\n>\n>> Also why did I have to fix my To: header when I tried to respond to\n>> your\n>> message?\n>\n> Hm, I sent the patch using git-send-email,...\n\nI do not think so. You used \n\n User-Agent: Mutt/1.5.17 (2007-11-01)\n"},{"id":"78098","messageId":"20080529234625.GU27724@genesis.frugalware.org","threadId":"13714","inReplyTo":"7vmym8oezm.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] Revision walking documentation: document most important functions","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-29T23:46:25Z","receivedAt":"2008-05-29T23:46:25Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"On Thu, May 29, 2008 at 04:41:17PM -0700, Junio C Hamano wrote:\n> > Hm, I sent the patch using git-send-email,...\n> \n> I do not think so. You used \n> \n> User-Agent: Mutt/1.5.17 (2007-11-01)\n\nOh, I misunderstood you. I was talking about the patch itself. Though\nthe other mail seem to be pretty usual as well, so it's still a mystery\nfor me. ;-)\n"},{"id":"78099","messageId":"20080530002006.GC18781@machine.or.cz","threadId":"13714","inReplyTo":"20080529234625.GU27724@genesis.frugalware.org","subject":"Re: [PATCH] Revision walking documentation: document most important functions","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2008-05-30T00:20:06Z","receivedAt":"2008-05-30T00:20:06Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"On Fri, May 30, 2008 at 01:46:25AM +0200, Miklos Vajna wrote:\n> On Thu, May 29, 2008 at 04:41:17PM -0700, Junio C Hamano wrote:\n> > > Hm, I sent the patch using git-send-email,...\n> > \n> > I do not think so. You used \n> > \n> > User-Agent: Mutt/1.5.17 (2007-11-01)\n> \n> Oh, I misunderstood you. I was talking about the patch itself. Though\n> the other mail seem to be pretty usual as well, so it's still a mystery\n> for me. ;-)\n\nYou probably have git@vger.kernel.org configured as a list in your\n~/.muttrc and followup_to set to yes (the default) - so Mutt generates a\nMail-Followup-To header omitting you so that you won't receive the\nreplies twice.\n\nIncidentally, I have an opposite problem; when someone sends a reply\nboth to me and to git@, I never get the mailing list copy.\n\n-- \n\t\t\t\tPetr \"Pasky\" Baudis\nWhatever you can do, or dream you can, begin it.\nBoldness has genius, power, and magic in it.\t-- J. W. von Goethe\n"},{"id":"78101","messageId":"7vej7kocrl.fsf@gitster.siamese.dyndns.org","threadId":"13714","inReplyTo":"1212098185-8437-1-git-send-email-vmiklos@frugalware.org","subject":"Re: [PATCH] Revision walking documentation: document most important functions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-30T00:29:18Z","receivedAt":"2008-05-30T00:29:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Miklos Vajna writes:\n\n> Unfortunately the list is not complete, but includes the essential ones.\n> ...\n> Here is a start. To be honest I never used the functions I did not\n> document, so I don't have too much idea what they do (not counting\n> reading the source ;-) ), so I thought it's better if I leave them\n> excluded from the list.\n\nIt's a good start. Thanks.\n\n> revision walking API\n> ====================\n> \n> +The revision walking API offers functions to build a list of revisions\n> +and then iterate over that list.\n\n> +The walking API has a given calling sequence: first you need to\n> +initialize a rev_info structure, then add revisions to control what kind\n> +of revision list do you want to get, finally you can iterate over the\n> +revision list.\n\nI think this paragraph is easier to read if it is in its own subsection\n\"Calling Sequence\" (see api-diff.txt for an example).\n\n> +Functions\n> +---------\n> +\n> +`init_revisions`::\n> +\n> +\tInitialize a rev_info structure with default values. The second\n> +\tparameter may be NULL or can be prefix path, and then the `.prefix`\n> +\tvariable will be set to it. This is typically the first function you\n> +\twant to call when you want to deal with a revision list. After calling\n> +\tthis function, you are free to customize options, like set\n> +\t`.ignore_merges` to 0 if you don't want to ignore merges, and so on. See\n> +\t`revision.h` for a complete list of available options.\n\nTraversal options are numerous and complex, so I agree that it makes sense\nto refer the reader elsewhere. We can start with \"revision.h\", and extend\nthis documentation by adding a separate section on it.\n\n> +`add_pending_object`::\n> +\n> +\tThis function can be used if you want to add commit objects as revision\n> +\tinformation. You can use the `UNINTERESTING` object flag to indicate if\n> +\tyou want to include or exclude the given commit (and commits reachable\n> +\tfrom the given commit) from the revision list.\n> ++\n> +NOTE: If you have the commits as a string list then you probably want to\n> +use setup_revisions(), instead of parsing each string and using this\n> +function.\n> +\n> +`setup_revisions`::\n> +\n> +\tParse revision information, filling in the `rev_info` structure, and\n> +\tremoving the used arguments from the argument list. Returns the number\n> +\tof arguments left that weren't recognized, which are also moved to the\n> +\thead of the argument list. The last parameter is used in case no\n> +\tparameter given by the first two arguments.\n> +\n> +`prepare_revision_walk`::\n> +\n> +\tPrepares the rev_info structure for a walk. You should check if it\n> +\treturns any error (positive return code) and if it does not, you can\n\ns/positive/non-zero/;\n"},{"id":"78200","messageId":"20080531001444.GB29404@genesis.frugalware.org","threadId":"13714","inReplyTo":"20080530002006.GC18781@machine.or.cz","subject":"Re: [PATCH] Revision walking documentation: document most important functions","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-31T00:14:44Z","receivedAt":"2008-05-31T00:14:44Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"On Fri, May 30, 2008 at 02:20:06AM +0200, Petr Baudis wrote:\n> You probably have git@vger.kernel.org configured as a list in your\n> ~/.muttrc and followup_to set to yes (the default) - so Mutt generates a\n> Mail-Followup-To header omitting you so that you won't receive the\n> replies twice.\n\nAh, yes, this is exactly the case, thanks for the hint. Given that most\nmailers ignore that header (so I receive duplicated mails anyway), I\njust disabled followup_to, hopefully this makes Junio's setup happy. ;-)\n"},{"id":"78201","messageId":"1212193088-5420-1-git-send-email-vmiklos@frugalware.org","threadId":"13714","inReplyTo":"7vej7kocrl.fsf@gitster.siamese.dyndns.org","subject":"[PATCH] Revision walking documentation: document most important functions","fromName":"Miklos Vajna","fromEmail":"vmiklos@frugalware.org","sentAt":"2008-05-31T00:18:08Z","receivedAt":"2008-05-31T00:18:08Z","isPatch":true,"sender":{"key":"vmiklos@frugalware.org","avatar":"https://gravatar.com/avatar/401c1cbbb3a5d13e650c691a2c71d6fd0b80df1a01bc74d9f1972675dd58f2bd?d=mp&s=160"},"body":"Unfortunately the list is not complete, but includes the essential ones.\n\nSigned-off-by: Miklos Vajna \n---\n\nOn Thu, May 29, 2008 at 05:29:18PM -0700, Junio C Hamano wrote:\n> I think this paragraph is easier to read if it is in its own\n> subsection\n> \"Calling Sequence\" (see api-diff.txt for an example).\n\nDone.\n\n> > +`prepare_revision_walk`::\n> > +\n> > + Prepares the rev_info structure for a walk. You should check if\n> > it\n> > + returns any error (positive return code) and if it does not, you\n> > can\n>\n> s/positive/non-zero/;\n\nFixed.\n\n Documentation/technical/api-revision-walking.txt | 60 +++++++++++++++++++++-\n 1 files changed, 59 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/technical/api-revision-walking.txt b/Documentation/technical/api-revision-walking.txt\nindex 01a2455..996da05 100644\n--- a/Documentation/technical/api-revision-walking.txt\n+++ b/Documentation/technical/api-revision-walking.txt\n@@ -1,9 +1,67 @@\n revision walking API\n ====================\n \n+The revision walking API offers functions to build a list of revisions\n+and then iterate over that list.\n+\n+Calling sequence\n+----------------\n+\n+The walking API has a given calling sequence: first you need to\n+initialize a rev_info structure, then add revisions to control what kind\n+of revision list do you want to get, finally you can iterate over the\n+revision list.\n+\n+Functions\n+---------\n+\n+`init_revisions`::\n+\n+\tInitialize a rev_info structure with default values. The second\n+\tparameter may be NULL or can be prefix path, and then the `.prefix`\n+\tvariable will be set to it. This is typically the first function you\n+\twant to call when you want to deal with a revision list. After calling\n+\tthis function, you are free to customize options, like set\n+\t`.ignore_merges` to 0 if you don't want to ignore merges, and so on. See\n+\t`revision.h` for a complete list of available options.\n+\n+`add_pending_object`::\n+\n+\tThis function can be used if you want to add commit objects as revision\n+\tinformation. You can use the `UNINTERESTING` object flag to indicate if\n+\tyou want to include or exclude the given commit (and commits reachable\n+\tfrom the given commit) from the revision list.\n++\n+NOTE: If you have the commits as a string list then you probably want to\n+use setup_revisions(), instead of parsing each string and using this\n+function.\n+\n+`setup_revisions`::\n+\n+\tParse revision information, filling in the `rev_info` structure, and\n+\tremoving the used arguments from the argument list. Returns the number\n+\tof arguments left that weren't recognized, which are also moved to the\n+\thead of the argument list. The last parameter is used in case no\n+\tparameter given by the first two arguments.\n+\n+`prepare_revision_walk`::\n+\n+\tPrepares the rev_info structure for a walk. You should check if it\n+\treturns any error (non-zero return code) and if it does not, you can\n+\tstart using get_revision() to do the iteration.\n+\n+`get_revision`::\n+\n+\tTakes a pointer to a `rev_info` structure and iterates over it,\n+\treturning a `struct commit *` each time you call it. The end of the\n+\trevision list is indicated by returning a NULL pointer.\n+\n+Data structures\n+---------------\n+\n Talk about , things like:\n \n * two diff_options, one for path limiting, another for output;\n-* calling sequence: init_revisions(), setup_revsions(), get_revision();\n+* remaining functions;\n \n (Linus, JC, Dscho)\n-- \n1.5.6.rc0.dirty\n"}]}