diff options
author | Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> | 2024-01-02 12:09:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-01-12 11:34:05 +0000 |
commit | ed6c38e3aff120a2caf817bb9fe4324979278edc (patch) | |
tree | b1a49ec2be47a4d6c1b2b8996ae19e243be438a9 /documentation/dev-manual | |
parent | f72759de573c97b291717cfe6043305b9797282e (diff) | |
download | poky-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/dev-manual')
-rw-r--r-- | documentation/dev-manual/building.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 15 |
2 files changed, 16 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 | |||
35 | The build process creates an entire Linux distribution from source and | 39 | The build process creates an entire Linux distribution from source and |
36 | places it in your :term:`Build Directory` under ``tmp/deploy/images``. For | 40 | places it in your :term:`Build Directory` under ``tmp/deploy/images``. For |
37 | detailed information on the build process using BitBake, see the | 41 | detailed 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 | |||
334 | Project Application Development and the Extensible Software Development | 334 | Project Application Development and the Extensible Software Development |
335 | Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use | 335 | Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use |
336 | Toaster, see the ":doc:`/toaster-manual/setup-and-use`" | 336 | Toaster, see the ":doc:`/toaster-manual/setup-and-use`" |
337 | section in the Toaster User Manual. | 337 | section in the Toaster User Manual. If you are a VSCode user, you can configure |
338 | the `Yocto Project BitBake | ||
339 | <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ | ||
340 | extension accordingly. | ||
338 | 341 | ||
339 | Setting Up to Use CROss PlatformS (CROPS) | 342 | Setting 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 | |||
426 | Project Application Development and the Extensible Software Development | 429 | Project Application Development and the Extensible Software Development |
427 | Kit (eSDK) manual. If you are going to use the Toaster container, see | 430 | Kit (eSDK) manual. If you are going to use the Toaster container, see |
428 | the ":doc:`/toaster-manual/setup-and-use`" | 431 | the ":doc:`/toaster-manual/setup-and-use`" |
429 | section in the Toaster User Manual. | 432 | section in the Toaster User Manual. If you are a VSCode user, you can configure |
433 | the `Yocto Project BitBake | ||
434 | <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ | ||
435 | extension accordingly. | ||
430 | 436 | ||
431 | Setting Up to Use Windows Subsystem For Linux (WSL 2) | 437 | Setting 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 | |||
554 | Project Application Development and the Extensible Software Development | 560 | Project Application Development and the Extensible Software Development |
555 | Kit (eSDK) manual. If you are going to use the Toaster container, see | 561 | Kit (eSDK) manual. If you are going to use the Toaster container, see |
556 | the ":doc:`/toaster-manual/setup-and-use`" | 562 | the ":doc:`/toaster-manual/setup-and-use`" |
557 | section in the Toaster User Manual. | 563 | section in the Toaster User Manual. If you are a VSCode user, you can configure |
564 | the `Yocto Project BitBake | ||
565 | <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__ | ||
566 | extension accordingly. | ||
558 | 567 | ||
559 | Locating Yocto Project Source Files | 568 | Locating Yocto Project Source Files |
560 | =================================== | 569 | =================================== |