Skip to content

Commit e665e01

Browse files
gcomnenoderibaucourt
authored andcommitted
docs: make BitBake settings walkthrough interactive
1 parent ec57dc7 commit e665e01

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

package.json

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -247,16 +247,12 @@
247247
{
248248
"id": "bitbake.getStarted.settings",
249249
"title": "Configure BitBake settings",
250-
"description": "Open VS Code Settings and search for `BitBake`. Configure the basic workspace settings needed to start BitBake, such as `bitbake.pathToBuildFolder`, `bitbake.pathToEnvScript`, and `bitbake.pathToBitbakeFolder`.",
250+
"description": "Configure the basic workspace settings needed to start BitBake.\n[Open BitBake settings](command:workbench.action.openWorkspaceSettings?%5B%22%40ext%3Ayocto-project.yocto-bitbake%22%5D)",
251251
"media": {
252-
"image": "images/config-picker.png",
253-
"altText": "BitBake configuration picker"
252+
"markdown": "walkthroughs/bitbake-settings.md"
254253
},
255254
"completionEvents": [
256-
"onCommand:bitbake.pick-configuration",
257-
"onSettingChanged:bitbake.pathToBuildFolder",
258-
"onSettingChanged:bitbake.pathToEnvScript",
259-
"onSettingChanged:bitbake.pathToBitbakeFolder"
255+
"onContext:!bitbake.settingsError"
260256
]
261257
},
262258
{

walkthroughs/bitbake-settings.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Configure BitBake settings
2+
3+
Configure the basic workspace settings required to start BitBake from the extension.
4+
5+
The most common manual setup path uses:
6+
7+
- `bitbake.pathToBitbakeFolder`
8+
- `bitbake.pathToEnvScript`
9+
- `bitbake.pathToBuildFolder`
10+
11+
The settings editor contains the detailed descriptions for each setting. After the settings are changed, the extension automatically checks whether BitBake can be started and updates the Recipes Explorer and status bar.

0 commit comments

Comments
 (0)