Merge pull request yoctoproject#13 from savoirfairelinux/Chore-change…

…-configuration-settings Chore: Change the settings so the project scanner may work on different setups
Freed-Wu · Oct 10, 2023 · fe89eb6 · fe89eb6
2 parents 1bed1e7 + 12f0eb5
commit fe89eb6
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 375 deletions.
diff --git a/client/README.md b/client/README.md
@@ -1,9 +1,15 @@
 # BitBake recipe language support in Visual Studio Code
 
-## Set BitBake's path
-Some features require to know where your BitBake's folder is located. The extension will by default assume it is located at the root of the project in a folder named `bitbake`. If your BitBake folder is located somewhere else, set its path in the settings in order to have full features.
+## Setup the extension
+In order to work properly, the extension needs to know your Bitbake's location and build folder. It will make the following assumptions:
+- Bitbake's folder is located in `sources/poky/bitbake`, relative to the root of the project.
+- Your build folder is located at the root of the project in a folder named `build`
 
-To access BitBake's settings: Files -> Preferences -> Settings [Ctrl+,]. The BitBake's settings are under Extensions.
+Ideally, the path to an environment script to configure the BitBake project should also be specified. If it is not specified, the extension will try to configure the environment variables by itself.
+
+These can be configured into the VS Code's settings. More options are available.
+
+To access the settings, you can navigate to **Files -> Preferences -> Settings** (or use the shortcut [**Ctrl+,**]). BitBake's settings are under **Extensions**
 
 ## Features
 

diff --git a/client/package.json b/client/package.json
@@ -62,45 +62,35 @@
             "debug"
           ],
           "default": "error",
-          "description": "Adjust the logging level. error: only errors; info: only information that is useful for the user; debug: the same like info, but with additional debug informations"
+          "description": "Adjust the logging level: 'error' for reporting only errors, 'info' for displaying information useful to the user, and 'debug' for the same information as 'info,' but with additional debugging details."
         },
-        "bitbake.deepExamine": {
+        "bitbake.shouldDeepExamine": {
           "type": "boolean",
           "default": false,
-          "description": "Activates an deeply examine. If a recipe export an extra package that have not the same name like the recipe file the normal scan will not find this packages. If you like to find the packages you have to activate this option."
+          "description": "Activate deep examination. If a recipe exports an additional package with a different name than the recipe file, the normal scan will not detect these packages. To find these packages, you need to activate this option."
         },
-        "bitbake.workingFolder": {
+        "bitbake.pathToEnvScript": {  
           "type": "string",
-          "default": "vscode-bitbake-build",
-          "description": "Use this setting to specify the build folder. Use other folder than for your regular 'build' to avoid collisions."
+          "default": "oe-init-build-env",
+          "description": "Set the path to the environment script to configure the BitBake project. If the file does not exist, the extension will attempt to configure the environment variables by itself."
         },
-        "bitbake.generateWorkingFolder": {
-          "type": "boolean",
-          "default": true,
-          "description": "Use this setting to specify whether or not to generate a build folder. Can help prevent git repo headaches."
-        },
-        "bitbake.pathToBashScriptInterpreter": {
-          "type": "string",
-          "default": "/bin/bash",
-          "description": "This interpreter is used to run bash scripts"
-        },
-        "bitbake.machine": {
+        "bitbake.pathToBuildFolder": {
           "type": "string",
-          "default": "",
-          "description": "This setting is used to forward the machine name to bitbake."
+          "default": "build",
+          "description": "Set the build folder for the BitBake project."
         },
         "bitbake.pathToBitbakeFolder": {
           "type": "string",
-          "default": "./bitbake",
-          "description": "This setting is used to specify the path to the bitbake folder."
+          "default": "sources/poky/bitbake",
+          "description": "Set the path to the BitBake folder."
         }
       }
     },
     "commands": [
       {
         "command": "bitbake.rescan-project",
         "title": "BitBake: Rescan Project",
-        "description": "This command rescans the bitbake project."
+        "description": "This command rescans the BitBake project."
       }
     ]
   },