should task entries (particularly kernel tasks) mention file/directory names?

"Robert P. J. Day" <[email protected]> Fri, 10 Jul 2026 12:17:23 -0400 (EDT)
Newsgroups org.yoctoproject.lists.docs
Message-ID <[email protected]>
  as i follow the logic of all the kernel-related tasks and make some
notes, it seems that their explanations could benefit from the
inclusion of which files and directories they're working with.

  example: do_shared_workdir():

https://docs.yoctoproject.org/ref-manual/tasks.html#do-shared-workdir

which opens with:

"After the kernel has been compiled but before the kernel modules have
been compiled, this task copies files required for module builds and
which are generated from the kernel build into the shared work
directory."

  ok, but there is no hint as to where the kernel compilation was
done, and where the files are copied *from*, and "into the shared work
directory". sure, but where is the "shared work directory?"

  is there any value in enhancing these task explanations with actual
file or directory name variables so readers could understand where all
this activity is taking place? or is that going a bit too far?

rday