sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Edits to "Configuring the Recipe" section. 

Applied review edits from Paul Eggleton for this section that is
part of the "Writing a New Recipe" section.  Minor wording issues
only.

(From yocto-docs rev: 8e291826fcb9547c3fc16aa81ccf6867fe2e417d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-01-09 08:26:25 -06:00 committed by Richard Purdie
parent 78564304dc
commit 814e07159f
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -1749,12 +1749,10 @@
Typically, setting these options is accomplished by running a Typically, setting these options is accomplished by running a
configure script with some options, or by modifying a build configure script with some options, or by modifying a build
configuration file. configuration file.
</para> <note>
It is possible that required build-time or runtime dependencies
<para> exist in the software's documentation.
When considering configuration, you should realize that </note>
required build-time or runtime dependencies might or might not
be noted in the software's documentation.
</para> </para>
<para> <para>
@ -1798,8 +1796,9 @@
<filename>CMakeLists.txt</filename> file, then your <filename>CMakeLists.txt</filename> file, then your
software is built using some method other than Autotools software is built using some method other than Autotools
or CMake. or CMake.
If this is the case, you need to provide a If this is the case, you normally need to provide a
<filename>do_configure</filename> task in your recipe. <filename>do_configure</filename> task in your recipe
unless, of course, there is nothing to configure.
</para> </para>
<para>Even if your software is not being built by <para>Even if your software is not being built by
Autotools or CMake, you still might not need to deal Autotools or CMake, you still might not need to deal
@ -1807,11 +1806,10 @@
You need to determine if configuration is even a required step. You need to determine if configuration is even a required step.
You might need to modify a Makefile or some configuration file You might need to modify a Makefile or some configuration file
used for the build to specify necessary build options. used for the build to specify necessary build options.
Or, perhaps you might need to run a hand-written configuration Or, perhaps you might need to run a provided, custom
script as opposed to something that configure script with the appropriate options.</para>
<filename>autoconf</filename> would run.</para> <para>For the case involving a custom configure
<para>For the case involving a hand-written script, you would run
configuration script, you would run
<filename>./configure --help</filename> and look for <filename>./configure --help</filename> and look for
the options you need to set.</para></listitem> the options you need to set.</para></listitem>
</itemizedlist> </itemizedlist>
@ -1820,7 +1818,8 @@
<para> <para>
Once configuration succeeds, it is always good practice to Once configuration succeeds, it is always good practice to
look at the <filename>log.do_configure</filename> file to look at the <filename>log.do_configure</filename> file to
ensure that nothing needs to be added to ensure that the appropriate options have been enabled and no
additional build-time dependencies need to be added to
<filename>DEPENDS</filename>. <filename>DEPENDS</filename>.
For example, if the configure script reports that it found For example, if the configure script reports that it found
something not mentioned in <filename>DEPENDS</filename>, or something not mentioned in <filename>DEPENDS</filename>, or
@ -1832,6 +1831,11 @@
that are in <filename>DEPENDS</filename>, in which case that are in <filename>DEPENDS</filename>, in which case
you would need to look at passing extra options to the you would need to look at passing extra options to the
configure script as needed. configure script as needed.
For reference information on configure options specific to the
software you are building, you can consult the output of the
<filename>./configure --help</filename> command within
<filename>${S}</filename> or consult the upstream
documentation.
</para> </para>
</section> </section>