[PATCH 0/2] Minor documentation fixes

[PATCH 0/2] Minor documentation fixes

[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 <paul.eggleton@linux.intel.com>
---


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(-)

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

[Paul Eggleton]

FILESEXTRAPATH -> FILESEXTRAPATHS

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
 documentation/bsp-guide/bsp.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index f5fd217..7013974 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -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>
-- 
1.7.1

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

[Paul Eggleton]

Expands a little on PR and INC_PR.

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
---
 documentation/poky-ref-manual/extendpoky.xml    |   17 +++++++++++------
 documentation/poky-ref-manual/ref-variables.xml |    8 ++++++--
 2 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml
index 92f51a5..4fd818e 100644
--- a/documentation/poky-ref-manual/extendpoky.xml
+++ b/documentation/poky-ref-manual/extendpoky.xml
@@ -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.
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 98a501f..da57e2c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -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>
 
-- 
1.7.1

Re: [PATCH 0/2] Minor documentation fixes

[Paul Eggleton]

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?

Thanks,
Paul

Re: [PATCH 0/2] Minor documentation fixes

[Joshua Lock]

On Wed, 2011-01-19 at 10:22 +0000, Paul Eggleton wrote:
> 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
-- 
Joshua Lock
        Intel Open Source Technology Centre

Re: [PATCH 0/2] Minor documentation fixes

[Rifenbark, Scott M]

These look fine. 

Scott R.

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

On Wed, 2011-01-19 at 10:22 +0000, Paul Eggleton wrote:
> 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
-- 
Joshua Lock
        Intel Open Source Technology Centre

_______________________________________________
poky mailing list
poky@yoctoproject.org
https://lists.yoctoproject.org/listinfo/poky

Re: [PATCH 0/2] Minor documentation fixes

[Saul Wold]

On 12/23/2010 05:55 AM, 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
>
> Thanks,
>      Paul Eggleton<paul.eggleton@linux.intel.com>
> ---
>
>
> 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(-)
>
> _______________________________________________
> poky mailing list
> poky@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/poky
>
Pulled into Master

Thanks
	Sau!