diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d039bcdd..b964df57b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/scripts/replacevars.py b/scripts/replacevars.py index aeeba99f4..c85da2aaf 100644 --- a/scripts/replacevars.py +++ b/scripts/replacevars.py @@ -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"]