recipes: Document the remaining custom tasks per oelint

Set doc strings on the custom functions oelint-adv reports via
'oelint.task.docstrings': the three i.MX boot firmware deploy helpers,
the libubootenv uboot-config fixup handler, the qemu-qoriq wrapper
generator, the testfloat SoftFloat unpack step, the linux-imx device
tree compatibility handler and the imx-mp4-parser QA-skip hook.

imx-mp4-parser reuses the wording already used for the identical hook in
imx-parser, so the two prebuilt-binary recipes read the same.

opencv and libcamera are deliberately left alone.  Both recipes carry
their upstream recipe as a marked verbatim block ("meta-openembedded
copy"), and the two functions oelint flags -- do_unpack_extra and
do_package_recalculate_ipa_signatures -- sit inside those blocks, where
meta-openembedded sets no doc string.  Annotating them would break the
diff against upstream for no functional gain, so those two findings stay
visible.

bitbake never reads the 'doc' flag when computing task checksums --
bb/data.py build_dependencies() only consults vardeps, vardepvalue,
vardepsexclude, exports, postfuncs, prefuncs, lineno and filename -- so
these additions cannot change a signature or invalidate sstate.

Verified by re-linting each file.

Signed-off-by: Luciano Dittgen <luciano.dittgen@ossystems.com.br>

6 files changed, 8 insertions, 0 deletions

diff --git a/recipes-bsp/firmware-imx/imx-boot-firmware-files_8.31.bb b/recipes-bsp/firmware-imx/imx-boot-firmware-files_8.31.bb
index 87569b4a3..e0219ca8d 100644
--- a/recipes-bsp/firmware-imx/imx-boot-firmware-files_8.31.bb
+++ b/recipes-bsp/firmware-imx/imx-boot-firmware-files_8.31.bb
@@ -19,6 +19,7 @@ deploy_for_mx8() {
     install -m 0644 ${S}/firmware/hdmi/cadence/hdmirxfw.bin ${DEPLOYDIR}
     install -m 0644 ${S}/firmware/hdmi/cadence/dpfw.bin ${DEPLOYDIR}
 }
+deploy_for_mx8[doc] = "Deploy the Cadence HDMI firmware used by the i.MX 8 boot container"
 
 deploy_for_mx8m() {
     # Synopsys DDR
@@ -30,6 +31,7 @@ deploy_for_mx8m() {
     install -m 0644 ${S}/firmware/hdmi/cadence/signed_dp_imx8m.bin ${DEPLOYDIR}
     install -m 0644 ${S}/firmware/hdmi/cadence/signed_hdmi_imx8m.bin ${DEPLOYDIR}
 }
+deploy_for_mx8m[doc] = "Deploy the Synopsys DDR and Cadence DP/HDMI firmware used by the i.MX 8M boot container"
 
 deploy_for_mx9() {
     # Synopsys DDR
@@ -37,6 +39,7 @@ deploy_for_mx9() {
         install -m 0644 ${S}/firmware/ddr/synopsys/${ddr_firmware} ${DEPLOYDIR}
     done
 }
+deploy_for_mx9[doc] = "Deploy the Synopsys DDR firmware used by the i.MX 9 boot container"
 
 python () {
     # Manually add the required functions as dependencies otherwise they won't be included in the
diff --git a/recipes-bsp/u-boot/libubootenv_%.bbappend b/recipes-bsp/u-boot/libubootenv_%.bbappend
index 619b510e1..d1cecf100 100644
--- a/recipes-bsp/u-boot/libubootenv_%.bbappend
+++ b/recipes-bsp/u-boot/libubootenv_%.bbappend
@@ -38,6 +38,7 @@ def fixup_uboot_config_dependency(d):
 python fixup_uboot_config_dependency_handler() {
     fixup_uboot_config_dependency(d)
 }
+fixup_uboot_config_dependency_handler[doc] = "Borrow UBOOT_MACHINE and UBOOT_CONFIG from IMX_DEFAULT_BOOTLOADER so libubootenv passes the uboot-config sanity check"
 
 fixup_uboot_config_dependency_handler[eventmask] = "bb.event.RecipePreFinalise"
 addhandler fixup_uboot_config_dependency_handler
diff --git a/recipes-devtools/qemu/qemu-qoriq.inc b/recipes-devtools/qemu/qemu-qoriq.inc
index 33694c5ce..c598d3ff1 100644
--- a/recipes-devtools/qemu/qemu-qoriq.inc
+++ b/recipes-devtools/qemu/qemu-qoriq.inc
@@ -146,6 +146,7 @@ make_qemu_wrapper() {
                         GTK_THEME=Adwaita
         done
 }
+make_qemu_wrapper[doc] = "Wrap the installed qemu-system-* binaries so they find the gdk-pixbuf loaders, fontconfig and GTK theme at runtime"
 
 # Disable kvm/virgl/mesa on targets that do not support it
 PACKAGECONFIG:remove:darwin = "kvm virglrenderer glx gtk+"
diff --git a/recipes-extended/testfloat/testfloat_2a.bb b/recipes-extended/testfloat/testfloat_2a.bb
index db87ae985..45ca5ae11 100644
--- a/recipes-extended/testfloat/testfloat_2a.bb
+++ b/recipes-extended/testfloat/testfloat_2a.bb
@@ -29,6 +29,7 @@ do_unpack2(){
         echo -e "\nERROR: command dos2unix or fromdos not found\n" && return 1
     fi
 }
+do_unpack2[doc] = "Move the SoftFloat sources into ${S} and convert the shipped DOS line endings"
 addtask do_unpack2 after do_unpack before do_patch
 
 do_compile(){
diff --git a/recipes-kernel/linux/linux-imx.inc b/recipes-kernel/linux/linux-imx.inc
index d704e2921..f0f8b5ba2 100644
--- a/recipes-kernel/linux/linux-imx.inc
+++ b/recipes-kernel/linux/linux-imx.inc
@@ -60,5 +60,6 @@ python kernel_devicetree_32bit_compatibility_update() {
         bb.warn("Updating KERNEL_DEVICETREE, removing sub-folders for older kernel. Use -D for more details. Set KERNEL_DEVICETREE_32BIT_COMPATIBILITY_UPDATE = \"0\" to disable.")
         d.setVar('KERNEL_DEVICETREE', output)
 }
+kernel_devicetree_32bit_compatibility_update[doc] = "Strip device tree sub-folders from KERNEL_DEVICETREE for older 32-bit kernels that keep the dtb files flat"
 addhandler kernel_devicetree_32bit_compatibility_update
 kernel_devicetree_32bit_compatibility_update[eventmask] = "bb.event.RecipeParsed"
diff --git a/recipes-multimedia/imx-parser/imx-mp4-parser_git.bb b/recipes-multimedia/imx-parser/imx-mp4-parser_git.bb
index 1c70fb6e4..2c3628639 100644
--- a/recipes-multimedia/imx-parser/imx-mp4-parser_git.bb
+++ b/recipes-multimedia/imx-parser/imx-mp4-parser_git.bb
@@ -31,6 +31,7 @@ python __set_insane_skip() {
     for p in d.getVar('PACKAGES').split():
         d.setVar("INSANE_SKIP:%s" % p, "ldflags dev-so textrel buildpaths")
 }
+__set_insane_skip[doc] = "Skip QA checks that cannot be satisfied by the prebuilt parser binaries"
 
 do_package_qa[prefuncs] += "__set_insane_skip"