Skip to content

Commit

Permalink
Doc: Document devtool fallback mode
Browse files Browse the repository at this point in the history
  • Loading branch information
deribaucourt committed Jan 3, 2024
1 parent c965b36 commit 24d8618
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,14 @@ Clicking on the workspace name will open the sources' workspace in a new window.
- Commit them in the local git repository
- Run the `Bitbake: Devtool: Update recipe` command to generate the patch and update the recipe

You can also set up the SDK for the recipe by running the `Bitbake: Devtool: Configure SDK` command. This will create `.vscode/settings.json`, `.vscode/tasks.json` and `.vscode/launch.json` configurations to cross-compile, deploy and debug the recipe on a target machine through SSH. You'll need to configure this extension's settings to match your target machine's configuration:
You can also set up the SDK for the recipe by running the `Bitbake: Devtool: Configure native SDK` command. This will create `.vscode/settings.json`, `.vscode/tasks.json` and `.vscode/launch.json` configurations to cross-compile, deploy and debug the recipe on a target machine through SSH. You'll need to configure this extension's settings to match your target machine's configuration:
- `bitbake.sdkImage`
- `bitbake.sshTarget`

**Note:** This feature depends on poky versions 5.0 and above (`devtool ide-sdk` command). Some recipe classes may not be supported yet. At the time of writing, CMake and Meson recipes are supported.

If your recipe's class is not supported, or you have an older version of poky, the `Bitbake: Devtool: Configure devtool fallback` command will add tasks to build and deploy the package through `devtool build/deploy-target`. Linting, debugging, testing and other advanced features will not be available in this mode.

## Contributing

### Reporting issues
Expand Down
2 changes: 1 addition & 1 deletion client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"bitbake.eSDKMode": {
"type": "boolean",
"default": false,
"description": "Activate eSDK only mode. This tells the extension that devtool is available but not bitbake, which will disable unavailable features."
"markdownDescription": "Activate eSDK only mode. This tells the extension that devtool is available but not bitbake, which will disable unavailable features. You should point the `bitbake.pathToEnvScript` setting to the environment script of the eSDK."
},
"bitbake.pathToEnvScript": {
"type": "string",
Expand Down

0 comments on commit 24d8618

Please sign in to comment.