Skip to content

Commit 3205975

Browse files
author
Amanda Butler
authored
Copy edit FATFileSystem.md
Copy edit file, mostly for active voice, consistent tense and removal of marketing tone.
1 parent 835a2ec commit 3205975

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/reference/api/storage/FATFileSystem.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@
22

33
<span class="images">![](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_f_a_t_file_system.png)<span>FATFileSystem class hierarchy</span></span>
44

5-
The FAT file system is a well-known and established disk oriented file system that you can find on Mbed OS and some lesser known operating systems such as Windows, Linux, and OSX. Due to its age and popularity, the FAT file system has become the de facto standard for forms of portable storage, such as flash drivers and SD cards.
5+
The FAT file system is an established disk-oriented file system that you can find on Mbed OS, Windows, Linux and Mac OS X. Due to its age and popularity, the FAT file system has become the standard for portable storage, such as flash drivers and SD cards.
66

7-
- **Portable** - Due to its nearly universal support across OSs, the FAT file system provides and easy way to access storage from both the embedded system and a user's PC.
7+
- **Portable** - Due to its nearly universal support across operating systems, the FAT file system provides access to storage from both the embedded system and your PC.
88

9-
- **Embedded** - Built on the well-known ChanFS project, the FAT file system has been heavily optimized for embedded systems.
9+
- **Embedded** - Built on the ChanFS project, the FAT file system is optimized for embedded systems.
1010

1111
For additional information, please see the [storage overview page](/docs/development/reference/storage.html#declaring-a-file-system).
1212

1313
### Use cases
1414

15-
The main reason to use the FAT file system is for its usefulness on portable storage. Because of this, most applications using FAT will likely use it in conjunction with an SD card.
15+
The main reason to use the FAT file system is its usefulness on portable storage. Because of this, most applications using FAT in conjunction with an SD card.
1616

17-
The first step to using the FAT file system will be formatting storage with FAT. This can be performed on a PC with the native format command, or it can be performed on Mbed OS with the `format` function.
17+
The first step to using the FAT file system is formatting storage with FAT. You can do this on a PC with the native format command or on Mbed OS with the `format` function.
1818

19-
**Note:** The FAT file system requires at minimum 256 erase blocks. You can find the number of blocks on a block device by dividing the block device's size by its erase size.
19+
<span class="notes">**Note:** The FAT file system requires at minimum 256 erase blocks. You can find the number of blocks on a block device by dividing the block device's size by its erase size.</span>
2020

21-
The FAT file system does support external flash, however it must allocate a full erase block for internal operations, which can get quite large for some forms of flash. If RAM consumption becomes a problem, we suggest switching to LittleFS. Fortunately, the Mbed OS file system APIs make switching file systems an easy task. One common strategy is to use the FAT file system for debugging, and switch to LittleFS when the application becomes stable.
21+
The FAT file system supports external flash; however, it must allocate a full erase block for internal operations, which can become large for some forms of flash. If RAM consumption becomes a problem, we suggest switching to LittleFileSsystem. The Mbed OS file system APIs make switching file systems a straightforward task. One common strategy is to use the FAT file system for debugging and switch to LittleFileSystem when the application becomes stable.
2222

2323
### Usage
2424

2525
Instantiate the `FATFileSystem` class with a block device and file path.
2626

2727
The API that this presents is the standard Mbed OS file system API. Once declared, Mbed OS provides the retargeting layer for the standard C library.
2828

29-
The FAT file system can be easily swapped in place with other Mbed OS file systems and is a great method for prototyping applications.
29+
You can swap the FAT file system in place with other Mbed OS file systems, which is a good method for prototyping applications.
3030

3131
### FATFileSystem class reference
3232

@@ -41,3 +41,4 @@ filesystem)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-fil
4141
### Related content
4242

4343
- [Storage configuration](configuration-storage.html).
44+
- [LittleFileSystem](littlefilesystem.html).

0 commit comments

Comments
 (0)