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

[Rifenbark, Scott M]

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