Skip to content

Commit

Permalink
docs(replacevars): update documentation
Browse files Browse the repository at this point in the history
Update documentation around replacement variables.

Signed-off-by: Randolph Sapp <[email protected]>
  • Loading branch information
StaticRocket committed Dec 12, 2024
1 parent 85fcdbe commit 390b22b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ newline that separates the directive from the content block:
There are a number of predefined variables available that are dynamically set
based on the platform config. These variables should be used wherever possible.
These variables can be found in the "Replacement Variables" section of the
platform configs, or in the temporary file placed at `source/_replacevars.rst`
during the build process.
platform configs, or reported during the build in the `rst_prolog` section.

### Ifconfigs

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

def unpack_replacevars(replacevars):
replacevarstext = ["\n"]
Expand Down

0 comments on commit 390b22b

Please sign in to comment.