diff options
Diffstat (limited to 'import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml')
| -rw-r--r-- | import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml | 156 |
1 files changed, 95 insertions, 61 deletions
diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml index e29bf89e5..b974d0f59 100644 --- a/import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-devtool-reference.xml @@ -20,7 +20,7 @@ For more information on how to apply the command when using the extensible SDK, see the "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>Using the Extensible SDK</ulink>" - section in the Yocto Project Application Development and the + chapter in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. </para> @@ -35,59 +35,51 @@ the commands: <literallayout class='monospaced'> $ devtool --help - usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] - [--fetch-dev] [--version VERSION] [--no-git] - [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] - [--binary] [--also-native] [--src-subdir SUBDIR] - [--mirrors] [--provides PROVIDES] - [recipename] [srctree] [fetchuri] + NOTE: Starting bitbake server... + usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] + [--color COLOR] [-h] + <subcommand> ... - Adds a new recipe to the workspace to build a specified source tree. Can - optionally fetch a remote URI and unpack it to create the source tree. - - arguments: - recipename Name for new recipe to add (just name - no version, - path or extension). If not specified, will attempt - to auto-detect it. - srctree Path to external source tree. If not specified, a - subdirectory of - /home/<replaceable>user</replaceable>/poky/build/workspace/sources will be - used. - fetchuri Fetch the specified URI and extract it to create - the source tree + OpenEmbedded development tool options: - -h, --help show this help message and exit - --same-dir, -s Build in same directory as source - --no-same-dir Force build in a separate build directory - --fetch URI, -f URI Fetch the specified URI and extract it to create - the source tree (deprecated - pass as positional - argument instead) - --fetch-dev For npm, also fetch devDependencies - --version VERSION, -V VERSION - Version to use within recipe (PV) - --no-git, -g If fetching source, do not set up source tree as a - git repository - --srcrev SRCREV, -S SRCREV - Source revision to fetch if fetching from an SCM - such as git (default latest) - --autorev, -a When fetching from a git repository, set SRCREV in - the recipe to a floating revision instead of fixed - --srcbranch SRCBRANCH, -B SRCBRANCH - Branch in source repository if fetching from an SCM - such as git (default master) - --binary, -b Treat the source tree as something that should be - installed verbatim (no compilation, same directory - structure). Useful with binary packages e.g. RPMs. - --also-native Also add native variant (i.e. support building - recipe for the build host as well as the target - machine) - --src-subdir SUBDIR Specify subdirectory within source tree to use - --mirrors Enable PREMIRRORS and MIRRORS for source tree - fetching (disable by default). - --provides PROVIDES, -p PROVIDES - Specify an alias for the item provided by the - recipe. E.g. virtual/libgl + --basepath BASEPATH Base directory of SDK / build directory + --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it + from the metadata + -d, --debug Enable debug output + -q, --quiet Print only errors + --color COLOR Colorize output (where COLOR is auto, always, never) + -h, --help show this help message and exit + + subcommands: + Beginning work on a recipe: + add Add a new recipe + modify Modify the source for an existing recipe + upgrade Upgrade an existing recipe + Getting information: + status Show workspace status + search Search available recipes + latest-version Report the latest version of an existing recipe + Working on a recipe in the workspace: + build Build a recipe + rename Rename a recipe file in the workspace + edit-recipe Edit a recipe file + find-recipe Find a recipe file + configure-help Get help on configure script options + update-recipe Apply changes from external source tree to recipe + reset Remove a recipe from your workspace + finish Finish working on a recipe in your workspace + Testing changes on target: + deploy-target Deploy recipe output files to live target machine + undeploy-target Undeploy recipe output files in live target machine + build-image Build image including workspace recipe packages + Advanced: + create-workspace Set up workspace in an alternative location + export Export workspace into a tar archive + import Import exported tar archive into workspace + extract Extract the source for an existing recipe + sync Synchronize the source tree for an existing recipe + Use devtool <subcommand> --help to get help on a specific command </literallayout> </para> @@ -97,9 +89,12 @@ name and using <filename>--help</filename>: <literallayout class='monospaced'> $ devtool add --help + NOTE: Starting bitbake server... usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] - [--version VERSION] [--no-git] [--autorev] [--binary] - [--also-native] [--src-subdir SUBDIR] + [--fetch-dev] [--version VERSION] [--no-git] + [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] + [--binary] [--also-native] [--src-subdir SUBDIR] + [--mirrors] [--provides PROVIDES] [recipename] [srctree] [fetchuri] Adds a new recipe to the workspace to build a specified source tree. Can @@ -123,18 +118,30 @@ --fetch URI, -f URI Fetch the specified URI and extract it to create the source tree (deprecated - pass as positional argument instead) + --fetch-dev For npm, also fetch devDependencies --version VERSION, -V VERSION Version to use within recipe (PV) --no-git, -g If fetching source, do not set up source tree as a git repository + --srcrev SRCREV, -S SRCREV + Source revision to fetch if fetching from an SCM such + as git (default latest) --autorev, -a When fetching from a git repository, set SRCREV in the recipe to a floating revision instead of fixed + --srcbranch SRCBRANCH, -B SRCBRANCH + Branch in source repository if fetching from an SCM + such as git (default master) --binary, -b Treat the source tree as something that should be installed verbatim (no compilation, same directory structure). Useful with binary packages e.g. RPMs. --also-native Also add native variant (i.e. support building recipe for the build host as well as the target machine) --src-subdir SUBDIR Specify subdirectory within source tree to use + --mirrors Enable PREMIRRORS and MIRRORS for source tree fetching + (disable by default). + --provides PROVIDES, -p PROVIDES + Specify an alias for the item provided by the recipe. + E.g. virtual/libgl </literallayout> </para> </section> @@ -161,7 +168,7 @@ <para> <literallayout class='monospaced'> - attic - A directory created if devtool believes it preserve + attic - A directory created if devtool believes it must preserve anything when you run "devtool reset". For example, if you run "devtool add", make changes to the recipe, and then run "devtool reset", devtool takes notice that the file has @@ -426,12 +433,27 @@ <title>Upgrading a Recipe</title> <para> - Use the <filename>devtool upgrade</filename> command - to upgrade an existing recipe to a new upstream version. - The command puts the upgraded recipe file into the - workspace along with any associated files, and extracts - the source tree to a specified location should patches - need rebased or added to as a result of the upgrade. + As software matures, upstream recipes are upgraded to newer + versions. + As a developer, you need to keep your local recipes up-to-date + with the upstream version releases. + Several methods exist by which you can upgrade recipes. + You can read about them in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-upgrading-recipes'>Upgrading Recipes</ulink>" + section of the Yocto Project Development Tasks Manual. + This section overviews the <filename>devtool upgrade</filename> + command. + </para> + + <para> + The <filename>devtool upgrade</filename> command + upgrades an existing recipe to a more recent version of the + recipe upstream. + The command puts the upgraded recipe file along with any associated + files into a "workspace" and, if necessary, extracts the source + tree to a specified location. + During the upgrade, patches associated with the recipe are + rebased or added as needed. </para> <para> @@ -443,9 +465,21 @@ the version number to which you want to upgrade (i.e. the <link linkend='var-PV'><filename>PV</filename></link>), the source revision to which you want to upgrade (i.e. the - <link linkend='var-SRCREV'><filename>SRCREV</filename></link>, + <link linkend='var-SRCREV'><filename>SRCREV</filename></link>), whether or not to apply patches, and so forth. </para> + + <para> + You can read more on the <filename>devtool upgrade</filename> + workflow in the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-upgrade-to-create-a-version-of-the-recipe-that-supports-a-newer-version-of-the-software'>Use <filename>devtool upgrade</filename> to Create a Version of the Recipe that Supports a Newer Version of the Software</ulink>" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + You can also see an example of how to use + <filename>devtool upgrade</filename> in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-using-devtool-upgrade'>Using <filename>devtool upgrade</filename></ulink>" + section in the Yocto Project Development Tasks Manual. + </para> </section> <section id='devtool-resetting-a-recipe'> |