Skip to content

Commit 9cc66a9

Browse files
author
Amanda Butler
authored
Copy edit storage.md
Make minor copy edits for active voice, consistent spelling and proper punctuation.
1 parent 2df6aff commit 9cc66a9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<h2 id="contributing-storage">Storage</h2>
22

3-
Storage support is split between filesystems and their underlying block device support. The [storage API page](/docs/v5.6/reference/storage-overview.html) has more information on existing APIs in Mbed OS for both interfaces.
3+
Storage support is split between file systems and their underlying block device support. The [storage API page](/docs/v5.6/reference/storage-overview.html) has more information on existing APIs in Mbed OS for both interfaces.
44

55
#### Block Device
66

7-
Adding a block device implementation is required for backing filesystems on new hardware. You can extend the [BlockDevice](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/HeapBlockDevice.h) class to provide support for unsupported storage.
7+
Backing file systems on new hardware requires adding a block device implementation. You can extend the [BlockDevice](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/HeapBlockDevice.h) class to provide support for unsupported storage.
88

9-
If you want to port a new filesystem to Mbed OS on existing storage options you can skip to the following section.
9+
If you want to port a new file system to Mbed OS on existing storage options, you can skip to the following section.
1010

11-
#### Filesystems
11+
#### File systems
1212

13-
To implement a new file system in Mbed OS, an implementor needs to provide the abstract functions in the file system interface. The [FAT file system](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/fat/FATFileSystem.cpp) provides an excellent example, you can find tests of the POSIX API here.
13+
To implement a new file system in Mbed OS, an implementor needs to provide the abstract functions in the file system interface. The [FAT file system](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/fat/FATFileSystem.cpp) provides an excellent example. You can find tests of the POSIX API here.
1414

1515
A minimal file system needs to provide the following functions:
1616

@@ -20,8 +20,8 @@ A minimal file system needs to provide the following functions:
2020
- `file_write`.
2121
- `file_seek`.
2222

23-
Here is the full API that a filesystem may implement:
23+
Here is the full API that a file system may implement:
2424

2525
[![View code](https://www.mbed.com/embed/?type=library)](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/FileSystem.h#L205)
2626

27-
Filesystems must be backed by a block device in Mbed OS. If you are using supported hardware then you can continue, otherwise view the block device porting section above.
27+
A block device must back file systems in Mbed OS. If you are using supported hardware, then you can continue. Otherwise, view the block device porting section above.

0 commit comments

Comments
 (0)