summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-03-07 10:26:34 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-03-19 23:54:02 +0000
commit5c2dca7e75a9b35a148258d913343e625961bb44 (patch)
tree9cb00f780f51a882d7371be88efc68bd4f5abbef /documentation/ref-manual/ref-variables.xml
parent8c7ec72e6d1af59d36aebeadb5df43da2a04a0dd (diff)
downloadpoky-5c2dca7e75a9b35a148258d913343e625961bb44.tar.gz
ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.
(From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index bbfa37675f..3ffa92c866 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6919,6 +6919,44 @@
6919 </glossdef> 6919 </glossdef>
6920 </glossentry> 6920 </glossentry>
6921 6921
6922 <glossentry id='var-INHIBIT_SYSROOT_STRIP'><glossterm>INHIBIT_SYSROOT_STRIP</glossterm>
6923 <info>
6924 INHIBIT_SYSROOT_STRIP[doc] = "If set to "1", causes the build to not strip binaries in the resulting sysroot."
6925 </info>
6926 <glossdef>
6927 <para role="glossdeffirst">
6928<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6929 If set to "1", causes the build to not strip binaries in
6930 the resulting sysroot.
6931 </para>
6932
6933 <para>
6934 By default, the OpenEmbedded build system strips
6935 binaries in the resulting sysroot.
6936 When you specifically set the
6937 <filename>INHIBIT_SYSROOT_STRIP</filename> variable to
6938 "1" in your recipe, you inhibit this stripping.
6939 </para>
6940
6941 <para>
6942 If you want to use this variable, include the
6943 <link linkend='ref-classes-staging'><filename>staging</filename></link>
6944 class.
6945 This class uses a <filename>sys_strip()</filename>
6946 function to test for the variable and acts accordingly.
6947 <note>
6948 Use of the <filename>INHIBIT_SYSROOT_STRIP</filename>
6949 variable occurs in rare and special circumstances.
6950 For example, suppose you are building bare-metal
6951 firmware by using an external GCC toolchain.
6952 Furthermore, even if the toolchain's binaries are
6953 strippable, other files exist that are needed for the
6954 build that are not strippable.
6955 </note>
6956 </para>
6957 </glossdef>
6958 </glossentry>
6959
6922 <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> 6960 <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
6923 <info> 6961 <info>
6924 INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot." 6962 INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot."