From 13d47a1fa5ec17ca005031287dbe9ca21b2fe9c0 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 21 Sep 2016 16:06:18 -0700 Subject: ref-manual: Added two new tips Fixes [YOCTO #10297] Updated the "Other Tips" section to include a couple new tips. * Remove the /tmp directory as a way to work-around temporary build issues. * Create a little method to help you search the massive amounts of bits for whatever. Also, suggested filing bugs against the docs if a feature is too hard to find or figure out. (From yocto-docs rev: d9829dd096f7cc56f8e55fba3190be2a59b80fe5) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/usingpoky.xml | 88 +++++++++++++++++++++++++++++++--- 1 file changed, 81 insertions(+), 7 deletions(-) diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 75ee86f4f6..9e3c19ff47 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -929,18 +929,92 @@ Here are some other tips that you might find useful: - When adding new packages, it is worth watching for - undesirable items making their way into compiler command lines. - For example, you do not want references to local system files like - /usr/lib/ or /usr/include/. + + When adding new packages, it is worth watching for + undesirable items making their way into compiler command + lines. + For example, you do not want references to local system + files like + /usr/lib/ or + /usr/include/. - If you want to remove the psplash + + If you want to remove the psplash boot splashscreen, - add psplash=false to the kernel command line. + add psplash=false to the kernel + command line. Doing so prevents psplash from loading and thus allows you to see the console. It is also possible to switch out of the splashscreen by - switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). + switching the virtual console (e.g. Fn+Left or Fn+Right + on a Zaurus). + + + Removing + TMPDIR + (usually tmp/, within the + Build Directory) + can often fix temporary build issues. + Removing TMPDIR is usually a + relatively cheap operation, because task output will be + cached in + SSTATE_DIR + (usually sstate-cache/, which is + also in the Build Directory). + + Removing TMPDIR might be a + workaround rather than a fix. + Consequently, trying to determine the underlying cause + of an issue before removing the directory is a good + ideal. + + + + Understanding how a feature is used in practice within + existing recipes can be very helpful. + It is recommended that you configure some method that + allows you to quickly search through files. + + Using GNU Grep, you can use the following shell + function to recursively search through common + recipe-related files, skipping binary files, + .git directories, and the + Build Directory (assuming its name starts with + "build"): + + g() { + grep -Ir \ + --exclude-dir=.git \ + --exclude-dir='build*' \ + --include='*.bb*' \ + --include='*.inc*' \ + --include='*.conf*' \ + --include='*.py*' \ + "$@" + } + + Following are some usage examples: + + $ g FOO # Search recursively for "FOO" + $ g -i foo # Search recursively for "foo", ignoring case + $ g -w FOO # Search recursively for "FOO" as a word, ignoring e.g. "FOOBAR" + + If figuring out how some feature works requires a lot of + searching, it might indicate that the documentation should + be extended or improved. + In such cases, consider filing a documentation bug using + the Yocto Project implementation of + Bugzilla. + For general information on how to submit a bug against + the Yocto Project, see the + "Tracking Bugs" + section in the Yocto Project Development Manual. + + The manuals might not be the right place to document + variables that are purely internal and have a limited + scope (e.g. internal variables used to implement a + single .bbclass file). + -- cgit 1.2.3-korg