Re: [PATCH 2/2] documentation: Kernel Manual fixes

[Darren Hart <dvhart@linux.intel.com>]

On 03/13/2011 10:50 PM, Tom Zanussi wrote:
> From: Tom Zanussi<tom.zanussi@intel.com>
>

Thanks Tom, you beat me to it.

> Upgraded to reflect 1.0 usage rather than 0.90 usage, and some other
> clarifications and minor changes.

Only one minor nitpic below:

>
> Signed-off-by: Tom Zanussi<tom.zanussi@intel.com>
> ---
>   documentation/kernel-manual/kernel-how-to.xml |  120 +++++++++++++------------
>   1 files changed, 61 insertions(+), 59 deletions(-)
>
> diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml
> index abb19f2..fdfda40 100644
> --- a/documentation/kernel-manual/kernel-how-to.xml
> +++ b/documentation/kernel-manual/kernel-how-to.xml
> @@ -425,18 +425,18 @@ repository.
>

...

>               <para>
> -                This section provides an example for creating a BSP that is based on an existing, and hopefully,
> -                similar one.
> -                Follow these steps and keep in mind your particular situation and differences:
> +                This section provides an example for creating a BSP
> +                that is based on an existing, and hopefully, similar
> +                one.  It assumes you'll be using a local kernel

We should void using contractions in formal documentation

s/you'll/you will/

> +                repository and will be pointing the kernel recipe at
> +                that.  Follow these steps and keep in mind your
> +                particular situation and differences:
>
>               <orderedlist>
>                   <listitem><para>
> @@ -1016,16 +1019,10 @@ That's it. Configure and build.
>                   </para>
>
>                   <para>
> -                    You can start with something in<filename>meta/conf/machine</filename>.
> -                    Or,<filename>meta-emenlow/conf/machine</filename>  has an example in its own layer.
> +                    You can start with something in<filename>meta/conf/machine</filename>  -<filename>meta/conf/machine/atom-pc.conf</filename>  for example.  Or, you can start with a machine configuration from any of the BSP layers in the meta-intel repository at<ulink url='http://git.pokylinux.org/cgit/cgit.cgi/meta-intel/'></ulink>, such as<filename>meta-intel/meta-emenlow/conf/machine/emenlow.conf</filename>.

I presume we're using some line length limit in our documentation?


Otherwise looks good to me.

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel