freescale / documentation Goto Github PK

It does not make any sense to have a 0.0.0+git version for a dummy-package

Detail the difference between production X basic feature

Double check step-by-step reproducing and generating any fix needed.

It makes no sense to point a dummy-package version in a "versionXpackage" table.

At least, the 00.00.00 must be documented somewhere in order to get it clear this version is a dummy-package.

Presently the Release Notes and User Guide both contain a supported machine table based on a separate source file in their own source directories. It would be simpler to maintain things going forward if a single source file was used to generate the tables in both documents.

Over time the User Guide's table became more and more out of date compared to the Release Notes copy. Under Pull Request #27 I updated the User Guide source file by replacing it with the Release Notes version. Future maintenance could be simplified by either sourcing the same file directly or getting make to grab a copy.

Make sure we understand what we are not supposed to be

Some BSP variables (such as MACHINE_GSTREAMER_PLUGIN or ACCEPT_FSL_EULA) must be identified and documented. After the documentation is included into source code, it must be automatically extracted and placed in RN

• identify BSP variables
• document each one
• generate the RN section for this

Maybe this is not supposed to be placed in Release Notes. However, I think it can be a good starting point for the text. As soon as we identify a better approach we can move the text or adapt the doc.

Rework the DESCRIPTION for all u-boot provider whitout a propor description.

This work should be done in u-boot recipes from meta-fsl-arm and meta-fsl-arm-extra

Include a section describing the procedure to report a bug in bugzila.

Pointing the bugzila URL

• What is the pending issues to make it public
• What should be the process of adding new question

Today it´s is imx and vybrid.

However, it´s important to add a room for QorIQ and Layerscape

• nitrogen6x-lite

Improve the QT in use images DESCRIPTIONS because nowadays the description says nothing more than the image name does.

• qt-in-use-image: qt-in-use-image version 1.0-r0.
• qte-in-use-image: qte-in-use-image version 1.0-r0.

This section is supposed to say what is the motivation in having a community.

Why we are here

The command used is:

./bitbake-metadata2doc.sh /media/daiane/TRIFORCE/yocto/dunfell/ /media/daiane/TRIFORCE/yocto/gitdm/ zeus dunfell

my branches:

meta-freescale 3fc701d11b4b096ba016110c83fe1b48c5f3a256
meta-freescale-3rdparty 086ca01665436882176426e033c49af81f15518f
Documentation 8f0aaf0

Your configuration files at tmp.MKSY59L4Rd have not been touched.
Parsing recipes: 100% |#################################################################################################################################| Time: 0:00:42
Parsing of 2159 .bb files complete (0 cached, 2159 parsed). 3241 targets, 477 skipped, 0 masked, 0 errors.
Writing ../release-notes/source/linux-default.inc
Writing ../release-notes/source/fsl-community-bsp-supported-kernels.inc
Writing ../release-notes/source/fsl-community-bsp-supported-bootloaders-descr.inc
Traceback (most recent call last):
  File "./bitbake-metadata2doc.py", line 519, in <module>
    write_bootloader_default(data, out_dir)
  File "./bitbake-metadata2doc.py", line 89, in write_bootloader_default
    boards_bloaders[board] = (image_bootloader, board_data['recipes'][image_bootloader]['version'])
KeyError: u'imx-boot'
Error running bitbake-metadata2doc.py.  Aborting.

PACKAGEGROUP and IMAGES have been included in meta-fsl-arm, meta-fsl-demos, (...) in order to easy our day-by-day work.

They have been adding with DESCRIPTION/SUMMARY, so, it makes sense that we can have a way to automatically generate the list of supported PACKAGEGROUPS and IMAGES in order to have a central place where we can see the available possibility

• automate PACKAGEGROUP list generation
• automate IMAGE list generation
• create the text to introduce the list of PACKAGEGROUP
• create the text to introduce the list of IMAGES
• create the section for this
• think about a how-to section in UG (targeting 1.8 maybe)

Run the script to generate the changes in

• package versions
• new machines
• new kernel/bootloader providers

https://github.com/Freescale/Documentation/blob/master/release-notes/README#L35

I am facing an error while running:

./bitbake-metadata2doc.sh /media/daiane/TRIFORCE/yocto/dunfell/ /media/daiane/TRIFORCE/yocto/gitdm/ zeus dunfell

I could not find the tmp folder.

Welcome to Freescale Community BSP

The Yocto Project has extensive documentation about OE including a
reference manual which can be found at:
    http://yoctoproject.org/documentation

For more information about OpenEmbedded see their website:
    http://www.openembedded.org/

You can now run 'bitbake <target>'

Common targets are:
    core-image-minimal
    meta-toolchain
    meta-toolchain-sdk
    adt-installer
    meta-ide-support

Your configuration files at tmp.CCiafLWdLP have not been touched.
Parsing recipes: 100% |#################################################################################################################################| Time: 0:00:44
Parsing of 2159 .bb files complete (0 cached, 2159 parsed). 3241 targets, 477 skipped, 0 masked, 0 errors.
Writing ../release-notes/source/linux-default.inc
Writing ../release-notes/source/fsl-community-bsp-supported-kernels.inc
Writing ../release-notes/source/fsl-community-bsp-supported-bootloaders-descr.inc
Writing ../release-notes/source/bootloader-default.inc
ERROR: multiple versions have been found for gstreamer1.0: 1.16.2, 1.16.imx
Error running bitbake-metadata2doc.py.  Aborting.

The set of procedures from here is a good starting point to enhance the basic User Guide.

• Task 1 Download the source code
• Task 2 First build
• Task 3 The build result
• Task 4 Deploy and test
• Task 5 Kernel
• Task 6 Customize the image
• Task 7 Create the toolchain
• Task 8 Build kernel manually using created toolchain
• Task 9 How to add bad/ugly
• Task 10 How to create a custom layer

some python modules needed ?

/Documentation/user-guide$ make latexpdf
sphinx-build -b latex -d build/doctrees source build/latex
Error: The babel.messages.pofile module cannot be found. Did you install Sphinx and its dependencies correctly?
Makefile:106: recipe for target 'latexpdf' failed
make: *** [latexpdf] Error 1

Add a section in User Guide talking about How to use/why DirectFB/Wayland/FB/X11 on i.MX6

The homepage at http://freescale.github.io/ seems very outdated, with the most recent release listed as "2.4 - codename Rocko".

I've haven't been able to work out where the source for that page resides, so I'm submitting this as an Issue instead of working to create a Pull Request.

• #3 - Motivation
• #4 - What the FSL Community BSP is not
• #5 - What to expect

Add the properly files to get the documents:

• release notes
• user guides
• faq

properly covered by CC - share-alike, attribution

The User Guide document is a set of command lines with a clear goal.

Those command lines can be seen as scripts.

Currently, the documentation source code does not allow one to execute the command lines as it was a script.

We can think about how to write the documentation in a better shape in order to get snipes of code extracted to be tested easily (for the sanity test check of every release, just like like #10)

$ repo init -u https://github.com/Freescale/fsl-community-bsp-platform -b master
$ repo sync
$ repo start --all master
$ ./bitbake-metadata2doc.sh ~/yocto/master/ ~/gitdm/ jethro master

Welcome to Freescale Community BSP

The Yocto Project has extensive documentation about OE including a
reference manual which can be found at:
    http://yoctoproject.org/documentation

For more information about OpenEmbedded see their website:
    http://www.openembedded.org/

You can now run 'bitbake <target>'

Common targets are:
    core-image-minimal
    meta-toolchain
    meta-toolchain-sdk
    adt-installer
    meta-ide-support

Your configuration files at tmp.CAF0wjk9OP have not been touched.
Parsing recipes..ERROR: No IMAGE_CMD defined for IMAGE_FSTYPES entry 'barebox.mxsboot-sdcard' - possibly invalid type name or missing support class
ERROR: Failed to parse recipe: ~/yocto/master/sources/meta-fsl-arm/recipes-fsl/images/fsl-image-mfgtool-initramfs.bb
Traceback (most recent call last):
  File "~/yocto/master/sources/Documentation/scripts/extract-bitbake-metadata.py", line 333, in <module>
    data.update(extract_bitbake_metadata(user_recipes))
  File "~/yocto/master/sources/Documentation/scripts/extract-bitbake-metadata.py", line 290, in extract_bitbake_metadata
    tinfoil.parseRecipes()
  File "~/yocto/master/sources/poky/bitbake/bin/../lib/bb/tinfoil.py", line 68, in parseRecipes
    self.cooker.updateCache()
  File "~/yocto/master/sources/poky/bitbake/bin/../lib/bb/cooker.py", line 1557, in updateCache
    raise bb.BBHandledException()
bb.BBHandledException
ERROR: error extracting bitbake metadata for board 

I manually replaced the absolute path and used ~ instead.