summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide/recipe-style-guide.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/contributor-guide/recipe-style-guide.rst')
-rw-r--r--documentation/contributor-guide/recipe-style-guide.rst20
1 files changed, 16 insertions, 4 deletions
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst
index 08d8fb4259..806bf23848 100644
--- a/documentation/contributor-guide/recipe-style-guide.rst
+++ b/documentation/contributor-guide/recipe-style-guide.rst
@@ -47,10 +47,10 @@ Debian policy closely.
47 47
48When a recipe references a git revision that does not correspond to a released 48When a recipe references a git revision that does not correspond to a released
49version of software (e.g. is not a tagged version), the :term:`PV` variable 49version of software (e.g. is not a tagged version), the :term:`PV` variable
50should include the Git revision using the following to make the 50should include the sign ``+``, so :term:`bitbake` automatically includes package
51version clear:: 51version information during the packaging phase::
52 52
53 PV = "<version>+git${SRCPV}" 53 PV = "<version>+git"
54 54
55In this case, ``<version>`` should be the most recently released version of the 55In this case, ``<version>`` should be the most recently released version of the
56software from the current source revision (``git describe`` can be useful for 56software from the current source revision (``git describe`` can be useful for
@@ -395,7 +395,7 @@ one CVE is fixed, separate them using spaces.
395CVE Examples 395CVE Examples
396------------ 396------------
397 397
398This should be the header of patch that fixes :cve:`2015-8370` in GRUB2:: 398This should be the header of patch that fixes :cve_nist:`2015-8370` in GRUB2::
399 399
400 grub2: Fix CVE-2015-8370 400 grub2: Fix CVE-2015-8370
401 401
@@ -409,3 +409,15 @@ This should be the header of patch that fixes :cve:`2015-8370` in GRUB2::
409 Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2] 409 Upstream-Status: Backport [http://git.savannah.gnu.org/cgit/grub.git/commit/?id=451d80e52d851432e109771bb8febafca7a5f1f2]
410 CVE: CVE-2015-8370 410 CVE: CVE-2015-8370
411 Signed-off-by: Joe Developer <joe.developer@example.com> 411 Signed-off-by: Joe Developer <joe.developer@example.com>
412
413Patch format
414============
415
416By default, patches created with ``git format-patch`` have a `Git` version signature at the end.
417To avoid having a `Git` signature at the end of generated or updated patches,
418you can use `Git` configuration settings::
419
420 git config --global format.signature ""
421
422.. note::
423 Patches generated or updated by ``devtool`` are created with no signature.