summaryrefslogtreecommitdiffstats
path: root/documentation
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
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')
-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 d70c39d546..762605a0aa 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -334,7 +334,10 @@ to use the Extensible SDK, see the ":doc:`/sdk-manual/extensible`" Chapter in th
334Project Application Development and the Extensible Software Development 334Project Application Development and the Extensible Software Development
335Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use 335Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
336Toaster, see the ":doc:`/toaster-manual/setup-and-use`" 336Toaster, see the ":doc:`/toaster-manual/setup-and-use`"
337section in the Toaster User Manual. 337section in the Toaster User Manual. If you are a VSCode user, you can configure
338the `Yocto Project BitBake
339<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
340extension accordingly.
338 341
339Setting Up to Use CROss PlatformS (CROPS) 342Setting Up to Use CROss PlatformS (CROPS)
340----------------------------------------- 343-----------------------------------------
@@ -426,7 +429,10 @@ section. If you are going to use the Extensible SDK container, see the
426Project Application Development and the Extensible Software Development 429Project Application Development and the Extensible Software Development
427Kit (eSDK) manual. If you are going to use the Toaster container, see 430Kit (eSDK) manual. If you are going to use the Toaster container, see
428the ":doc:`/toaster-manual/setup-and-use`" 431the ":doc:`/toaster-manual/setup-and-use`"
429section in the Toaster User Manual. 432section in the Toaster User Manual. If you are a VSCode user, you can configure
433the `Yocto Project BitBake
434<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
435extension accordingly.
430 436
431Setting Up to Use Windows Subsystem For Linux (WSL 2) 437Setting Up to Use Windows Subsystem For Linux (WSL 2)
432----------------------------------------------------- 438-----------------------------------------------------
@@ -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 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
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 fe79bc0129..5bc55804f6 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -214,6 +214,13 @@ contact us with other suggestions.
214 OpenEmbedded build system. If you are interested in using this type of 214 OpenEmbedded build system. If you are interested in using this type of
215 interface to create images, see the :doc:`/toaster-manual/index`. 215 interface to create images, see the :doc:`/toaster-manual/index`.
216 216
217 * **Discover the VSCode extension**: The `Yocto Project BitBake
218 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
219 extension for the Visual Studio Code IDE provides language features and
220 commands for working with the Yocto Project. If you are interested in using
221 this extension, visit its `marketplace page
222 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
223
217 * **Have Available the Yocto Project Reference Manual**: Unlike the rest of 224 * **Have Available the Yocto Project Reference Manual**: Unlike the rest of
218 the Yocto Project manual set, this manual is comprised of material suited 225 the Yocto Project manual set, this manual is comprised of material suited
219 for reference rather than procedures. You can get build details, a closer 226 for reference rather than procedures. You can get build details, a closer