From 814e07159fcc6b30bc66e699a0b153c6eb40e244 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 9 Jan 2014 08:26:25 -0600 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 32 +++++++++++-------- 1 file 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 @@ Typically, setting these options is accomplished by running a configure script with some options, or by modifying a build configuration file. - - - - When considering configuration, you should realize that - required build-time or runtime dependencies might or might not - be noted in the software's documentation. + + It is possible that required build-time or runtime dependencies + exist in the software's documentation. + @@ -1798,8 +1796,9 @@ CMakeLists.txt file, then your software is built using some method other than Autotools or CMake. - If this is the case, you need to provide a - do_configure task in your recipe. + If this is the case, you normally need to provide a + do_configure task in your recipe + unless, of course, there is nothing to configure. Even if your software is not being built by 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 might need to modify a Makefile or some configuration file used for the build to specify necessary build options. - Or, perhaps you might need to run a hand-written configuration - script as opposed to something that - autoconf would run. - For the case involving a hand-written - configuration script, you would run + Or, perhaps you might need to run a provided, custom + configure script with the appropriate options. + For the case involving a custom configure + script, you would run ./configure --help and look for the options you need to set. @@ -1820,7 +1818,8 @@ Once configuration succeeds, it is always good practice to look at the log.do_configure 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 DEPENDS. For example, if the configure script reports that it found something not mentioned in DEPENDS, or @@ -1832,6 +1831,11 @@ that are in DEPENDS, in which case you would need to look at passing extra options to the configure script as needed. + For reference information on configure options specific to the + software you are building, you can consult the output of the + ./configure --help command within + ${S} or consult the upstream + documentation.