Skip to content

Commit 1f134b8

Browse files
committed
[docs] update env document
append some information about menuconfig -s
1 parent f50fbb0 commit 1f134b8

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

documentation/env/env.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Enter the `pkgs` command on the Env command line to see an introduction to the c
115115

116116
```
117117
> pkgs
118-
usage: env.py package [-h] [--update] [--list] [--wizard] [--upgrade]
118+
usage: env.py package [-h] [--update] [--list] [--wizard] [--upgrade] [--force-upgrade]
119119
[--printenv]
120120
121121
optional arguments:
@@ -125,6 +125,7 @@ optional arguments:
125125
--list list target packages
126126
--wizard create a package with wizard
127127
--upgrade update local packages list from git repo
128+
--force-upgrade update local package index file from git repo forcely (will auto-fix the conflicts when git merge).
128129
--printenv print environmental variables to check
129130
```
130131

@@ -162,6 +163,9 @@ The three options are:
162163

163164
- **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.
164165
- **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.
166+
- **Use China Mainland server**: Please **cancel it** if you are NOT living in mainland China.
167+
- **Send usage data for improve product**: For user number statistic.
168+
165169

166170
## Use Env in Your Project
167171

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

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

223-
  'git' is not recognized as an internal or external command, possible program or batch file.
227+
'git' is not recognized as an internal or external command, possible program or batch file.
224228

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

@@ -251,6 +255,6 @@ The directory where the `chcp` command is located may be added to the environmen
251255
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.
252256
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.
253257

254-
### Q: Prompt can't find file Kconfig while using menuconfig.
258+
### Q: Prompt "can't find file Kconfig" while using menuconfig.
255259

256260
**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*.
-2.17 KB
Loading

0 commit comments

Comments
 (0)