Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] update env document #6247

Merged
merged 1 commit into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions documentation/env/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Enter the `pkgs` command on the Env command line to see an introduction to the c

```
> pkgs
usage: env.py package [-h] [--update] [--list] [--wizard] [--upgrade]
usage: env.py package [-h] [--update] [--list] [--wizard] [--upgrade] [--force-upgrade]
[--printenv]

optional arguments:
Expand All @@ -125,6 +125,7 @@ optional arguments:
--list list target packages
--wizard create a package with wizard
--upgrade update local packages list from git repo
--force-upgrade update local package index file from git repo forcely (will auto-fix the conflicts when git merge).
--printenv print environmental variables to check
```

Expand Down Expand Up @@ -162,6 +163,9 @@ The three options are:

- **Auto update pkgs config**:Automatic package update function: After exiting the menuconfig function, `pkgs --update` command is automatically used to download and install the package and delete the old package. This feature is used when downloading online packages.
- **Auto create a MDK/IAR project**: After modifying the menuconfig configuration, you must re-generate the project by typing `scons --target=xxx` . Turning on this feature will automatically regenerate the project when you exit menuconfig, without having to manually enter the scons command to regenerate the project.
- **Use China Mainland server**: Please **cancel it** if you are NOT living in mainland China.
- **Send usage data for improve product**: For user number statistic.


## Use Env in Your Project

Expand Down Expand Up @@ -220,7 +224,7 @@ The directory where the `chcp` command is located may be added to the environmen

### Q: It prompts that the git command cannot be found.

  'git' is not recognized as an internal or external command, possible program or batch file.
'git' is not recognized as an internal or external command, possible program or batch file.

**A:** Git is not installed. You need to install git and add environment variables.

Expand Down Expand Up @@ -251,6 +255,6 @@ The directory where the `chcp` command is located may be added to the environmen
2. The `pkgs --update` command is used to update the package itself. For example, if you selected json and mqtt packages in menuconfig, you did not download them when you exit menuconfig. You need to use the `pkgs --update` command, at which point Env will download the package you selected and add it to your project.
3. The new version of Env supports the `menuconfig -s/--setting` command. If you don't want to use the `pkgs --update` command after replacing the package, configure Env after using the `menuconfig -s/--setting` command. Select each time you use menuconfig. After the package is automatically updated.

### Q: Prompt can't find file Kconfig while using menuconfig.
### Q: Prompt "can't find file Kconfig" while using menuconfig.

**A:** The Kconfig file is missing from the current working BSP directory. Please refer *To Add menuconfig function to New Project* and *To Add menuconfig function to Old Project*.
Binary file modified documentation/env/figures/menuconfig_s_auto_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.