All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bob Feretich <bob.feretich@rafresearch.com>
To: yocto@yoctoproject.org
Subject: Definition of Yocto tasks
Date: Mon, 05 May 2014 16:52:09 -0700	[thread overview]
Message-ID: <53682429.6070103@rafresearch.com> (raw)

Is there a document that provides a detailed definition of what each 
these tasks do?
Yocto, OE, and bitbake manuals tell us how to command a specific task to 
be run, but not what they do.

The task name provides a good hint sometimes, but often that is not 
enough. Users shouldn't have to read the python code for this 
information. These descriptions should be a part of the yocto manual.

Sections 5.3.4 to 5.3.11 of the Yocto mega-manual provide a good 
overview of some of these tasks in the context of a workflow, but 
doesn't mention most of these tasks and doesn't go into enough detail on 
the tasks it discusses.

It wouldn't be appropriate to add more detail at that point in the 
manual, but it would be appropriate to include details regarding all of 
the tasks in an appendix.

Examples...
The manual states that do_fetch fetches source, but doesn't state that 
when git is used whether it performs a pull, fetch, or clone. What are 
the common failure conditions of do_fetch? And what should the user do 
to fix the problem?

do_build is mentioned a few times, but there is no reference to it being 
the default task or what tasks are invoked by do_build and which are 
omitted.

do_rm_work and do_wm_work_all are not mentioned at all.

Result of listtasks:
do_fetchall
do_build
do_devshell
do_package_write_ipk
do_cleansstate
do_savedefconfig
do_uboot_mkimage
do_sizecheck
do_strip
do_packagedata_setscene
do_configure
do_clean
do_deploy_setscene
do_cleanall
do_populate_lic
do_populate_sysroot
do_devicetree_image
do_deploy
do_menuconfig
do_patch
do_bundle_initramfs
do_packagedata
do_listtasks
do_compile
do_package_setscene
do_populate_lic_setscene
do_fetch
do_checkuri
do_compile_kernelmodules
do_package_write_ipk_setscene
do_package_write
do_rm_work
do_package
do_unpack
do_install
do_checkuriall
do_populate_sysroot_setscene
do_rm_work_all

I don't have the knowledge to create such an appendix, but I volunteer 
to be a proofreader.

Regards,
Bob




             reply	other threads:[~2014-05-05 23:52 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-05 23:52 Bob Feretich [this message]
2014-05-06  6:47 ` Definition of Yocto tasks Rifenbark, Scott M
2014-05-06  9:38   ` Paul Eggleton
2014-05-06 22:23     ` Bob Feretich
2014-05-07 12:58       ` Paul Eggleton
2014-05-08 23:25         ` Bob Feretich
2014-05-09  5:47           ` Rifenbark, Scott M

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=53682429.6070103@rafresearch.com \
    --to=bob.feretich@rafresearch.com \
    --cc=yocto@yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.