From: vincent@coelebs.dev
To: docs@lists.yoctoproject.org
Cc: Vincent Kriek <vincent@coelebs.dev>
Subject: [PATCH] ref-manual: Add "devtool extract/sync" explanation
Date: Sun, 14 Apr 2024 20:48:05 +0200 [thread overview]
Message-ID: <20240414184804.12111-2-vincent@coelebs.dev> (raw)
From: Vincent Kriek <vincent@coelebs.dev>
Documentation describing the devtool extract and devtool sync commands
were not present. This patch adds basic explanations how the commands
work and why you could use them.
Signed-off-by: Vincent Kriek <vincent@coelebs.dev>
---
.../ref-manual/devtool-reference.rst | 36 +++++++++++++++++++
1 file changed, 36 insertions(+)
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 9319addc3c..fbfd038e5c 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -618,3 +618,39 @@ a match.
When you use the ``devtool search`` command, you must supply a keyword.
The command uses the keyword when searching for a match.
+
+.. _devtool-extract-source-of-recipe:
+
+Extract source of recipe
+========================
+
+Use the ``devtool extract`` command to extract the source of a recipe to the
+directory specified. The extract command can extract the source of a recipe
+with patches applied to a directory on the system, not constrained to the
+devtool workspace.
+
+To extract the source of a recipe use the this command::
+
+ $ devtool extract recipe /path/to/extract/location
+
+In contrary to the ``devtool modify`` command this extracted copy will have no
+impact on builds and can not be integrated back in to recipes by using devtool.
+
+.. _devtool-sync-extracted-source-of-recipe:
+
+Sync extracted source of recipe
+===============================
+
+Use the ``devtool sync`` command to synchronize a previously extracted source
+tree of a recipe with the latest status of the recipe.
+
+To synchronize the extracted source tree of a recipe use this command::
+
+ $ devtool sync recipe /path/to/existing/extract/location
+
+.. note::
+
+ The synchronization of ``devtool sync`` could remove work you have in your
+ checked out tree as it will set the new head of the devtool branch to the
+ latest commit specified by the recipe. The previous devtool branch will be
+ copied to the devtool.bak branch
--
2.44.0
next reply other threads:[~2024-04-14 18:46 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-14 18:48 vincent [this message]
2024-04-15 16:08 ` [docs] [PATCH] ref-manual: Add "devtool extract/sync" explanation Michael Opdenacker
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=20240414184804.12111-2-vincent@coelebs.dev \
--to=vincent@coelebs.dev \
--cc=docs@lists.yoctoproject.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).