Skip to content

Commit 36b2991

Browse files
unicornxRbb666
authored andcommitted
doxygen: update doc for env to latest
The introduction to Env under the documentation section of the RTT source code repository is outdated and unmaintained. We recommend moving the Env documentation to https://github.com/RT-Thread/env/ for self-maintenance. Solution: Direct users to the latest README at https://github.com/RT-Thread/env/. The Env content under the documentation section of RTT will not be deleted for now, but will be marked as "outdated". Signed-off-by: Chen Wang <[email protected]>
1 parent 4832f04 commit 36b2991

File tree

1 file changed

+36
-35
lines changed

1 file changed

+36
-35
lines changed

documentation/env/env.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
@page page_env User Manual of Env
1+
@page page_env Env
22

33
Env is a handy utility tool developed by RT-Thread team to build environment, graphical system configuration, and packages management for software projects that intend to run on RT-Thread operating system. Env tool come with source code builder, compilation environment and package management system.
44

55
It is a wrapper tool for build-in menuconfig, which is an open source GUI tool which is designed to tailor for ease of use for developers. It can also be used to configure the kernel configuration parameters, components and software packages so that developers can construct the system like lego blocks.
66

7-
Env for Windows repository: https://github.com/RT-Thread/env-windows
8-
97
# Main Features
108

119
- menuconfig provides graphical interface to interact with operational logic and configuration parameters
@@ -16,24 +14,27 @@ Env for Windows repository: https://github.com/RT-Thread/env-windows
1614
- Modular software packages and decoupling design make it easier to maintain.
1715
- It also featured with point and click to download additional software packages and dependencies directly from Internet.
1816

19-
# Download
17+
# User Guide
18+
19+
Lastest user guide see <https://github.com/RT-Thread/env/blob/master/README.md>.
20+
21+
# Archive Information
2022

21-
- [Download the Env tool](https://github.com/RT-Thread/env-windows/releases), e.g. `env-windows-v1.3.5.7z`.
22-
- Extract the .7z file and the path shouldn't contain any non-ascii or space characters.
23+
<span style='color:red'>**NOTE: The following information may be outdated, please read carefully.**</span>
2324

24-
# User Guide of Env
25+
## User Guide of Env
2526

26-
## Open the control Console
27+
### Open the control Console
2728

2829
The rt-thread software package environment is mainly based on the command line console so that the rt-thread development environment can be set up by minimizing the modification of configuration files.
2930

3031
There are two ways to open the console:
3132

32-
### 1. click the Env directory executable file
33+
#### 1. click the Env directory executable file
3334

3435
To enter the Env directory, you can run `env.exe` in this directory. If it fails to open, you can try to use `env.bat`.
3536

36-
### 2. open the Env console from the right-click menu in the folder
37+
#### 2. open the Env console from the right-click menu in the folder
3738

3839
Add Env to the right-click menu:
3940

@@ -49,19 +50,19 @@ Follow the steps from the image to launch the Env console from the right-click m
4950

5051
> Due to the need for the environment variables of the Env process to be set, the anti-virus software may misreport at the first startup. If the anti-virus software misreport is encountered, allow Env related programs to run, and then add related programs to the white list.
5152
52-
## Compile
53+
### Compile
5354

5455
Scons is a compile building tool used by RT-Thread to compile RT-Threads using the scons related commands.
5556

56-
### Step One: Switch to the BSP root directory
57+
#### Step One: Switch to the BSP root directory
5758

5859
If you use Method 1 to open Env console, you need to switch to the target BSP using the `cd` command.
5960

6061
For example, the target BSP is `rt-thread\bsp\stm32\stm32f103-dofly-lyc8`:
6162

6263
![stm32f429-apollo project directory](figures/cd_cmd.png)
6364

64-
### Step Two: Compile the BSP
65+
#### Step Two: Compile the BSP
6566

6667
Env for Windows carries Python2.7 & Scons . To compile BSP, just use the default ARM_GCC toolchain by running `scons` or `scons -j12` (12 CPU cores compiling) command in the target BSP directory.
6768

@@ -84,28 +85,28 @@ scons --target=mdk5
8485

8586
For more scons tutorials, please refer to @ref page_scons.
8687

87-
## BSP configuration: menuconfig
88+
### BSP configuration: menuconfig
8889

8990
Menuconfig is a graphical configuration tool that RT-Thread uses to configure and tailor the entire system.
9091

91-
### Instruction for Shortcuts
92+
#### Instruction for Shortcuts
9293

9394
Go to the BSP root directory and open the interface by entering `menuconfig`. The menuconfig common shortcuts are as shown:
9495

9596
![Commonly-used Shortcuts for menuconfig](figures/hotkey.png)
9697

97-
### Modify Settings
98+
#### Modify Settings
9899

99100
There are many types of configuration items in menuconfig, and the modification methods are different. The common types are:
100101

101102
- On/Off Type: Use the space bar to select or close
102103
- Value, string type: After pressing the Enter key, a dialog box will appear, and the configuration items will be modified in the dialog box.
103104

104-
### Save Settings
105+
#### Save Settings
105106

106107
After selecting the configuration item, press `ESC` to exit, and select `Save` to automatically generate the `rtconfig.h` file. At this point, using the `scons` command again will recompile the project according to the new rtconfig.h file.
107108

108-
## Package Management
109+
### Package Management
109110

110111
RT-Thread provides a package management platform where the officially available or developer-supplied packages are stored. The platform provides developers with a choice of reusable software packages that are an important part of RT-Thread.
111112

@@ -141,7 +142,7 @@ optional arguments:
141142
--printenv print environmental variables to check
142143
```
143144

144-
### Download, update, and delete packages
145+
#### Download, update, and delete packages
145146

146147
Before downloading and updating the software package, you need to **open** the target package in `menuconfig`.
147148

@@ -155,13 +156,13 @@ Find the package you need and open, then save and exit menuconfig. The package w
155156
- **update**: if the selected package has a latest update on the server and the version is selected **latest**, then enter `pkgs --update` , the package will be updated in local;
156157
- **delete**: if a software package is not needed, deselect it in menuconfig and then use `pkgs --update` command. Then locally downloaded but unselected packages will be deleted.
157158

158-
### Update local package information and index
159+
#### Update local package information and index
159160

160161
As the package system grows, more and more packages will be added, so the list of packages in menuconfig may be **unsynchronized** with the server. This can be fixed by using `pkgs --upgrade` or `pkgs --upgrade-force` command (recommended), which not only synchronizes updates to local software packages [information and index](https://github.com/RT-Thread/packages), which are recommended for regular use. If there is a upgrade failure or merge failure, please use `pkgs --upgrade-force` command to force upgrade the local software packages index (recommended to use).
161162

162163
If wants to upgrade the [Env script](https://github.com/RT-Thread/env) as well, please use `pkgs --upgrade-script-force` command. This command not only can upgrade the software packages index, but also can upgrade the Env script.
163164

164-
## Env Tool Configuration
165+
### Env Tool Configuration
165166

166167
- The new version of the Env tool includes an automatic update package and an option to automatically generate mdk/iar projects. The default is not enabled. It can be configured using `menuconfig -s/--setting` .
167168

@@ -180,21 +181,21 @@ The three options are:
180181
- **Send usage data for improve product**: For user number statistic.
181182

182183

183-
# Use Env in Your Project
184+
## Use Env in Your Project
184185

185-
## How to Modify Options in Menuconfig
186+
### How to Modify Options in Menuconfig
186187

187188
If you want to add a macro definition in the configuration item of menuconfig, you can modify the `Kconfig` file under BSP. The modification method can search Kconfig syntax on the Internet for detailed documentation, or refer to the Kconfig file in RT-Thread or The Kconfig file in the BSP that supports menuconfig.
188189

189-
## To Add menuconfig function to New Project
190+
### To Add menuconfig function to New Project
190191

191192
New project here refers to a newly developed project that has not yet generated `.config` and `rtconfig.h`. Because these two files are only created when menuconfig is first saved. The specific process is as follows:
192193

193194
1. Copy the kconfig file from the BSP that already supports the menuconfig function to the new project root directory.
194195
2. Note that modifying the RTT_ROOT value in Kconfig is the directory where RT-Thread is located, otherwise RTT_ROOT may be not found.
195196
3. Start the configuration with the menuconfig command.
196197

197-
## To Add menuconfig function to old Project
198+
### To Add menuconfig function to old Project
198199

199200
Old project here refers to the development that has been going on for a while, and there is a modified `rtconfig.h` file in the project, but there is no project configured with menuconfig. The specific process is as follows:
200201

@@ -205,53 +206,53 @@ Old project here refers to the development that has been going on for a while, a
205206
5. Use the menuconfig command to configure the old project we want to modify. Menuconfig will read the `.config` file generated in the second step and generate a new `.config` file and rtconfig.h file based on the configuration parameters of the old project.
206207
6. Check the old and new rtconfig.h files. If there are any inconsistencies, you can use the menuconfig command to adjust the configuration items.
207208

208-
# Notes for Using Env
209+
## Notes for Using Env
209210

210211
- For the first time, Env is recommended to go to the official website to download the latest version of the Env tool. The new version of Env will have better compatibility and also support automatic update commands.
211212
- You can use the Env built-in command `pkgs --upgrade` or `pkgs --upgrade-force` (recommended to use) to update the package list and Env's function code to minimize the problems you have fixed.
212213
- Do not have Chinese or spaces in the routes of Env.
213214
- Do not have Chinese or spaces in the routes where the BSP project is located.
214215

215-
# FAQs
216+
## FAQs
216217

217-
## Q: It prompts that the git command cannot be found.
218+
### Q: It prompts that the git command cannot be found.
218219

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

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

223-
## Q: It prompts that the CMD command cannot be found.
224+
### Q: It prompts that the CMD command cannot be found.
224225

225226
**A:** Right-click–>> Property—>> Advanced System Settings—>> Environment Variable, Add `C:\Windows\System32` to system environment variables.
226227

227-
## Q: Prompt "no module named site" when running python.
228+
### Q: Prompt "no module named site" when running python.
228229

229230
**A:** Computer right button –>> Properties—>> Advanced System Settings—>> Environment Variable, in the user variable of the administrator, create a new variable named PYTHONHOME, and the variable value is: `F:\git_repositories\env\tools\Python27` (the installation route of Python in Env), do not add ";" afterwards, otherwise it will be invalid. If add PYTHONHOME can not solve theproblem, try to add PYTHONPATH in the same way.
230231

231-
## Q: What types of projects can I generate under Env?
232+
### Q: What types of projects can I generate under Env?
232233

233234
**A:**
234235

235236
1. Currently, you can use the scons tool to generate mdk/iar projects under Env. There is no automatic generation of eclipse projects.
236237
2. Generally, using gcc's toolchain, using an editor such as source insight or VS Code to edit the code and compile with `scons` command.
237238

238-
## Q: How can my own BSP support menuconfig?
239+
### Q: How can my own BSP support menuconfig?
239240

240241
**A:** You can refer to this chapter **Use Env in Your Project**.
241242

242-
## Q: What is the difference between the pkgs --upgrade/--upgrade-force command and the pkgs --update command?
243+
### Q: What is the difference between the pkgs --upgrade/--upgrade-force command and the pkgs --update command?
243244

244245
**A:**
245246

246247
1. The `pkgs --upgrade/--upgrade-force` command is used to upgrade the Env script itself and the list of packages. You cannot select a recently updated package without the latest package list.
247248
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.
248249
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.
249250

250-
## Q: Prompt "can't find file Kconfig" while using menuconfig.
251+
### Q: Prompt "can't find file Kconfig" while using menuconfig.
251252

252253
**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*.
253254

254-
## Q: There's unintelligible texts appear in Env.
255+
### Q: There's unintelligible texts appear in Env.
255256

256257
**A:** First check if there is a Chinese route.
257258

0 commit comments

Comments
 (0)