diff options
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 88 |
1 files 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 @@ | |||
929 | <para> | 929 | <para> |
930 | Here are some other tips that you might find useful: | 930 | Here are some other tips that you might find useful: |
931 | <itemizedlist> | 931 | <itemizedlist> |
932 | <listitem><para>When adding new packages, it is worth watching for | 932 | <listitem><para> |
933 | undesirable items making their way into compiler command lines. | 933 | When adding new packages, it is worth watching for |
934 | For example, you do not want references to local system files like | 934 | undesirable items making their way into compiler command |
935 | <filename>/usr/lib/</filename> or <filename>/usr/include/</filename>. | 935 | lines. |
936 | For example, you do not want references to local system | ||
937 | files like | ||
938 | <filename>/usr/lib/</filename> or | ||
939 | <filename>/usr/include/</filename>. | ||
936 | </para></listitem> | 940 | </para></listitem> |
937 | <listitem><para>If you want to remove the <filename>psplash</filename> | 941 | <listitem><para> |
942 | If you want to remove the <filename>psplash</filename> | ||
938 | boot splashscreen, | 943 | boot splashscreen, |
939 | add <filename>psplash=false</filename> to the kernel command line. | 944 | add <filename>psplash=false</filename> to the kernel |
945 | command line. | ||
940 | Doing so prevents <filename>psplash</filename> from loading | 946 | Doing so prevents <filename>psplash</filename> from loading |
941 | and thus allows you to see the console. | 947 | and thus allows you to see the console. |
942 | It is also possible to switch out of the splashscreen by | 948 | It is also possible to switch out of the splashscreen by |
943 | switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). | 949 | switching the virtual console (e.g. Fn+Left or Fn+Right |
950 | on a Zaurus). | ||
951 | </para></listitem> | ||
952 | <listitem><para> | ||
953 | Removing | ||
954 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | ||
955 | (usually <filename>tmp/</filename>, within the | ||
956 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>) | ||
957 | can often fix temporary build issues. | ||
958 | Removing <filename>TMPDIR</filename> is usually a | ||
959 | relatively cheap operation, because task output will be | ||
960 | cached in | ||
961 | <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> | ||
962 | (usually <filename>sstate-cache/</filename>, which is | ||
963 | also in the Build Directory). | ||
964 | <note> | ||
965 | Removing <filename>TMPDIR</filename> might be a | ||
966 | workaround rather than a fix. | ||
967 | Consequently, trying to determine the underlying cause | ||
968 | of an issue before removing the directory is a good | ||
969 | ideal. | ||
970 | </note> | ||
971 | </para></listitem> | ||
972 | <listitem><para> | ||
973 | Understanding how a feature is used in practice within | ||
974 | existing recipes can be very helpful. | ||
975 | It is recommended that you configure some method that | ||
976 | allows you to quickly search through files.</para> | ||
977 | |||
978 | <para>Using GNU Grep, you can use the following shell | ||
979 | function to recursively search through common | ||
980 | recipe-related files, skipping binary files, | ||
981 | <filename>.git</filename> directories, and the | ||
982 | Build Directory (assuming its name starts with | ||
983 | "build"): | ||
984 | <literallayout class='monospaced'> | ||
985 | g() { | ||
986 | grep -Ir \ | ||
987 | --exclude-dir=.git \ | ||
988 | --exclude-dir='build*' \ | ||
989 | --include='*.bb*' \ | ||
990 | --include='*.inc*' \ | ||
991 | --include='*.conf*' \ | ||
992 | --include='*.py*' \ | ||
993 | "$@" | ||
994 | } | ||
995 | </literallayout> | ||
996 | Following are some usage examples: | ||
997 | <literallayout class='monospaced'> | ||
998 | $ g FOO # Search recursively for "FOO" | ||
999 | $ g -i foo # Search recursively for "foo", ignoring case | ||
1000 | $ g -w FOO # Search recursively for "FOO" as a word, ignoring e.g. "FOOBAR" | ||
1001 | </literallayout> | ||
1002 | If figuring out how some feature works requires a lot of | ||
1003 | searching, it might indicate that the documentation should | ||
1004 | be extended or improved. | ||
1005 | In such cases, consider filing a documentation bug using | ||
1006 | the Yocto Project implementation of | ||
1007 | <ulink url='https://bugzilla.yoctoproject.org/'>Bugzilla</ulink>. | ||
1008 | For general information on how to submit a bug against | ||
1009 | the Yocto Project, see the | ||
1010 | "<ulink url='&YOCTO_DOCS_DEV_URL;#tracking-bugs'>Tracking Bugs</ulink>" | ||
1011 | section in the Yocto Project Development Manual. | ||
1012 | <note> | ||
1013 | The manuals might not be the right place to document | ||
1014 | variables that are purely internal and have a limited | ||
1015 | scope (e.g. internal variables used to implement a | ||
1016 | single <filename>.bbclass</filename> file). | ||
1017 | </note> | ||
944 | </para></listitem> | 1018 | </para></listitem> |
945 | </itemizedlist> | 1019 | </itemizedlist> |
946 | </para> | 1020 | </para> |