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
committerSteve Sakoman <steve@sakoman.com>2024-01-24 04:04:56 -1000
commit78e79d47c2e08a15b7833bc50ceb47f4854e8efe (patch)
treed7174cdf3255fc9258c58a79121aeecb25f711e1 /documentation/overview-manual
parentf5f650aaa4a2dccc82275f291a32e91115d560fa (diff)
downloadpoky-78e79d47c2e08a15b7833bc50ceb47f4854e8efe.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: 21ec0d3b52069dfc85ff47fb4f913a26a092c480) Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
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 332cea836d..30c7af4531 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -132,6 +132,14 @@ are several ways of working in the Yocto Project environment:
132 Toaster and on how to use Toaster in general, see the 132 Toaster and on how to use Toaster in general, see the
133 :doc:`/toaster-manual/index`. 133 :doc:`/toaster-manual/index`.
134 134
135- *Using the VSCode Extension:* You can use the `Yocto Project BitBake
136 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
137 extension for Visual Studio Code to start your BitBake builds through a
138 graphical user interface.
139
140 Learn more about the VSCode Extension on the `extension's marketplace page
141 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
142
135Yocto Project Source Repositories 143Yocto Project Source Repositories
136================================= 144=================================
137 145
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 25dc08b09d..f7cd2486af 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
@@ -610,6 +622,14 @@ Build Host runs, you have several choices.
610 For information about and how to use Toaster, see the 622 For information about and how to use Toaster, see the
611 :doc:`/toaster-manual/index`. 623 :doc:`/toaster-manual/index`.
612 624
625- *Using the VSCode Extension:* You can use the `Yocto Project BitBake
626 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
627 extension for Visual Studio Code to start your BitBake builds through a
628 graphical user interface.
629
630 Learn more about the VSCode Extension on the `extension's marketplace page
631 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
632
613Reference Embedded Distribution (Poky) 633Reference Embedded Distribution (Poky)
614====================================== 634======================================
615 635