diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-01-09 08:26:25 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-21 21:57:58 +0000 |
commit | 814e07159fcc6b30bc66e699a0b153c6eb40e244 (patch) | |
tree | aff6a4eb16881e23112d91a862613af90dd37be3 /documentation | |
parent | 78564304dc23b4312ee4f7a836a26ecdde88e11e (diff) | |
download | poky-814e07159fcc6b30bc66e699a0b153c6eb40e244.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 3ee327c54d..22209af39a 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1749,12 +1749,10 @@ | |||
1749 | Typically, setting these options is accomplished by running a | 1749 | Typically, setting these options is accomplished by running a |
1750 | configure script with some options, or by modifying a build | 1750 | configure script with some options, or by modifying a build |
1751 | configuration file. | 1751 | configuration file. |
1752 | </para> | 1752 | <note> |
1753 | 1753 | It is possible that required build-time or runtime dependencies | |
1754 | <para> | 1754 | exist in the software's documentation. |
1755 | When considering configuration, you should realize that | 1755 | </note> |
1756 | required build-time or runtime dependencies might or might not | ||
1757 | be noted in the software's documentation. | ||
1758 | </para> | 1756 | </para> |
1759 | 1757 | ||
1760 | <para> | 1758 | <para> |
@@ -1798,8 +1796,9 @@ | |||
1798 | <filename>CMakeLists.txt</filename> file, then your | 1796 | <filename>CMakeLists.txt</filename> file, then your |
1799 | software is built using some method other than Autotools | 1797 | software is built using some method other than Autotools |
1800 | or CMake. | 1798 | or CMake. |
1801 | If this is the case, you need to provide a | 1799 | If this is the case, you normally need to provide a |
1802 | <filename>do_configure</filename> task in your recipe. | 1800 | <filename>do_configure</filename> task in your recipe |
1801 | unless, of course, there is nothing to configure. | ||
1803 | </para> | 1802 | </para> |
1804 | <para>Even if your software is not being built by | 1803 | <para>Even if your software is not being built by |
1805 | Autotools or CMake, you still might not need to deal | 1804 | Autotools or CMake, you still might not need to deal |
@@ -1807,11 +1806,10 @@ | |||
1807 | You need to determine if configuration is even a required step. | 1806 | You need to determine if configuration is even a required step. |
1808 | You might need to modify a Makefile or some configuration file | 1807 | You might need to modify a Makefile or some configuration file |
1809 | used for the build to specify necessary build options. | 1808 | used for the build to specify necessary build options. |
1810 | Or, perhaps you might need to run a hand-written configuration | 1809 | Or, perhaps you might need to run a provided, custom |
1811 | script as opposed to something that | 1810 | configure script with the appropriate options.</para> |
1812 | <filename>autoconf</filename> would run.</para> | 1811 | <para>For the case involving a custom configure |
1813 | <para>For the case involving a hand-written | 1812 | script, you would run |
1814 | configuration script, you would run | ||
1815 | <filename>./configure --help</filename> and look for | 1813 | <filename>./configure --help</filename> and look for |
1816 | the options you need to set.</para></listitem> | 1814 | the options you need to set.</para></listitem> |
1817 | </itemizedlist> | 1815 | </itemizedlist> |
@@ -1820,7 +1818,8 @@ | |||
1820 | <para> | 1818 | <para> |
1821 | Once configuration succeeds, it is always good practice to | 1819 | Once configuration succeeds, it is always good practice to |
1822 | look at the <filename>log.do_configure</filename> file to | 1820 | look at the <filename>log.do_configure</filename> file to |
1823 | ensure that nothing needs to be added to | 1821 | ensure that the appropriate options have been enabled and no |
1822 | additional build-time dependencies need to be added to | ||
1824 | <filename>DEPENDS</filename>. | 1823 | <filename>DEPENDS</filename>. |
1825 | For example, if the configure script reports that it found | 1824 | For example, if the configure script reports that it found |
1826 | something not mentioned in <filename>DEPENDS</filename>, or | 1825 | something not mentioned in <filename>DEPENDS</filename>, or |
@@ -1832,6 +1831,11 @@ | |||
1832 | that are in <filename>DEPENDS</filename>, in which case | 1831 | that are in <filename>DEPENDS</filename>, in which case |
1833 | you would need to look at passing extra options to the | 1832 | you would need to look at passing extra options to the |
1834 | configure script as needed. | 1833 | configure script as needed. |
1834 | For reference information on configure options specific to the | ||
1835 | software you are building, you can consult the output of the | ||
1836 | <filename>./configure --help</filename> command within | ||
1837 | <filename>${S}</filename> or consult the upstream | ||
1838 | documentation. | ||
1835 | </para> | 1839 | </para> |
1836 | </section> | 1840 | </section> |
1837 | 1841 | ||