Skip to content

Commit d1f7055

Browse files
committed
Fix various leftovers
1 parent 5d63732 commit d1f7055

3 files changed

Lines changed: 16 additions & 8 deletions

File tree

Documentation/Doxygen/gen_doc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
# Version: 3.0
33
# Date: 2023-11-06
4-
# This bash script generates CMSIS-freertos documentation
4+
# This bash script generates CMSIS-FreeRTOS documentation
55
#
66
# Pre-requisites:
77
# - bash shell (for Windows: install git for Windows)

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Use *main* branch for pull-requests.
1414
| CMSIS/RTOS2/FreeRTOS/Config | CMSIS-FreeRTOS configuration file |
1515
| CMSIS/RTOS2/FreeRTOS/Examples | CMSIS-FreeRTOS example projects |
1616
| CMSIS/RTOS2/FreeRTOS/Source | CMSIS-FreeRTOS source code |
17-
| Documentation | Generated documentation placeholder |
18-
| DoxyGen | Source of the documentation |
17+
| Documentation | Source of the documentation |
1918
| Source | FreeRTOS Kernel source code |
2019

2120
## Generate CMSIS Pack for Release
@@ -25,7 +24,7 @@ This GitHub development repository contains all the sources you need to successf
2524
To build the complete pack for installation use the **gen_pack.sh** bash script. This script file also
2625
generates the documentation.
2726

28-
Documentation may be generated separately using the bash script **gen_doc.sh** (located in ./DoxyGen).
27+
Documentation may be generated separately using the bash script **gen_doc.sh** (located in ./Documentation/Doxygen).
2928

3029
## License
3130

gen_pack.sh

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ DEFAULT_ARGS=(-c "v")
1717
# Pack warehouse directory - destination
1818
# Default: ./output
1919
#
20-
# PACK_OUTPUT=./output
20+
PACK_OUTPUT=./output
2121

2222
# Temporary pack build directory,
2323
# Default: ./build
2424
#
25-
# PACK_BUILD=./build
25+
PACK_BUILD=./build
2626

2727
# Specify directory names to be added to pack base directory
2828
# An empty list defaults to all folders next to this script.
@@ -44,7 +44,9 @@ PACK_BASE_FILES="
4444
# Specify file names to be deleted from pack build directory
4545
# Default: empty
4646
#
47-
# PACK_DELETE_FILES=""
47+
PACK_DELETE_FILES="
48+
Documentation/Doxygen
49+
"
4850

4951
# Specify patches to be applied
5052
# Default: empty
@@ -82,7 +84,14 @@ PACK_CHANGELOG_MODE="full"
8284
function preprocess() {
8385
# add custom steps here to be executed
8486
# before populating the pack build folder
85-
./Documentation/DoxyGen/gen_doc.sh
87+
pushd ./Documentation/Doxygen/ > /dev/null
88+
echo "Changing working directory to $(pwd)"
89+
90+
echo "Executing ./gen_doc.sh"
91+
./gen_doc.sh
92+
93+
popd > /dev/null
94+
echo "Changing working directory to $(pwd)"
8695
return 0
8796
}
8897

0 commit comments

Comments
 (0)