[Documentation,v2,1/3] RN: Fix script name
@@ -1,37 +1,45 @@
The data used by the Release Notes document is partially generated by
-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
-* the BSP directory: the directory where you initialized the
- fsl-community-bsp repository
- (https://github.com/Freescale/fsl-community-bsp-platform) with
+* the BSP directory: the directory where fsl-community-bsp 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 directory in
+ 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
-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
+Remember, EULA agreement will be shown in case it is not already accepted in
+Here's an example:
$ cd ../scripts
- $ bitbake-metadata.sh ~/src/fsl-community-bsp ~/src/gitdm 1.5 1.6
+ $ ./bitbake-metadata2doc.sh ~/src/fsl-community-bsp ~/src/gitdm 1.5 1.6
-By default, bitbake-metadata.sh collects data out of bitbake's
+By default, bitbake-metadata2doc.sh collects data out of bitbake's
metadata for all machines it can find in the meta-fsl-arm and
meta-fsl-arm-extra layers. You can restrict the machines to collect
data from by setting the MACHINES variable in your environment.
-bitbake-metadata.sh will write its output to release-note's `source'
+bitbake-metadata2doc.sh will write its output to release-note's `source'
To generate the formatted output for the release notes document, you