| Message ID | 1372214269-16897-1-git-send-email-trevor.woerner@linaro.org |
|---|---|
| State | New |
| Headers | show |
Trevor, I use to have [YOCTO #<bug-id>] in the manual just as you do here. I was told by Saul though that I was not to use the brackets in the commit description. That is when I took them out of the manual. Maybe Saul can add more to this explanation. Thanks, Scott >-----Original Message----- >From: yocto-bounces@yoctoproject.org [mailto:yocto- >bounces@yoctoproject.org] On Behalf Of Trevor Woerner >Sent: Tuesday, June 25, 2013 7:38 PM >To: yocto@yoctoproject.org >Cc: patches@linaro.org >Subject: [yocto] [yocto-docs][PATCH] dev-manual: referencing bugzilla >issues > >Based on observations from the various mailing lists, it is obvious that >bugzilla issues are almost always referenced using square brackets. > >Signed-off-by: Trevor Woerner <trevor.woerner@linaro.org> >--- > documentation/dev-manual/dev-manual-newbie.xml | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > >diff --git a/documentation/dev-manual/dev-manual-newbie.xml >b/documentation/dev-manual/dev-manual-newbie.xml >index 0c849f5..55e0c58 100644 >--- a/documentation/dev-manual/dev-manual-newbie.xml >+++ b/documentation/dev-manual/dev-manual-newbie.xml >@@ -1405,7 +1405,7 @@ > references - any commit that addresses a specific bug >should include the > bug ID in the description (typically at the beginning) >as follows: > <literallayout class='monospaced'> >- Fixes YOCTO #<bug-id> >+ [YOCTO #<bug-id>] > > <detailed description of change> > </literallayout></para></listitem> >-- >1.8.3.rc1.44.gb387c77 > >_______________________________________________ >yocto mailing list >yocto@yoctoproject.org >https://lists.yoctoproject.org/listinfo/yocto
What's odd is that here: http://lists.linuxtogo.org/pipermail/openembedded-core/2013-April/037826.html Saul explicitly tells Radu that using the brackets is the correct format (which is what, I think, caused me to send this patch in the first place). I hope Saul notices this thread and comments :-) On 26 June 2013 00:26, Rifenbark, Scott M <scott.m.rifenbark@intel.com> wrote: > Trevor, > > I use to have [YOCTO #<bug-id>] in the manual just as you do here. I was told by Saul though that I was not to use the brackets in the commit description. That is when I took them out of the manual. Maybe Saul can add more to this explanation. > > Thanks, > Scott > >>-----Original Message----- >>From: yocto-bounces@yoctoproject.org [mailto:yocto- >>bounces@yoctoproject.org] On Behalf Of Trevor Woerner >>Sent: Tuesday, June 25, 2013 7:38 PM >>To: yocto@yoctoproject.org >>Cc: patches@linaro.org >>Subject: [yocto] [yocto-docs][PATCH] dev-manual: referencing bugzilla >>issues >> >>Based on observations from the various mailing lists, it is obvious that >>bugzilla issues are almost always referenced using square brackets. >> >>Signed-off-by: Trevor Woerner <trevor.woerner@linaro.org> >>--- >> documentation/dev-manual/dev-manual-newbie.xml | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >>diff --git a/documentation/dev-manual/dev-manual-newbie.xml >>b/documentation/dev-manual/dev-manual-newbie.xml >>index 0c849f5..55e0c58 100644 >>--- a/documentation/dev-manual/dev-manual-newbie.xml >>+++ b/documentation/dev-manual/dev-manual-newbie.xml >>@@ -1405,7 +1405,7 @@ >> references - any commit that addresses a specific bug >>should include the >> bug ID in the description (typically at the beginning) >>as follows: >> <literallayout class='monospaced'> >>- Fixes YOCTO #<bug-id> >>+ [YOCTO #<bug-id>] >> >> <detailed description of change> >> </literallayout></para></listitem> >>-- >>1.8.3.rc1.44.gb387c77 >> >>_______________________________________________ >>yocto mailing list >>yocto@yoctoproject.org >>https://lists.yoctoproject.org/listinfo/yocto
Trevor, Ok - Now I am confused. I just looked through a bunch of commits to poky and the brackets are indeed used. I got this advice from Saul if I remember correctly a long time ago because I have been doing it this way for a long time. I will contact him and ask. Likely that it changed at some point and I didn't know about it. Scott >-----Original Message----- >From: Trevor Woerner [mailto:trevor.woerner@linaro.org] >Sent: Saturday, June 29, 2013 5:26 AM >To: Rifenbark, Scott M >Cc: yocto@yoctoproject.org; patches@linaro.org; Wold, Saul >Subject: Re: [yocto] [yocto-docs][PATCH] dev-manual: referencing >bugzilla issues > >What's odd is that here: > >http://lists.linuxtogo.org/pipermail/openembedded-core/2013- >April/037826.html > >Saul explicitly tells Radu that using the brackets is the correct >format (which is what, I think, caused me to send this patch in the >first place). > >I hope Saul notices this thread and comments :-) > >On 26 June 2013 00:26, Rifenbark, Scott M <scott.m.rifenbark@intel.com> >wrote: >> Trevor, >> >> I use to have [YOCTO #<bug-id>] in the manual just as you do here. I >was told by Saul though that I was not to use the brackets in the commit >description. That is when I took them out of the manual. Maybe Saul >can add more to this explanation. >> >> Thanks, >> Scott >> >>>-----Original Message----- >>>From: yocto-bounces@yoctoproject.org [mailto:yocto- >>>bounces@yoctoproject.org] On Behalf Of Trevor Woerner >>>Sent: Tuesday, June 25, 2013 7:38 PM >>>To: yocto@yoctoproject.org >>>Cc: patches@linaro.org >>>Subject: [yocto] [yocto-docs][PATCH] dev-manual: referencing bugzilla >>>issues >>> >>>Based on observations from the various mailing lists, it is obvious >that >>>bugzilla issues are almost always referenced using square brackets. >>> >>>Signed-off-by: Trevor Woerner <trevor.woerner@linaro.org> >>>--- >>> documentation/dev-manual/dev-manual-newbie.xml | 2 +- >>> 1 file changed, 1 insertion(+), 1 deletion(-) >>> >>>diff --git a/documentation/dev-manual/dev-manual-newbie.xml >>>b/documentation/dev-manual/dev-manual-newbie.xml >>>index 0c849f5..55e0c58 100644 >>>--- a/documentation/dev-manual/dev-manual-newbie.xml >>>+++ b/documentation/dev-manual/dev-manual-newbie.xml >>>@@ -1405,7 +1405,7 @@ >>> references - any commit that addresses a specific bug >>>should include the >>> bug ID in the description (typically at the >beginning) >>>as follows: >>> <literallayout class='monospaced'> >>>- Fixes YOCTO #<bug-id> >>>+ [YOCTO #<bug-id>] >>> >>> <detailed description of change> >>> </literallayout></para></listitem> >>>-- >>>1.8.3.rc1.44.gb387c77 >>> >>>_______________________________________________ >>>yocto mailing list >>>yocto@yoctoproject.org >>>https://lists.yoctoproject.org/listinfo/yocto
Trevor, I got a hold of Saul and confirmed that you are right. I have been entering these strings incorrectly for a good while now. I have applied your patch to the tip of the yocto-docs repository and republished in our development area for the manuals. Thanks, Scott >-----Original Message----- >From: yocto-bounces@yoctoproject.org [mailto:yocto- >bounces@yoctoproject.org] On Behalf Of Rifenbark, Scott M >Sent: Sunday, June 30, 2013 9:20 PM >To: Trevor Woerner >Cc: yocto@yoctoproject.org; Wold, Saul; patches@linaro.org >Subject: Re: [yocto] [yocto-docs][PATCH] dev-manual: referencing >bugzilla issues > >Trevor, > >Ok - Now I am confused. I just looked through a bunch of commits to >poky and the brackets are indeed used. I got this advice from Saul if I >remember correctly a long time ago because I have been doing it this way >for a long time. I will contact him and ask. Likely that it changed at >some point and I didn't know about it. > >Scott > >>-----Original Message----- >>From: Trevor Woerner [mailto:trevor.woerner@linaro.org] >>Sent: Saturday, June 29, 2013 5:26 AM >>To: Rifenbark, Scott M >>Cc: yocto@yoctoproject.org; patches@linaro.org; Wold, Saul >>Subject: Re: [yocto] [yocto-docs][PATCH] dev-manual: referencing >>bugzilla issues >> >>What's odd is that here: >> >>http://lists.linuxtogo.org/pipermail/openembedded-core/2013- >>April/037826.html >> >>Saul explicitly tells Radu that using the brackets is the correct >>format (which is what, I think, caused me to send this patch in the >>first place). >> >>I hope Saul notices this thread and comments :-) >> >>On 26 June 2013 00:26, Rifenbark, Scott M <scott.m.rifenbark@intel.com> >>wrote: >>> Trevor, >>> >>> I use to have [YOCTO #<bug-id>] in the manual just as you do here. I >>was told by Saul though that I was not to use the brackets in the >commit >>description. That is when I took them out of the manual. Maybe Saul >>can add more to this explanation. >>> >>> Thanks, >>> Scott >>> >>>>-----Original Message----- >>>>From: yocto-bounces@yoctoproject.org [mailto:yocto- >>>>bounces@yoctoproject.org] On Behalf Of Trevor Woerner >>>>Sent: Tuesday, June 25, 2013 7:38 PM >>>>To: yocto@yoctoproject.org >>>>Cc: patches@linaro.org >>>>Subject: [yocto] [yocto-docs][PATCH] dev-manual: referencing bugzilla >>>>issues >>>> >>>>Based on observations from the various mailing lists, it is obvious >>that >>>>bugzilla issues are almost always referenced using square brackets. >>>> >>>>Signed-off-by: Trevor Woerner <trevor.woerner@linaro.org> >>>>--- >>>> documentation/dev-manual/dev-manual-newbie.xml | 2 +- >>>> 1 file changed, 1 insertion(+), 1 deletion(-) >>>> >>>>diff --git a/documentation/dev-manual/dev-manual-newbie.xml >>>>b/documentation/dev-manual/dev-manual-newbie.xml >>>>index 0c849f5..55e0c58 100644 >>>>--- a/documentation/dev-manual/dev-manual-newbie.xml >>>>+++ b/documentation/dev-manual/dev-manual-newbie.xml >>>>@@ -1405,7 +1405,7 @@ >>>> references - any commit that addresses a specific >bug >>>>should include the >>>> bug ID in the description (typically at the >>beginning) >>>>as follows: >>>> <literallayout class='monospaced'> >>>>- Fixes YOCTO #<bug-id> >>>>+ [YOCTO #<bug-id>] >>>> >>>> <detailed description of change> >>>> </literallayout></para></listitem> >>>>-- >>>>1.8.3.rc1.44.gb387c77 >>>> >>>>_______________________________________________ >>>>yocto mailing list >>>>yocto@yoctoproject.org >>>>https://lists.yoctoproject.org/listinfo/yocto >_______________________________________________ >yocto mailing list >yocto@yoctoproject.org >https://lists.yoctoproject.org/listinfo/yocto
On 1 July 2013 02:37, Rifenbark, Scott M <scott.m.rifenbark@intel.com> wrote:
> I got a hold of Saul and confirmed that you are right. I have been entering these strings incorrectly for a good while now. I have applied your patch to the tip of the yocto-docs repository and republished in our development area for the manuals.
Great! Thank _you_ :-)
On 07/01/2013 08:35 AM, Trevor Woerner wrote: > On 1 July 2013 02:37, Rifenbark, Scott M <scott.m.rifenbark@intel.com> wrote: >> I got a hold of Saul and confirmed that you are right. I have been entering these strings incorrectly for a good while now. I have applied your patch to the tip of the yocto-docs repository and republished in our development area for the manuals. > Just to complete this, and I apologize for missing the thread, Yes, the correct format is [YOCTO #XXXX] where XXXX is the Yocto Project Bugzilla Bug #. Sau! > > Great! Thank _you_ :-) > _______________________________________________ > yocto mailing list > yocto@yoctoproject.org > https://lists.yoctoproject.org/listinfo/yocto > >
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0c849f5..55e0c58 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -1405,7 +1405,7 @@ references - any commit that addresses a specific bug should include the bug ID in the description (typically at the beginning) as follows: <literallayout class='monospaced'> - Fixes YOCTO #<bug-id> + [YOCTO #<bug-id>] <detailed description of change> </literallayout></para></listitem>
Based on observations from the various mailing lists, it is obvious that bugzilla issues are almost always referenced using square brackets. Signed-off-by: Trevor Woerner <trevor.woerner@linaro.org> --- documentation/dev-manual/dev-manual-newbie.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)