summaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--documentation/dev-manual/building.rst4
-rw-r--r--documentation/dev-manual/start.rst15
-rw-r--r--documentation/overview-manual/development-environment.rst8
-rw-r--r--documentation/overview-manual/yp-intro.rst20
-rw-r--r--documentation/ref-manual/resources.rst5
-rw-r--r--documentation/what-i-wish-id-known.rst7
6 files changed, 56 insertions, 3 deletions
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index a395793493..e964bd1aee 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -32,6 +32,10 @@ build host running Linux.
32 OpenEmbedded build system, see the 32 OpenEmbedded build system, see the
33 :doc:`/brief-yoctoprojectqs/index` document. 33 :doc:`/brief-yoctoprojectqs/index` document.
34 34
35 - You can also use the `Yocto Project BitBake
36 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
37 extension for Visual Studio Code to build images.
38
35The build process creates an entire Linux distribution from source and 39The build process creates an entire Linux distribution from source and
36places it in your :term:`Build Directory` under ``tmp/deploy/images``. For 40places it in your :term:`Build Directory` under ``tmp/deploy/images``. For
37detailed information on the build process using BitBake, see the 41detailed information on the build process using BitBake, see the
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 5a81506a9b..44503a5183 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -332,7 +332,10 @@ to use the Extensible SDK, see the ":doc:`/sdk-manual/extensible`" Chapter in th
332Project Application Development and the Extensible Software Development 332Project Application Development and the Extensible Software Development
333Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use 333Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
334Toaster, see the ":doc:`/toaster-manual/setup-and-use`" 334Toaster, see the ":doc:`/toaster-manual/setup-and-use`"
335section in the Toaster User Manual. 335section in the Toaster User Manual. If you are a VSCode user, you can configure
336the `Yocto Project BitBake
337<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
338extension accordingly.
336 339
337Setting Up to Use CROss PlatformS (CROPS) 340Setting Up to Use CROss PlatformS (CROPS)
338----------------------------------------- 341-----------------------------------------
@@ -424,7 +427,10 @@ section. If you are going to use the Extensible SDK container, see the
424Project Application Development and the Extensible Software Development 427Project Application Development and the Extensible Software Development
425Kit (eSDK) manual. If you are going to use the Toaster container, see 428Kit (eSDK) manual. If you are going to use the Toaster container, see
426the ":doc:`/toaster-manual/setup-and-use`" 429the ":doc:`/toaster-manual/setup-and-use`"
427section in the Toaster User Manual. 430section in the Toaster User Manual. If you are a VSCode user, you can configure
431the `Yocto Project BitBake
432<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
433extension accordingly.
428 434
429Setting Up to Use Windows Subsystem For Linux (WSLv2) 435Setting Up to Use Windows Subsystem For Linux (WSLv2)
430----------------------------------------------------- 436-----------------------------------------------------
@@ -554,7 +560,10 @@ Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the
554Project Application Development and the Extensible Software Development 560Project Application Development and the Extensible Software Development
555Kit (eSDK) manual. If you are going to use the Toaster container, see 561Kit (eSDK) manual. If you are going to use the Toaster container, see
556the ":doc:`/toaster-manual/setup-and-use`" 562the ":doc:`/toaster-manual/setup-and-use`"
557section in the Toaster User Manual. 563section in the Toaster User Manual. If you are a VSCode user, you can configure
564the `Yocto Project BitBake
565<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
566extension accordingly.
558 567
559Locating Yocto Project Source Files 568Locating Yocto Project Source Files
560=================================== 569===================================
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
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 8c3726e83b..8e54ac87c9 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -169,6 +169,11 @@ Here is a list of resources you might find helpful:
169 the :term:`OpenEmbedded Build System`, which uses 169 the :term:`OpenEmbedded Build System`, which uses
170 BitBake, that reports build information. 170 BitBake, that reports build information.
171 171
172- `Yocto Project BitBake extension for VSCode
173 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__:
174 This extension provides a rich feature set when working with BitBake recipes
175 within the Visual Studio Code IDE.
176
172- :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked 177- :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked
173 questions and their answers. 178 questions and their answers.
174 179
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index 4843f02276..c21810d49b 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -213,6 +213,13 @@ contact us with other suggestions.
213 OpenEmbedded build system. If you are interested in using this type of 213 OpenEmbedded build system. If you are interested in using this type of
214 interface to create images, see the :doc:`/toaster-manual/index`. 214 interface to create images, see the :doc:`/toaster-manual/index`.
215 215
216 * **Discover the VSCode extension**: The `Yocto Project BitBake
217 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
218 extension for the Visual Studio Code IDE provides language features and
219 commands for working with the Yocto Project. If you are interested in using
220 this extension, visit its `marketplace page
221 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
222
216 * **Have Available the Yocto Project Reference Manual**: Unlike the rest of 223 * **Have Available the Yocto Project Reference Manual**: Unlike the rest of
217 the Yocto Project manual set, this manual is comprised of material suited 224 the Yocto Project manual set, this manual is comprised of material suited
218 for reference rather than procedures. You can get build details, a closer 225 for reference rather than procedures. You can get build details, a closer