[yocto] [yocto-docs][PATCH] dev-manual: referencing bugzilla issues

[Rifenbark, Scott M]

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 at yoctoproject.org [mailto:yocto-
>bounces at yoctoproject.org] On Behalf Of Rifenbark, Scott M
>Sent: Sunday, June 30, 2013 9:20 PM
>To: Trevor Woerner
>Cc: yocto at yoctoproject.org; Wold, Saul; patches at 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 at linaro.org]
>>Sent: Saturday, June 29, 2013 5:26 AM
>>To: Rifenbark, Scott M
>>Cc: yocto at yoctoproject.org; patches at 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 at 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 at yoctoproject.org [mailto:yocto-
>>>>bounces at yoctoproject.org] On Behalf Of Trevor Woerner
>>>>Sent: Tuesday, June 25, 2013 7:38 PM
>>>>To: yocto at yoctoproject.org
>>>>Cc: patches at 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 at 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 at yoctoproject.org
>>>>https://lists.yoctoproject.org/listinfo/yocto
>_______________________________________________
>yocto mailing list
>yocto at yoctoproject.org
>https://lists.yoctoproject.org/listinfo/yocto