Skip to content

Commit f4a3d26

Browse files
author
Amanda Butler
authored
Edit README.md
Edit file for minor grammar and style tweaks, mostly for consistent capitalization and tense across docs.
1 parent 43e819e commit f4a3d26

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

tools/psa/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# PSA Tools
1+
# PSA tools
22

3-
This document will describe the following scripts:
3+
This document describes the following scripts:
44

55
* \_\_init\_\_.py
66
* generate_partition_code.py
@@ -11,18 +11,18 @@ This document will describe the following scripts:
1111

1212
## \_\_init\_\_.py
1313

14-
This file holds common function dedicated to help SiP with their post-build logic.
15-
16-
* find_secure_image - Scans a Resource object to find the correct binary of the secure image to merge with the non-secure build.
14+
This file holds common functions dedicated to help SiP with their postbuild logic.
1715

16+
* find_secure_image - Scans a Resource object to find the correct binary of the secure image to merge with the nonsecure build.
1817

1918
## Code generation scripts
2019

21-
mbed-os holds 2 implementations of PSA:
22-
* MBED_SPM - Implementation for dual core v7 targets.
20+
Mbed OS holds two implementations of PSA:
21+
22+
* MBED_SPM - Implementation for dual-core v7 targets.
2323
* TF-M - Implementation for v8 targets.
2424

25-
each implementation requires a set of auto generated files describing the secure partitions.
25+
Each implementation requires a set of autogenerated files describing the secure partitions:
2626

2727
* `generate_partition_code.py` - Generate files for both implementations.
2828
* `generate_mbed_spm_partition_code.py` - Generate files for MBED_SPM.
@@ -31,7 +31,7 @@ each implementation requires a set of auto generated files describing the secure
3131

3232
## Secure image generation
3333

34-
`release.py` is the script assigned with compiling the secure images.
34+
`release.py` is the script assigned with compiling the secure images:
3535

3636
```
3737
usage: release.py [-h] [-m MCU]
@@ -41,9 +41,10 @@ optional arguments:
4141
-m MCU, --mcu MCU build for the given MCU
4242
```
4343

44-
when `MCU ` is not specified the script will compile all the images for all the targets
44+
When `MCU ` is not specified, the script compiles all the images for all the targets.
45+
46+
This script should be run in following scenarios:
4547

46-
This script should be ran in following scenarios:
4748
* Release.
4849
* Update to files originating in the secure side.
4950
* Drivers update.

0 commit comments

Comments
 (0)