Skip to content

Commit 9683c31

Browse files
committed
docs(replacevars): update documentation
Update documentation around replacement variables. Signed-off-by: Randolph Sapp <[email protected]>
1 parent bb08d58 commit 9683c31

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ newline that separates the directive from the content block:
9292
There are a number of predefined variables available that are dynamically set
9393
based on the platform config. These variables should be used wherever possible.
9494
These variables can be found in the "Replacement Variables" section of the
95-
platform configs, or in the temporary file placed at `source/_replacevars.rst`
96-
during the build process.
95+
platform configs, or reported during the build in the `rst_prolog` section.
9796

9897
### Ifconfigs
9998

scripts/replacevars.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# write_replacevars
1+
# unpack_replacevars
22
# -----------------
3-
# Description: Writes replacement variable array to source/${OS}/replacevars.rst.inc
3+
# Description: Creates a valid RST replacement variable list from the given variable dictionary
44
#
5-
# Parameters: app - Application calling this Python function
6-
# replacevars - Input hash table of replacevars that will be converted into
7-
# "replace" directives in the replacevars.rst.inc file
5+
# Parameters: replacevars - Input hash table of replacevars that will be converted into
6+
# "replace" directives
87

98
def unpack_replacevars(replacevars):
109
replacevarstext = ["\n"]

0 commit comments

Comments
 (0)