Skip to content

Commit a385bc8

Browse files
committed
scripts: minor fixes in documentation
Fix some missing terminal dot, rephrasing and upper case characters in the module update scripts documentation. Signed-off-by: Etienne Carriere <[email protected]>
1 parent ccae3ae commit a385bc8

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

scripts/README.rst

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Introduction:
55

66
This module provides scripts to update the STM32Cube for Zephyr.
77
Follow below steps to update the STM32Cube HAL from the latest
8-
version found in STM32CubeXX repositories.
8+
versions found in STM32CubeXX repositories.
99

1010
Step 1: Modify the code
1111
***********************
@@ -21,10 +21,10 @@ Alternatively, in order to update STM32CubeXX versions one by one, run for examp
2121
Check STM32CubeXX changes
2222
=========================
2323

24-
Check that all existing change to modules are correctly reported
25-
in the new hal_stm32 version
24+
Check that all existing changes to modules are correctly reported
25+
in the new hal_stm32 version.
2626

27-
Update each modified stm32cube/stm32XXxx/README in the last section,
27+
Update each modified stm32cube/stm32XXxx/README file in their last section.
2828

2929
Remove the following line::
3030
--> please check that the following list is still valid:
@@ -36,34 +36,33 @@ Step 2: Open a pull requests
3636
hal_stm32 PR
3737
============
3838
Open a single pull request with 1 commit per stm32 familly (stm32xx)
39-
in repo https://github.com/zephyrproject-rtos/hal_stm32
39+
in repo https://github.com/zephyrproject-rtos/hal_stm32.
4040

4141

4242
Modify the west.yml
4343
===================
44-
In order to benefit from this PR in zephyr, modify zephyrproject/zephyr/west.yml
45-
so that hal_stm32 points to above pull request. Example::
44+
In order to benefit from this pull request in Zephyr, modify
45+
zephyrproject/zephyr/west.yml
46+
so that hal_stm32 points to the above pull request. For example::
4647

4748
- name: hal_stm32
4849
revision: pull/60/head
4950
path: modules/hal/stm32
5051

5152

5253
Open a 2nd pull request with west.yml in repo
53-
https://github.com/zephyrproject-rtos/zephyr
54+
https://github.com/zephyrproject-rtos/zephyr.
5455

5556

5657
Step 3: After Merge
5758
*******************
5859

59-
re-Modify the west.yml
60+
Re-Modify the west.yml
6061
======================
6162

6263
Once the hal_stm32 pull request is merged (see step 2), in the zephyrproject-rtos/hal_stm32
63-
64-
then change again the zephyrproject-rtos/zephyr/west.yml
65-
66-
to reflect the actual zephyrproject-rtos/hal_stm32 SHA1, example::
64+
repo, change again the zephyrproject-rtos/zephyr/west.yml
65+
to reflect the actual zephyrproject-rtos/hal_stm32 latest commit SHA1, for example::
6766

6867
- name: hal_stm32
6968
revision: a813cd83b0cfbaaa625f4941d04baa3f93c37476
@@ -75,12 +74,12 @@ COMMENT:
7574

7675
- "set the SHA1 after merge of STM32Cube versions (modules/hal/stm32)"
7776

78-
See Example : https://github.com/zephyrproject-rtos/zephyr/pull/23259
77+
See for example https://github.com/zephyrproject-rtos/zephyr/pull/23259.
7978

8079

81-
clean
80+
Clean
8281
=====
83-
once all is correct, clean .rej and .log files, with :
82+
Once all is correctly merged, clean .rej and .log files, with :
8483

8584
::
8685

0 commit comments

Comments
 (0)