[meta-freescale] [Documentation][PATCH 1/3] RN: Fix script name

[Otavio Salvador]

On Thu, May 1, 2014 at 5:44 PM, Daiane Angolini <daiane.list at gmail.com> wrote:
> Improve some text to describe the script usage.
>
> Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
> ---
>  release-notes/README | 33 ++++++++++++++++++++-------------
>  1 file changed, 20 insertions(+), 13 deletions(-)
>
> diff --git a/release-notes/README b/release-notes/README
> index ecc3374..4afd196 100644
> --- a/release-notes/README
> +++ b/release-notes/README
> @@ -1,37 +1,44 @@
>  The data used by the Release Notes document is partially generated by
>  scripts.
>
> -The scripts are in ../scripts. bitbake-metadata.sh is the main script.
> +The scripts are in ../scripts. bitbake-metadata2doc.sh is the main script.
>
> -bitbake-metadata.sh relies on the existence of the following
> +bitbake-metadata2doc.sh relies on the existence of the following
>  directories:
>
> -* the BSP directory: the directory where you initialized the
> -  fsl-community-bsp repository
> -  (https://github.com/Freescale/fsl-community-bsp-platform) with
> -  `repo'
> +* the BSP directory: the directory where fsl-community-bsp is initialized

... has been initialized ...

> +  (https://github.com/Freescale/fsl-community-bsp-platform) with `repo'
> +  The script uses BitBake so is suggested to have a previous build on this folder

... previous build directory on this folder?

>  * the gitdm directory: a clone of the
>    https://github.com/OSSystems/gitdm repository (to generate
>    statistics for the Acknowledgements section)
>
> -* the Documentation directory: this very repository.  Note that
> -  bitbake-metadata.sh assumes Documentation to be found in
> +* the Documentation directory: this very repository. Note that
> +  bitbake-metadata2doc.sh assumes Documentation to be found in
>    $BSPDIR/sources
>
> -To run bitbake-metadata.sh, change to the scripts directory and run it
> +To run bitbake-metadata2doc.sh, change to the scripts directory and run it
>  with the BSP directory, the gitdm repository directory, the initial
> -tag and the end tag (to gather commit statistics).  Here's an example:
> +tag and the end tag (to gather commit statistics).
> +
> +The script execution can take some time due to bitbake re-execution of
> +preliminar tasks.

preliminary?

> +
> +Remember, EULA agreament will be shown in case it is not already accepted in
> +correspondent local.conf

agreement?

-- 
Otavio Salvador                             O.S. Systems
http://www.ossystems.com.br        http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750