diff options
-rw-r--r-- | documentation/dev-manual/building.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 15 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 8 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 20 | ||||
-rw-r--r-- | documentation/ref-manual/resources.rst | 5 | ||||
-rw-r--r-- | documentation/what-i-wish-id-known.rst | 7 |
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 | |||
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 | =================================== |
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 | |||
134 | Yocto Project Source Repositories | 142 | Yocto 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 | |||
343 | Production Tools | 355 | Production 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 | |||
608 | Reference Embedded Distribution (Poky) | 628 | Reference 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 |