From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Quentin Schulz <quentin.schulz@cherry.de>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH v2 1/2] ref-manual: devtool-reference: refresh example outputs
Date: Tue, 22 Oct 2024 10:37:56 +0200 [thread overview]
Message-ID: <20241022-devtool-improvements-v2-1-9d2ebf9c5311@bootlin.com> (raw)
In-Reply-To: <20241022-devtool-improvements-v2-0-9d2ebf9c5311@bootlin.com>
Previous outputs were missing some commands and options, some others
were obsolete.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/devtool-reference.rst | 18 +++++++-----------
1 file changed, 7 insertions(+), 11 deletions(-)
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 9319addc3c611ee183ad069bf7e41d14811b33ce..9c36195c5a5a2405cf8e3a562a2a53291e97c859 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -24,7 +24,7 @@ The ``devtool`` command line is organized similarly to Git in that it
has a number of sub-commands for each function. You can run
``devtool --help`` to see all the commands::
- $ devtool -h
+ $ devtool --help
NOTE: Starting bitbake server...
usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] <subcommand> ...
@@ -50,6 +50,7 @@ has a number of sub-commands for each function. You can run
search Search available recipes
Working on a recipe in the workspace:
build Build a recipe
+ ide-sdk Setup the SDK and configure the IDE
rename Rename a recipe file in the workspace
edit-recipe Edit a recipe file
find-recipe Find a recipe file
@@ -63,17 +64,11 @@ has a number of sub-commands for each function. You can run
build-image Build image including workspace recipe packages
Advanced:
create-workspace Set up workspace in an alternative location
+ import Import exported tar archive into workspace
+ export Export workspace into a tar archive
extract Extract the source for an existing recipe
sync Synchronize the source tree for an existing recipe
menuconfig Alter build-time configuration for a recipe
- import Import exported tar archive into workspace
- export Export workspace into a tar archive
- other:
- selftest-reverse Reverse value (for selftest)
- pluginfile Print the filename of this plugin
- bbdir Print the BBPATH directory of this plugin
- count How many times have this plugin been registered.
- multiloaded How many times have this plugin been initialized
Use devtool <subcommand> --help to get help on a specific command
As directed in the general help output, you can
@@ -82,8 +77,8 @@ using ``--help``::
$ devtool add --help
NOTE: Starting bitbake server...
- usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--version VERSION] [--no-git] [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] [--binary] [--also-native] [--src-subdir SUBDIR] [--mirrors]
- [--provides PROVIDES]
+ usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--no-pypi] [--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 optionally fetch a remote URI and unpack it to create the source tree.
@@ -99,6 +94,7 @@ using ``--help``::
--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)
--npm-dev For npm, also fetch devDependencies
+ --no-pypi Do not inherit pypi class
--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
--
2.46.1
next prev parent reply other threads:[~2024-10-22 8:38 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-22 8:37 [PATCH v2 0/2] Update the devtool quick reference document Antonin Godard
2024-10-22 8:37 ` Antonin Godard [this message]
2024-10-22 8:37 ` [PATCH v2 2/2] ref-manual: devtool-reference: document missing commands Antonin Godard
2024-10-28 14:26 ` Quentin Schulz
2024-10-28 13:54 ` [PATCH v2 0/2] Update the devtool quick reference document Antonin Godard
2024-10-28 14:27 ` Quentin Schulz
2024-10-30 10:13 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241022-devtool-improvements-v2-1-9d2ebf9c5311@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@cherry.de \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox