{"thread":{"id":"56701","subject":"[PATCH] Documentation: specify base point when generating MyFirstContribution patchset","startedAt":"2021-10-13T12:23:29Z","lastAt":"2021-10-15T16:26:29Z","messageCount":4,"participants":["Bagas Sanjaya","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"438645","messageId":"20211013122234.448845-1-bagasdotme@gmail.com","threadId":"56701","inReplyTo":null,"subject":"[PATCH] Documentation: specify base point when generating MyFirstContribution patchset","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-10-13T12:22:35Z","receivedAt":"2021-10-13T12:23:29Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"Some reviewers need to know the base point of patchset a contributor\nbeing worked on. Mention how to answer that.\n\nSigned-off-by: Bagas Sanjaya \n---\n Documentation/MyFirstContribution.txt | 7 +++++++\n 1 file changed, 7 insertions(+)\n\ndiff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt\nindex b20bc8e914..081fb71327 100644\n--- a/Documentation/MyFirstContribution.txt\n+++ b/Documentation/MyFirstContribution.txt\n@@ -937,6 +937,13 @@ but want reviewers to look at what they have so far. You can add this flag with\n Check and make sure that your patches and cover letter template exist in the\n directory you specified - you're nearly ready to send out your review!\n \n+Some reviewers (notably testers) would like to know at what point your patchset\n+are based on (in particular to apply the patchset). In such cases, you can\n+mention the base point when preparing your email (see below section), or by\n+passing `--base=$(git merge-base master psuh)` to `format-patch`. If no base\n+point is specified, the patchset is assumed to be applied on top of current\n+tip of `master` branch.\n+\n [[cover-letter]]\n === Preparing Email\n \n\nbase-commit: 106298f7f9cca4158a980de149ef217751e1f943\n-- \nAn old man doll... just what I always wanted! - Clara\n\n"},{"id":"438691","messageId":"xmqq1r4ofz0o.fsf@gitster.g","threadId":"56701","inReplyTo":"20211013122234.448845-1-bagasdotme@gmail.com","subject":"Re: [PATCH] Documentation: specify base point when generating MyFirstContribution patchset","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-10-13T20:30:47Z","receivedAt":"2021-10-13T20:30:51Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Bagas Sanjaya writes:\n\n> +Some reviewers (notably testers) would like to know at what point your patchset\n> +are based on (in particular to apply the patchset). In such cases, you can\n> +mention the base point when preparing your email (see below section), or by\n> +passing `--base=$(git merge-base master psuh)` to `format-patch`. If no base\n> +point is specified, the patchset is assumed to be applied on top of current\n> +tip of `master` branch.\n\nThis document is about contributing to _this_ project, so I think we\ncan and should be more explicit to say what is preferred, not \"some\nwould like to know, and in such a case you give this extra piece\",\nas by definition, somebody who is making their first contribution\nwould not know whether the reviewer who looks at your work is among\nthese \"some\" or not.\n\n It would help those who review and test your patches to make it\n clear on what commit they are meant to apply. To do so, use the\n \"--base\" option to record the commit on which you based the\n series when running \"git format-patch\".\n\nIf no base is given, what is assumed by default various by\nrecipient, so all we could say is \"If no base is specified, nothing\nis assumed\", but let's rather not say anything to confuse the\nreaders.\n\nWe could say what we want to see the first-time contributors do,\nbut I do not think it is needed in this case.\n\n\tSide note. We want a new feature to be built on 'master' (or\n\tthe last feature release, if nothing in flight conflicts\n\twith it)), and a bugfix to be built on one of the older\n\trelease point (to be applicable to the maintenance tracks).\n\tBut the section we are discussing, i.e. how to run\n\tformat-patch, is not the place to do so, as it is too\n\tlate---it must be decided before the contributor starts\n\tworking on the series. As the example of this document is\n\tabout adding a new \"feature\", we should have a sentence to\n\texplain, in the \"Set up your workspace\" section, why we\n\tchose 'master' as the base point (and the existing text\n\talready says why).\n\nThanks.\n"},{"id":"438812","messageId":"f25fae40-0313-287b-5482-1c64cbe8cb64@gmail.com","threadId":"56701","inReplyTo":"xmqq1r4ofz0o.fsf@gitster.g","subject":"Re: [PATCH] Documentation: specify base point when generating MyFirstContribution patchset","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-10-15T06:51:39Z","receivedAt":"2021-10-15T06:51:44Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"On 14/10/21 03.30, Junio C Hamano wrote:\n> \tSide note. We want a new feature to be built on 'master' (or\n> \tthe last feature release, if nothing in flight conflicts\n> \twith it)), and a bugfix to be built on one of the older\n> \trelease point (to be applicable to the maintenance tracks).\n> \tBut the section we are discussing, i.e. how to run\n> \tformat-patch, is not the place to do so, as it is too\n> \tlate---it must be decided before the contributor starts\n> \tworking on the series. As the example of this document is\n> \tabout adding a new \"feature\", we should have a sentence to\n> \texplain, in the \"Set up your workspace\" section, why we\n> \tchose 'master' as the base point (and the existing text\n> \talready says why).\n\nIt has been described before:\n\n> Let's start by making a development branch to work on our changes. Per\n> `Documentation/SubmittingPatches`, since a brand new command is a new feature,\n> it's fine to base your work on `master`. However, in the future for bugfixes,\n> etc., you should check that document and base it on the appropriate branch.\n\nLeave it as is?\n\n-- \nAn old man doll... just what I always wanted! - Clara\n"},{"id":"438872","messageId":"xmqqmtna8dao.fsf@gitster.g","threadId":"56701","inReplyTo":"f25fae40-0313-287b-5482-1c64cbe8cb64@gmail.com","subject":"Re: [PATCH] Documentation: specify base point when generating MyFirstContribution patchset","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-10-15T16:26:23Z","receivedAt":"2021-10-15T16:26:29Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Bagas Sanjaya writes:\n\n>>...\n>> \tchose 'master' as the base point (and the existing text\n>> \talready says why).\n>\n> It has been described before:\n\nYes, re-read what you quoted and you'd find \"and the existing text\nalready says why\".\n\n> Leave it as is?\n\nYes, that section can stay the same, as I said.\n\nIn short, everything I said in the message you are responding to\nstill stands.\n\nThanks.\n"}]}