[PATCHv2] common_use_cases: add description of SOC_FAMILY

[PATCHv2] common_use_cases: add description of SOC_FAMILY

[Chase Maupin]

* Added a description of the SOC_FAMILY variable that
  can be set in the machine configuration files.

Signed-off-by: Chase Maupin <chase.maupin@ti.com>
---
 docs/usermanual/chapters/common_use_cases.xml |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)

diff --git a/docs/usermanual/chapters/common_use_cases.xml b/docs/usermanual/chapters/common_use_cases.xml
index d86d0ca..ef81b95 100644
--- a/docs/usermanual/chapters/common_use_cases.xml
+++ b/docs/usermanual/chapters/common_use_cases.xml
@@ -94,6 +94,30 @@ SRCDATE = "20061014"
         </listitem>
       </itemizedlist></para>
 
+    <para>There are also some optional variables that can be defined:
+    <itemizedlist>
+    <listitem>
+          <para><command>SOC_FAMILY</command> describes a family of processors
+            that all share common features such as kernel versions,
+            bootloaders, etc.  This is used to allow overrides for a whole
+            set of devices rather than per machine overrides being used.
+            The use of SOC_FAMILY as an override is currently a distribution
+            or local setting.
+          </para>
+          <para>
+            NOTE: SOC_FAMILY is different than MACHINE_CLASS in that 
+            MACHINE_CLASS is intended to specify a grouping of devices
+            that may have different processors but share common features.
+            For example all OMAP3 devices can be described using the SOC_FAMILY
+            "omap3" and this value can be used in overrides to prevent
+            requiring multiple machine specific overrides.  MACHINE_CLASS
+            might be used to describe a class of devices such as a cell
+            phone in which the processor may be different but the
+            features such as touchscreen, GPS, modem, etc are the same.
+          </para>
+        </listitem>
+    </itemizedlist></para>
+
     <para>Next the kernel recipe needs to be added if it doesn't already exist.
     </para>
   </section>
-- 
1.7.0.4

Re: [PATCHv2] common_use_cases: add description of SOC_FAMILY

[Paul Menzel]

[-- Attachment #1: Type: text/plain, Size: 1323 bytes --]

Am Mittwoch, den 08.09.2010, 13:03 -0500 schrieb Chase Maupin:
> * Added a description of the SOC_FAMILY variable that
>   can be set in the machine configuration files.
> 
> Signed-off-by: Chase Maupin <chase.maupin@ti.com>
> ---
>  docs/usermanual/chapters/common_use_cases.xml |   24 ++++++++++++++++++++++++
>  1 files changed, 24 insertions(+), 0 deletions(-)
> 
> diff --git a/docs/usermanual/chapters/common_use_cases.xml b/docs/usermanual/chapters/common_use_cases.xml
> index d86d0ca..ef81b95 100644
> --- a/docs/usermanual/chapters/common_use_cases.xml
> +++ b/docs/usermanual/chapters/common_use_cases.xml
> @@ -94,6 +94,30 @@ SRCDATE = "20061014"
>          </listitem>
>        </itemizedlist></para>
>  
> +    <para>There are also some optional variables that can be defined:
> +    <itemizedlist>
> +    <listitem>
> +          <para><command>SOC_FAMILY</command> describes a family of processors
> +            that all share common features such as kernel versions,
> +            bootloaders, etc.  This is used to allow overrides for a whole

I think a full stop is required even if there is an abbreviation in
front of it. → etc..

[…]

With this fixed:

Acked-by: Paul Menzel <paulepanter@users.sourceforge.net>


Thanks for improving the documentation,

Paul

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 205 bytes --]

Re: [PATCHv2] common_use_cases: add description of SOC_FAMILY

[Frans Meulenbroeks]

2010/9/8 Chase Maupin <chasemaupin03@gmail.com>:
> * Added a description of the SOC_FAMILY variable that
>  can be set in the machine configuration files.
>
> Signed-off-by: Chase Maupin <chase.maupin@ti.com>
> ---
>  docs/usermanual/chapters/common_use_cases.xml |   24 ++++++++++++++++++++++++
>  1 files changed, 24 insertions(+), 0 deletions(-)
>
> diff --git a/docs/usermanual/chapters/common_use_cases.xml b/docs/usermanual/chapters/common_use_cases.xml
> index d86d0ca..ef81b95 100644
> --- a/docs/usermanual/chapters/common_use_cases.xml
> +++ b/docs/usermanual/chapters/common_use_cases.xml
> @@ -94,6 +94,30 @@ SRCDATE = "20061014"
>         </listitem>
>       </itemizedlist></para>
>
> +    <para>There are also some optional variables that can be defined:
> +    <itemizedlist>
> +    <listitem>
> +          <para><command>SOC_FAMILY</command> describes a family of processors
> +            that all share common features such as kernel versions,
> +            bootloaders, etc.  This is used to allow overrides for a whole
> +            set of devices rather than per machine overrides being used.
> +            The use of SOC_FAMILY as an override is currently a distribution
> +            or local setting.
> +          </para>
> +          <para>
> +            NOTE: SOC_FAMILY is different than MACHINE_CLASS in that
> +            MACHINE_CLASS is intended to specify a grouping of devices
> +            that may have different processors but share common features.
> +            For example all OMAP3 devices can be described using the SOC_FAMILY
> +            "omap3" and this value can be used in overrides to prevent
> +            requiring multiple machine specific overrides.  MACHINE_CLASS
> +            might be used to describe a class of devices such as a cell
> +            phone in which the processor may be different but the
> +            features such as touchscreen, GPS, modem, etc are the same.
> +          </para>
> +        </listitem>
> +    </itemizedlist></para>
> +
>     <para>Next the kernel recipe needs to be added if it doesn't already exist.
>     </para>
>   </section>
> --
> 1.7.0.4

Thanks for writing this.
Seems like a decent description to me.

Acked-by: Frans Meulenbroeks <fransmeulenbroeks@gmail.com>

Re: [PATCHv2] common_use_cases: add description of SOC_FAMILY

[Maupin, Chase]

> -----Original Message-----
> From: openembedded-devel-bounces@lists.openembedded.org
> [mailto:openembedded-devel-bounces@lists.openembedded.org] On Behalf Of
> Paul Menzel
> Sent: Wednesday, September 08, 2010 4:48 PM
> To: openembedded-devel@lists.openembedded.org
> Subject: Re: [oe] [PATCHv2] common_use_cases: add description of
> SOC_FAMILY
> 
> Am Mittwoch, den 08.09.2010, 13:03 -0500 schrieb Chase Maupin:
> > * Added a description of the SOC_FAMILY variable that
> >   can be set in the machine configuration files.
> >
> > Signed-off-by: Chase Maupin <chase.maupin@ti.com>
> > ---
> >  docs/usermanual/chapters/common_use_cases.xml |   24
> ++++++++++++++++++++++++
> >  1 files changed, 24 insertions(+), 0 deletions(-)
> >
> > diff --git a/docs/usermanual/chapters/common_use_cases.xml
> b/docs/usermanual/chapters/common_use_cases.xml
> > index d86d0ca..ef81b95 100644
> > --- a/docs/usermanual/chapters/common_use_cases.xml
> > +++ b/docs/usermanual/chapters/common_use_cases.xml
> > @@ -94,6 +94,30 @@ SRCDATE = "20061014"
> >          </listitem>
> >        </itemizedlist></para>
> >
> > +    <para>There are also some optional variables that can be defined:
> > +    <itemizedlist>
> > +    <listitem>
> > +          <para><command>SOC_FAMILY</command> describes a family of
> processors
> > +            that all share common features such as kernel versions,
> > +            bootloaders, etc.  This is used to allow overrides for a
> whole
> 
> I think a full stop is required even if there is an abbreviation in
> front of it. → etc..

Paul,

I'm afraid I don't understand what you are asking to have fixed.  Are you saying you want it to be etc.. instead of etc.

Just want to clarify before I remake this patch.

> 
> […]
> 
> With this fixed:
> 
> Acked-by: Paul Menzel <paulepanter@users.sourceforge.net>
> 
> 
> Thanks for improving the documentation,
> 
> Paul

Re: [PATCHv2] common_use_cases: add description of SOC_FAMILY

[Paul Menzel]

[-- Attachment #1: Type: text/plain, Size: 2326 bytes --]

Am Donnerstag, den 09.09.2010, 07:09 -0500 schrieb Maupin, Chase:
> > -----Original Message-----
> > From: openembedded-devel-bounces@lists.openembedded.org
> > [mailto:openembedded-devel-bounces@lists.openembedded.org] On Behalf Of
> > Paul Menzel
> > Sent: Wednesday, September 08, 2010 4:48 PM
> > To: openembedded-devel@lists.openembedded.org
> > Subject: Re: [oe] [PATCHv2] common_use_cases: add description of
> > SOC_FAMILY
> > 
> > Am Mittwoch, den 08.09.2010, 13:03 -0500 schrieb Chase Maupin:
> > > * Added a description of the SOC_FAMILY variable that
> > >   can be set in the machine configuration files.
> > >
> > > Signed-off-by: Chase Maupin <chase.maupin@ti.com>
> > > ---
> > >  docs/usermanual/chapters/common_use_cases.xml |   24
> > ++++++++++++++++++++++++
> > >  1 files changed, 24 insertions(+), 0 deletions(-)
> > >
> > > diff --git a/docs/usermanual/chapters/common_use_cases.xml
> > b/docs/usermanual/chapters/common_use_cases.xml
> > > index d86d0ca..ef81b95 100644
> > > --- a/docs/usermanual/chapters/common_use_cases.xml
> > > +++ b/docs/usermanual/chapters/common_use_cases.xml
> > > @@ -94,6 +94,30 @@ SRCDATE = "20061014"
> > >          </listitem>
> > >        </itemizedlist></para>
> > >
> > > +    <para>There are also some optional variables that can be defined:
> > > +    <itemizedlist>
> > > +    <listitem>
> > > +          <para><command>SOC_FAMILY</command> describes a family of processors
> > > +            that all share common features such as kernel versions,
> > > +            bootloaders, etc.  This is used to allow overrides for a whole
> > 
> > I think a full stop is required even if there is an abbreviation in
> > front of it. → etc..

> I'm afraid I don't understand what you are asking to have fixed.  Are you saying you want it to be etc.. instead of etc.
> 
> Just want to clarify before I remake this patch.

I verified it again and it looks like I am wrong and it is handled
differently in English than in German [1][2]. I am sorry for the noise.

[…]

> > Acked-by: Paul Menzel <paulepanter@users.sourceforge.net>

[…]


Thanks,

Paul


[1] https://secure.wikimedia.org/wikipedia/en/wiki/Full_stop#Abbreviations
[2] http://www.talktalk.co.uk/reference/dictionaries/english/data/d0082120.html

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 205 bytes --]

Re: [PATCHv2] common_use_cases: add description of SOC_FAMILY

[Denys Dmytriyenko]

On Thu, Sep 09, 2010 at 08:17:07AM +0200, Frans Meulenbroeks wrote:
> 2010/9/8 Chase Maupin <chasemaupin03@gmail.com>:
> > * Added a description of the SOC_FAMILY variable that
> >  can be set in the machine configuration files.
> >
> > Signed-off-by: Chase Maupin <chase.maupin@ti.com>
> > ---
> >  docs/usermanual/chapters/common_use_cases.xml |   24 ++++++++++++++++++++++++
> >  1 files changed, 24 insertions(+), 0 deletions(-)
> >
> > diff --git a/docs/usermanual/chapters/common_use_cases.xml b/docs/usermanual/chapters/common_use_cases.xml
> > index d86d0ca..ef81b95 100644
> > --- a/docs/usermanual/chapters/common_use_cases.xml
> > +++ b/docs/usermanual/chapters/common_use_cases.xml
> > @@ -94,6 +94,30 @@ SRCDATE = "20061014"
> >         </listitem>
> >       </itemizedlist></para>
> >
> > +    <para>There are also some optional variables that can be defined:
> > +    <itemizedlist>
> > +    <listitem>
> > +          <para><command>SOC_FAMILY</command> describes a family of processors
> > +            that all share common features such as kernel versions,
> > +            bootloaders, etc.  This is used to allow overrides for a whole
> > +            set of devices rather than per machine overrides being used.
> > +            The use of SOC_FAMILY as an override is currently a distribution
> > +            or local setting.
> > +          </para>
> > +          <para>
> > +            NOTE: SOC_FAMILY is different than MACHINE_CLASS in that
> > +            MACHINE_CLASS is intended to specify a grouping of devices
> > +            that may have different processors but share common features.
> > +            For example all OMAP3 devices can be described using the SOC_FAMILY
> > +            "omap3" and this value can be used in overrides to prevent
> > +            requiring multiple machine specific overrides.  MACHINE_CLASS
> > +            might be used to describe a class of devices such as a cell
> > +            phone in which the processor may be different but the
> > +            features such as touchscreen, GPS, modem, etc are the same.
> > +          </para>
> > +        </listitem>
> > +    </itemizedlist></para>
> > +
> >     <para>Next the kernel recipe needs to be added if it doesn't already exist.
> >     </para>
> >   </section>
> > --
> > 1.7.0.4
> 
> Thanks for writing this.
> Seems like a decent description to me.
> 
> Acked-by: Frans Meulenbroeks <fransmeulenbroeks@gmail.com>

Acked-by: Denys Dmytriyenko <denis@denix.org>

If there are no objections, I'd like to push it later today.

-- 
Denys