Add blurb about the MBR and other utility block devices #80
Conversation
There was a problem hiding this comment.
@geky Nice work. I've left a few minor comments for you to address.
docs/APIs/storage/block_device.md
Outdated
| @@ -28,6 +28,14 @@ Block devices indicate their block sizes through the `get_read_size`, `get_progr | |||
|
|
|||
| As a rule of thumb, you can use the erase size for applications that use a single block size (for example, the FAT file system). | |||
|
|
|||
| ## Utility block devices | |||
|
|
|||
| mbed OS contains several utility block devices to give you better control over how storage is allocated. | |||
There was a problem hiding this comment.
I suggest changing "how storage is allocated" to "the allocation of storage" to eliminate the passive voice.
docs/APIs/storage/block_device.md
Outdated
|
|
||
| mbed OS contains several utility block devices to give you better control over how storage is allocated. | ||
|
|
||
| - The [slicing block device](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/SlicingBlockDevice.h) allows you to partition storage into smaller block devices that you can use independentally. |
There was a problem hiding this comment.
In general, we try to avoid "allows". What do you think about changing this bullets to "With the slicing block, you can partition storage..."? Does that still keep the meaning the same?
Please apply this change to the following two bullets, too.
docs/APIs/storage/block_device.md
Outdated
|
|
||
| - The [slicing block device](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/SlicingBlockDevice.h) allows you to partition storage into smaller block devices that you can use independentally. | ||
| - The [chaining block device](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/ChainingBlockDevice.h) allows you to chain multiple block devices together and extend the usable amount of storage. | ||
| - The [MBR block device](https://github.com/ARMmbed/mbed-os/blob/master/features/filesystem/bd/MBRBlockDevice.h) allows you to partition storage with a [Master Boot Record](https://en.wikipedia.org/wiki/Master_boot_record). The MBR allows the partitions to be configured seperately from outside the application. |
There was a problem hiding this comment.
- Please use "Master Boot Record (MBR)" for first use and "MBR" for other uses.
- Please use a source other than wikipedia if possible.
There was a problem hiding this comment.
Hmm, so:
With the Master Boot Record (MBR) block device, you can partition storage with a master boot record. The MBR allows the partitions to be configured seperately from outside the application.
Seems a bit weird since the acronym is a part of the name.
How about something like this?
mbed OS comes with support for storing partitions on disk with a Master Boot Record (MBR). The MBR block device provides this functionality and supports creating partitions at runtime or using preformatted partitions configured seperately from outside the application.
Also I'm not really aware of a better source than wikipedia for the MBR. The MBR came about as an ad hoc portability layer between competing companies, so there never was a governing standard published by any authority. The MBR design has been mostly reverse engineered and I think wikipedia has the best collection of info. I'm open for a different source, but I don't think we can beat the wikipedia article in terms of being up to date.
There is the os-dev wiki entry on MBRs, but it's also a wiki (and is more focused on the linux point of view):
http://wiki.osdev.org/MBR_(x86)
|
@geky Would you like me to go ahead and make these changes, or would you prefer to review them first and make them yourself? |
|
Sorry for the delay, feel free to change what you want to since you are in charge here. I can update around any patches you make. |
Make suggested grammar changes
|
@geky Is this OK to move into the 5.5 branch [just created]? |
|
Yep should be good to go 👍 |
|
Awesome, thanks :) |
This is a part of documenting the MBR block device that is coming into mbed OS:
ARMmbed/mbed-os#3936
Note: This is dependeny on the above pr. That pr looks like it may not make it in until 5.6, so this pr may need to be rebased when a new docs branch is created.
cc @AnotherButler
NOTE: WAIT TO MERGE UNTIL 5.5