summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorEnguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>2024-01-02 12:09:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-01-12 11:34:05 +0000
commited6c38e3aff120a2caf817bb9fe4324979278edc (patch)
treeb1a49ec2be47a4d6c1b2b8996ae19e243be438a9 /documentation/overview-manual
parentf72759de573c97b291717cfe6043305b9797282e (diff)
downloadpoky-ed6c38e3aff120a2caf817bb9fe4324979278edc.tar.gz
manuals: document VSCode extension
The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. (From yocto-docs rev: 645153504690aa8a69b028e95a5e9d2da9644cf1) Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r--documentation/overview-manual/development-environment.rst8
-rw-r--r--documentation/overview-manual/yp-intro.rst20
2 files changed, 28 insertions, 0 deletions
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
index 262d5cb203..d79173ff55 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -131,6 +131,14 @@ are several ways of working in the Yocto Project environment:
131 Toaster and on how to use Toaster in general, see the 131 Toaster and on how to use Toaster in general, see the
132 :doc:`/toaster-manual/index`. 132 :doc:`/toaster-manual/index`.
133 133
134- *Using the VSCode Extension:* You can use the `Yocto Project BitBake
135 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
136 extension for Visual Studio Code to start your BitBake builds through a
137 graphical user interface.
138
139 Learn more about the VSCode Extension on the `extension's marketplace page
140 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
141
134Yocto Project Source Repositories 142Yocto Project Source Repositories
135================================= 143=================================
136 144
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index d694642af2..1e6820c14e 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -340,6 +340,18 @@ the Yocto Project:
340 view information about builds. For information on Toaster, see the 340 view information about builds. For information on Toaster, see the
341 :doc:`/toaster-manual/index`. 341 :doc:`/toaster-manual/index`.
342 342
343- *VSCode IDE Extension:* The `Yocto Project BitBake
344 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
345 extension for Visual Studio Code provides a rich set of features for working
346 with BitBake recipes. The extension provides syntax highlighting,
347 hover tips, and completion for BitBake files as well as embedded Python and
348 Bash languages. Additional views and commands allow you to efficiently
349 browse, build and edit recipes. It also provides SDK integration for
350 cross-compiling and debugging through ``devtool``.
351
352 Learn more about the VSCode Extension on the `extension's frontpage
353 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
354
343Production Tools 355Production Tools
344---------------- 356----------------
345 357
@@ -605,6 +617,14 @@ Build Host runs, you have several choices.
605 For information about and how to use Toaster, see the 617 For information about and how to use Toaster, see the
606 :doc:`/toaster-manual/index`. 618 :doc:`/toaster-manual/index`.
607 619
620- *Using the VSCode Extension:* You can use the `Yocto Project BitBake
621 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
622 extension for Visual Studio Code to start your BitBake builds through a
623 graphical user interface.
624
625 Learn more about the VSCode Extension on the `extension's marketplace page
626 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
627
608Reference Embedded Distribution (Poky) 628Reference Embedded Distribution (Poky)
609====================================== 629======================================
610 630