Added FAT file system documentation #518
Conversation
Copy edit file, mostly for active voice, consistent tense and removal of marketing tone.
Copy edit file, mostly for active voice and removal of marketing tone.
Copy edit remaining storage content.
|
|
||
| ##### Portable | ||
|
|
||
| The primary feature of the FAT file system is its portability. With support across PC operating systems, the FAT file system lets you access storage from both the embedded system your PC. This gives users a way to get information onto and off of the device. |
There was a problem hiding this comment.
I've read some of this content three times now. Instead of duplicating it, let's keep API-specific content on the API reference pages and general concepts on the overview pages.
There was a problem hiding this comment.
I still think this causes problems for users, since the general concepts are important to understand the API and the users I've seen don't ever see the overview page.
But feel free to update it so it's consistent.
There was a problem hiding this comment.
@geky Thanks for submitting this. I've left a comment for you to address and some changes for you to review to make sure I didn't accidentally change the meaning of anything.
| @@ -27,13 +27,15 @@ The `fopen` function is similar to the open function above but associates a stre | |||
|
|
|||
| - **Wear leveling** - Because the most common form of embedded storage is erodible flash memories, this file system provides a form of dynamic wear leveling for systems that cannot fit a full flash translation layer. | |||
|
|
|||
| - **FATFileSystem** - The FAT file system is a well-known file system that you can find on almost every system, including PCs. The Mbed OS implementation of the FAT file system is based on ChanFS and is optimized for small embedded systems. | |||
| - **FATFileSystem** - The FAT file system is an established disk-oriented file system that you can find on most operating systems, including Windows, Linux, Mac OS X and Mbed OS. | |||
|
|
|||
There was a problem hiding this comment.
We need a link to page with details about FATFileSystem to make it consistent compared to LittleFS.
There was a problem hiding this comment.
Ah good catch, I believe this should link to the FATFileSystem.md also in this PR.
@AnotherButler, are you able to add this link so it will work on the doc site?
|
Looks fine to me |
|
|
||
| <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> | ||
|
|
||
| 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. |
There was a problem hiding this comment.
I think there's an extra 's' there
|
|
||
| ### FATFileSystem class reference | ||
|
|
||
| [](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_f_a_t_file_system.html) | ||
|
|
||
| ### FATFileSystem example | ||
|
|
||
| [Add example here.] | ||
| [
There was a problem hiding this comment.
This isn't rendering for me properly, just shows up as the raw text rather than the example button. Could be my browser though.
|
The example button wasn't rendering properly for me, could have been a diff thing in my browser though. Everything else looks good to me! |
Fix typo and example link, raised in comments.
|
pretend I approved it 👍 |
Add link requested in comments.
Start of additional filesystem documentation. Let me know your feedback.
cc @AnotherButler, @kegilbert, @MarceloSalazar