From 8f6b1dcd54a845787db9d4067302c42cb67badc1 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Mon, 9 Dec 2024 15:11:37 -0600 Subject: [PATCH 1/5] fix: remove include definitions that snuck in Remove the replacevars include definitions that snuck in around the time we reworked the build to eliminate the need for the replacevars file. Signed-off-by: Randolph Sapp --- source/debian/How_to_Guides/index_How_to_Guides.rst | 2 -- .../AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst | 2 -- source/linux/Documentation_Tarball.rst | 2 -- source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst | 2 -- 4 files changed, 8 deletions(-) diff --git a/source/debian/How_to_Guides/index_How_to_Guides.rst b/source/debian/How_to_Guides/index_How_to_Guides.rst index 4fb57be51..ac85a7ae1 100644 --- a/source/debian/How_to_Guides/index_How_to_Guides.rst +++ b/source/debian/How_to_Guides/index_How_to_Guides.rst @@ -1,5 +1,3 @@ -.. include:: /_replacevars.rst - ############# How to Guides ############# diff --git a/source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst b/source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst index 4a9001bea..ac44c1f9a 100644 --- a/source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst +++ b/source/devices/AM62AX/linux/Release_Specific_Yocto_layer_Configuration.rst @@ -1,5 +1,3 @@ -.. include:: /_replacevars.rst - .. _yocto-layer-configuration: ************************** diff --git a/source/linux/Documentation_Tarball.rst b/source/linux/Documentation_Tarball.rst index a38be23c6..e32857baf 100644 --- a/source/linux/Documentation_Tarball.rst +++ b/source/linux/Documentation_Tarball.rst @@ -1,5 +1,3 @@ -.. include:: /_replacevars.rst - Documentation Tarball ===================== .. ifconfig:: CONFIG_part_variant in ('AM62AX','J721E','J7200','J721S2','J784S4','AM68','AM69','J722S','AM67','J742S2','AM68A','AM67A','AM69A','TDA4VM') diff --git a/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst b/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst index feddb855a..df60dbd87 100644 --- a/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst +++ b/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst @@ -1,5 +1,3 @@ -.. include:: /_replacevars.rst - .. _Edge-AI-Gallery-User-Guide-label: Edge AI Gallery - User Guide From 83358ff06d9bf4a66e39fe5ca6dc85eb4047f7e8 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Mon, 9 Dec 2024 15:16:38 -0600 Subject: [PATCH 2/5] docs(replacevars): update documentation Update documentation around replacement variables. Signed-off-by: Randolph Sapp --- CONTRIBUTING.md | 3 +-- scripts/replacevars.py | 9 ++++----- 2 files changed, 5 insertions(+), 7 deletions(-) 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"] From dba2e6c2e0835ef20e8511405b6eab004ff5ddf4 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Thu, 12 Dec 2024 15:37:39 -0600 Subject: [PATCH 3/5] fix(edgeai): enumerated list ends without a blank line Fix the following warning: Enumerated list ends without a blank line; unexpected unindent. Signed-off-by: Randolph Sapp --- source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst b/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst index df60dbd87..38e5dad8f 100644 --- a/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst +++ b/source/system/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst @@ -109,11 +109,13 @@ The edge AI gallery launches on Linux startup. Follow the below instructions to 10. To change the videos in the prebuilt pipelines used for ``Image Classification``, ``Object Detection``, ``Semantic Segmentation`` & ``Multi Channel``, you can replace the video files :file:`oob-gui-video*.h264` under :file:`/opt/oob-demo-assets/`. 11. To relaunch the application, you should run + :: /etc/init.d/edgeai-launcher.sh start 12. And to stop the application again, you should run + :: /etc/init.d/edgeai-launcher.sh stop From 52195e4f74bf78e81420a1a758f407db2d8f6a57 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Fri, 13 Dec 2024 17:42:39 -0600 Subject: [PATCH 4/5] chore(makefile): remove replacevars ref Was keeping this clean step around to try and passively remove this file from users that may not be keeping track of upstream changes. Now we should be good to delete it. Signed-off-by: Randolph Sapp --- Makefile | 1 - 1 file changed, 1 deletion(-) diff --git a/Makefile b/Makefile index 179acfaf3..5e1f33794 100644 --- a/Makefile +++ b/Makefile @@ -56,7 +56,6 @@ help: clean: rm -rf "$(BUILDDIR)" - rm -f source/_replacevars.rst lint: rstcheck -r "$(SOURCEDIR)" From 7b0df0e51465e7aca85830da4cdd47a8a451f9cb Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Fri, 13 Dec 2024 17:44:30 -0600 Subject: [PATCH 5/5] chore(gitignore): prune gitignore paths Prune these paths now that we have tweaked the build system. Signed-off-by: Randolph Sapp --- .gitignore | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitignore b/.gitignore index 6f622d5b0..187fd529d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,3 @@ -conf.py -!python-scripts/conf.py *.swp *.pyc build/ -source/_replacevars.rst