Skip to content

Commit 8bca678

Browse files
Amanda Butlertheamirocohen
authored andcommitted
Copy edit README.md
Copy edit file, mostly for active voice.
1 parent 7143143 commit 8bca678

File tree

1 file changed

+13
-17
lines changed
  • features/storage/TESTS/blockdevice/general_block_device

1 file changed

+13
-17
lines changed

features/storage/TESTS/blockdevice/general_block_device/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started with the Mbed OS block device test
22

3-
Mbed OS block device test is used to test existing and new block devices.
3+
You can use the Mbed OS block device test to test existing and new block devices.
44

55
You can find more information about the Mbed OS block device and other related pieces of the Mbed OS storage stack [in the storage overview](https://os.mbed.com/docs/latest/reference/storage.html).
66

@@ -15,16 +15,13 @@ You can find more information about the Mbed OS block device and other related p
1515

1616
## Hardware requirements
1717

18-
This test uses a block device as storage. This can be either an external
19-
block device (one of SPI flash, DataFlash or an SD card) or simulated on a
20-
heap block device on boards with enough RAM.
18+
This test uses a block device as storage. This can be either an external block device (one of SPI flash, DataFlash or an SD card) or simulated on a heap block device on boards with enough RAM.
2119

2220
## Usage
2321

2422
#### Compile the test
2523

26-
Invoke `mbed test`, and specify the name of your platform and your favorite
27-
toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
24+
Invoke `mbed test`, and specify the name of your platform and your favorite toolchain (`GCC_ARM`, `ARM`, `IAR`). For example, for the ARM Compiler 5:
2825

2926
```
3027
mbed test -m K64F -t ARM -n mbed-os-features-storage-tests-blockdevice-general_block_device --compile
@@ -40,18 +37,17 @@ mbed test -m K64F -t ARM -n mbed-os-features-storage-tests-blockdevice-general_b
4037

4138
#### Troubleshooting
4239

43-
If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html)
44-
for suggestions on what could be wrong and how to fix it.
40+
Please review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions about how to fix possible issues you may face.
4541

4642
## Changing the block device
4743

48-
In Mbed OS, a C++ class that inherits from the [BlockDevice](https://os.mbed.com/docs/latest/reference/storage.html#block-devices)
49-
interface represents each block device.
50-
This test uses the default block device received by the function get_default_instance(), it is defined in [SystemStorage.cpp](https://github.com/ARMmbed/mbed-os/blob/master/features/storage/system_storage/SystemStorage.cpp#L35-L77) as MBED_WEAK, in case we would like to test a new block device we will have to override it.
44+
In Mbed OS, a C++ class that inherits from the [BlockDevice](https://os.mbed.com/docs/latest/reference/storage.html#block-devices) interface represents each block device.
5145

52-
first add the new block device cpp and header files to [blockdevice folder](https://github.com/ARMmbed/mbed-os/tree/master/features/storage/blockdevice), then implement get_default_instance() inside the test main.cpp.
46+
This test uses the default block device that the function `get_default_instance()` receives. [SystemStorage.cpp](https://github.com/ARMmbed/mbed-os/blob/master/features/storage/system_storage/SystemStorage.cpp#L35-L77) defines this as `MBED_WEAK`. If you would like to test a new block device, you have to override it.
5347

54-
for example, in order to test the HeapBlockDevice add:
48+
First add the new block device .cpp and header files to the [blockdevice folder](https://github.com/ARMmbed/mbed-os/tree/master/features/storage/blockdevice). Then, implement `get_default_instance()` inside the test `main.cpp`.
49+
50+
For example, to test the HeapBlockDevice, add:
5551

5652
``` diff
5753
+#define TEST_BLOCK_SIZE 128
@@ -69,7 +65,7 @@ Now you can recompile and run.
6965

7066
## Tested configurations
7167

72-
- K64F + SD
73-
- K64F + Heap
74-
- K82F + SPIF
75-
- K82F + Heap
68+
- K64F + SD.
69+
- K64F + Heap.
70+
- K82F + SPIF.
71+
- K82F + Heap.

0 commit comments

Comments
 (0)