Summary

Add documentation on available RBTools environment variables.

Review Request #10965 — Created March 24, 2020 and submitted March 25, 2020, 6:41 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-1.0.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

RBTools 1.0.3 is introducing the RBTOOLS_EDITOR environment variable,
for customizing the editing experience. This is one of a few environment
variables we offer, none of which are documented anywhere.

This change introduces a section to the User Configuration page to list
available environment variables. Any :envvar: references to these will
link to the correct place.

Testing Done

Built the docs. Checked for build and spelling errors.

Checked that each of the listed environment variables rendered correctly
and could be linked to.

Commits

Summary	ID
Add documentation on available RBTools environment variables. RBTools 1.0.3 is introducing the `RBTOOLS_EDITOR` environment variable, for customizing the editing experience. This is one of a few environment variables we offer, none of which are documented anywhere. This change introduces a section to the User Configuration page to list available environment variables. Any `:envvar:` references to these will link to the correct place.	5e1d1d07e367f415dea39d9cd21459a1f76e6112

Summary

Add documentation on available RBTools environment variables.

RBTools 1.0.3 is introducing the `RBTOOLS_EDITOR` environment variable, for customizing the editing experience. This is one of a few environment variables we offer, none of which are documented anywhere. This change introduces a section to the User Configuration page to list available environment variables. Any `:envvar:` references to these will link to the correct place.

5e1d1d07e367f415dea39d9cd21459a1f76e6112

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-1.0.x (48b3437)