Skip to content

Commit ad2a30d

Browse files
authored
Add note about Mbed OS requirement
1 parent 5aef941 commit ad2a30d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

check_tools/config-update.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@
2121
# By default the script when run from the check_tools directory will run
2222
# through each Markdown file in `docs/reference/configuration/`. An
2323
# optional file or directory path may be passed in a parameter to run the
24-
# script on a specific file or directroy outside the default path.
24+
# script on a specific file or directroy outside the default path.
25+
#
26+
# Note that you need to run this with a local copy of whichever version of
27+
# Mbed OS you wish to update the configuration parameters with.
28+
#
29+
# You can run this script with:
30+
# python config-update.py <OPTIONAL FILE/DIR PATH>
2531

2632
import sys, os
2733
import re

0 commit comments

Comments
 (0)