[yocto] [PATCH] documentation: updates to static library support in SDK

[Maxin B. John]

Hi Andre,

On Wed, Jun 14, 2017 at 10:57:41AM -0700, Andre McCurdy wrote:
> On Wed, Jun 14, 2017 at 5:12 AM, Maxin B. John <maxin.john at intel.com> wrote:
> > For development purposes, static libraries need to be
> > present only in the SDK. We do not need those static
> > libraries in the image for most scenarios. So, replace
> > IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.
> >
> > Suggested-by: Anders Darander <anders at chargestorm.se>
> > Signed-off-by: Maxin B. John <maxin.john at intel.com>
> > ---
> >  documentation/adt-manual/adt-prepare.xml         | 8 ++++----
> >  documentation/sdk-manual/sdk-appendix-obtain.xml | 8 ++++----
> >  2 files changed, 8 insertions(+), 8 deletions(-)
> >
> > diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
> > index 65df1d0..7587305 100644
> > --- a/documentation/adt-manual/adt-prepare.xml
> > +++ b/documentation/adt-manual/adt-prepare.xml
> > @@ -684,16 +684,16 @@
> >          <note>
> >              By default, this toolchain does not build static binaries.
> >              If you want to use the toolchain to build these types of libraries,
> > -            you need to be sure your image has the appropriate static
> > +            you need to be sure your SDK has the appropriate static
> >              development libraries.
> >              Use the
> > -            <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
> > +            <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>
> >              variable inside your <filename>local.conf</filename> file to
> > -            install the appropriate library packages.
> > +            include the appropriate library packages in SDK.
> >              Following is an example using <filename>glibc</filename> static
> >              development libraries:
> >              <literallayout class='monospaced'>
> > -     IMAGE_INSTALL_append = " glibc-staticdev"
> > +     TOOLCHAIN_TARGET_TASK_append = " glibc-staticdev"
> 
> That should perhaps be "libc-staticdev" so the same instructions work
> for musl (although it looks like currently musl doesn't rprovide
> libc-staticdev so that would need to be fixed too).

I agree with your suggestion that examples in documentation shouldn't be
specific for a particular libc implementation.

Filed a bug for musl libc-staticdev support:
https://bugzilla.yoctoproject.org/show_bug.cgi?id=11669

> >              </literallayout>
> >          </note>
> >      </para>
> > diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml
> > index 3156f77..86e0eff 100644
> > --- a/documentation/sdk-manual/sdk-appendix-obtain.xml
> > +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
> > @@ -96,16 +96,16 @@
> >                  <listitem><para>
> >                      By default, this toolchain does not build static binaries.
> >                      If you want to use the toolchain to build these types of
> > -                    libraries, you need to be sure your image has the
> > +                    libraries, you need to be sure your SDK has the
> >                      appropriate static development libraries.
> >                      Use the
> > -                    <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
> > +                    <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>
> >                      variable inside your <filename>local.conf</filename> file
> > -                    to install the appropriate library packages.
> > +                    to install the appropriate library packages in SDK.
> >                      Following is an example using <filename>glibc</filename>
> >                      static development libraries:
> >                      <literallayout class='monospaced'>
> > -     IMAGE_INSTALL_append = " glibc-staticdev"
> > +     TOOLCHAIN_TARGET_TASK_append = " glibc-staticdev"
> >                      </literallayout>
> >                      </para></listitem>

Best Regards,
Maxin