Skip to contentSkip to conversation

Minor documentation fixes

PATCH In review Paul Eggleton 4 participants 7 messages Dec 23, 2010 – Jan 21, 2011

lore
Share & tools
lore
#0 lore raw

cover Minor documentation fixes

Some minor documentation fixes. Please review for wording and formatting.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: paule/doc-fixes
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=paule/doc-fixes

Thanks,
Paul Eggleton <[email protected]>
---

Paul Eggleton (2):
documentation/bsp-guide/bsp.xml: fix typo in variable name documentation/poky-ref-manual: expand discussion of PR and INC_PR

 documentation/bsp-guide/bsp.xml                 |    2 +-
 documentation/poky-ref-manual/extendpoky.xml    |   17 +++++++++++------
 documentation/poky-ref-manual/ref-variables.xml |    8 ++++++--
 3 files changed, 18 insertions(+), 9 deletions(-)
#1 lore raw

PATCH 1/2 documentation/bsp-guide/bsp.xml: fix typo in variable name

FILESEXTRAPATH -> FILESEXTRAPATHS

---
 documentation/bsp-guide/bsp.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +1 -1
index f5fd217..7013974 100644
@@ -481,7 +481,7 @@ meta-Emenlow/recipes-Emenlow/image-creator/image-creator-native_0.1.bb
                 This allows the BSP layer to do whatever it might want to do to customize the original recipe.
             </para>
             <para>
-                If your recipe needs to reference extra files it can use the FILESEXTRAPATH variable
+                If your recipe needs to reference extra files it can use the FILESEXTRAPATHS variable
                 to specify their location. 
                 The example below shows extra files contained in a folder called ${PN} (the package name).
             </para>
Signature · 1 line
1.7.1
#2 lore raw

PATCH 2/2 documentation/poky-ref-manual: expand discussion of PR and INC_PR

In reply to Paul Eggleton

Expands a little on PR and INC_PR.

---
 documentation/poky-ref-manual/extendpoky.xml    |   17 +++++++++++------
 documentation/poky-ref-manual/ref-variables.xml |    8 ++++++--
 2 files changed, 17 insertions(+), 8 deletions(-)
documentation/poky-ref-manual/extendpoky.xml +11 -6
index 92f51a5..4fd818e 100644
@@ -685,15 +685,20 @@ BBFILE_PRIORITY_emenlow = "6"
                 This means that for new recipes you must be sure to add the PR variable and set its initial value
                 equal to "r0".  
                 Failing to define PR makes it easy to miss when you bump a package.
-                Note that you can only use integer values for the PR variable.
+                Note that you can only use integer values following the "r" in the PR variable.
             </para>
             <para>
-                You can also use the <glossterm><link linkend='var-INC_PR'>INC_PR</link></glossterm> variable
-                to keep up with package revisioning.
-            </para>
+                If you are sharing a common .inc file with multiple recipes, you can also use the 
+                <glossterm><link linkend='var-INC_PR'>INC_PR</link></glossterm> variable to ensure that 
+                the recipes sharing the .inc file are rebuilt when the .inc file itself is changed. The
+                .inc file must set INC_PR (initially to "r0"), and all recipes referring to it should set PR to 
+                "$(INC_PR).0" initially, incrementing the last number when the recipe is changed. If the
+                .inc file is changed then its INC_PR should be incremented.
+            </literallayout>
             <para> 
-                When upgrading the version of a package the (<glossterm><link 
-                linkend='var-PV'>PV</link></glossterm>) and PR variables should be reset to "r0".
+                When upgrading the version of a package, assuming the <glossterm><link 
+                linkend='var-PV'>PV</link></glossterm> changes, the PR variable should be reset to "r0"
+                (or "$(INC_PR).0" if you are using INC_PR).
             </para>
             <para>
                 Usually, version increases occur only to packages.
documentation/poky-ref-manual/ref-variables.xml +6 -2
index 98a501f..da57e2c 100644
@@ -609,7 +609,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
 
         <glossentry id='var-PR'><glossterm>PR</glossterm>
             <glossdef>
-                <para>Revision of package.
+                <para>Revision of package. The default value is "r0".
                     </para>
             </glossdef>
         </glossentry>
@@ -617,7 +617,11 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
         <glossentry id='var-PV'><glossterm>PV</glossterm>
             <glossdef>
                 <para>Version of package.
-                    The default value is "1.0"</para>
+                    This is normally extracted from the recipe name, e.g. if the recipe is named 
+                    "expat_2.0.1.bb" then PV will be "2.0.1". PV is generally not overridden within 
+                    a recipe unless it is building an unstable version from a source code repository 
+                    (git, svn, etc.).
+                 </para>
             </glossdef>
         </glossentry>
 
Signature · 1 line
1.7.1
#4 lore raw
Quoted 9 lines · Paul Eggleton
Quoted 6 lines · On Thursday 23 December 2010 13:55:42 Paul Eggleton wrote:

Some minor documentation fixes. Please review for wording and formatting.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: paule/doc-fixes
Browse:
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=paule/doc-fixes

Did anyone have a chance to review these?

These look good to me.

Cheers,
Joshua

Signature · 2 lines
Joshua Lock
        Intel Open Source Technology Centre
#5 lore raw

These look fine.

Scott R.

-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Joshua Lock
Sent: Wednesday, January 19, 2011 4:18 AM
To: [email protected]
Subject: Re: [poky] [PATCH 0/2] Minor documentation fixes

Quoted 9 lines · Paul Eggleton
Quoted 6 lines · On Thursday 23 December 2010 13:55:42 Paul Eggleton wrote:

Some minor documentation fixes. Please review for wording and formatting.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: paule/doc-fixes
Browse:
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=paule/doc-fixes

Did anyone have a chance to review these?

These look good to me.

Cheers,
Joshua

Signature · 7 lines
Joshua Lock
        Intel Open Source Technology Centre

_______________________________________________
poky mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/poky
#6 lore raw
In reply to Paul Eggleton
Quoted 20 lines · Paul Eggleton

Some minor documentation fixes. Please review for wording and formatting.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: paule/doc-fixes
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=paule/doc-fixes

Thanks,
Paul Eggleton<[email protected]>
---

Paul Eggleton (2):
documentation/bsp-guide/bsp.xml: fix typo in variable name documentation/poky-ref-manual: expand discussion of PR and INC_PR

  documentation/bsp-guide/bsp.xml                 |    2 +-
  documentation/poky-ref-manual/extendpoky.xml    |   17 +++++++++++------
  documentation/poky-ref-manual/ref-variables.xml |    8 ++++++--
  3 files changed, 18 insertions(+), 9 deletions(-)
Quoted 5 lines

_______________________________________________
poky mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/poky

Pulled into Master

Thanks
Sau!