Skip to content

Commit 634fcf0

Browse files
Amanda Butlergeky
Amanda Butler
authored andcommitted
Copy edit littlefs
ExhaustibleBlockDevice.h - Fix typos for consistent spelling. ObservingBlockDevice.h - Fix typos for consistent spelling. ReadOnlyBlockDevice.h - Fix typos for consistent spelling. README.md - Fix typos, mostly for branding. DESIGN.md - Make minor changes for consistent spelling and precise language. SPEC.md - Make minor changes for consistent spelling and precise language. README.md - Make minor changes for consistent spelling and precise language.
1 parent ff25681 commit 634fcf0

File tree

7 files changed

+163
-164
lines changed

7 files changed

+163
-164
lines changed

features/filesystem/bd/ExhaustibleBlockDevice.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,15 @@ class ExhaustibleBlockDevice : public BlockDevice
106106
*/
107107
virtual bd_size_t get_read_size() const;
108108

109-
/** Get the size of a programable block
109+
/** Get the size of a programmable block
110110
*
111-
* @return Size of a programable block in bytes
111+
* @return Size of a programmable block in bytes
112112
*/
113113
virtual bd_size_t get_program_size() const;
114114

115-
/** Get the size of a eraseable block
115+
/** Get the size of a erasable block
116116
*
117-
* @return Size of a eraseable block in bytes
117+
* @return Size of a erasable block in bytes
118118
*/
119119
virtual bd_size_t get_erase_size() const;
120120

features/filesystem/bd/ObservingBlockDevice.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,15 @@ class ObservingBlockDevice : public BlockDevice
9292
*/
9393
virtual bd_size_t get_read_size() const;
9494

95-
/** Get the size of a programable block
95+
/** Get the size of a programmable block
9696
*
97-
* @return Size of a programable block in bytes
97+
* @return Size of a programmable block in bytes
9898
*/
9999
virtual bd_size_t get_program_size() const;
100100

101-
/** Get the size of a eraseable block
101+
/** Get the size of a erasable block
102102
*
103-
* @return Size of a eraseable block in bytes
103+
* @return Size of a erasable block in bytes
104104
*/
105105
virtual bd_size_t get_erase_size() const;
106106

features/filesystem/bd/ReadOnlyBlockDevice.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,15 +85,15 @@ class ReadOnlyBlockDevice : public BlockDevice
8585
*/
8686
virtual bd_size_t get_read_size() const;
8787

88-
/** Get the size of a programable block
88+
/** Get the size of a programmable block
8989
*
90-
* @return Size of a programable block in bytes
90+
* @return Size of a programmable block in bytes
9191
*/
9292
virtual bd_size_t get_program_size() const;
9393

94-
/** Get the size of a eraseable block
94+
/** Get the size of a erasable block
9595
*
96-
* @return Size of a eraseable block in bytes
96+
* @return Size of a erasable block in bytes
9797
*/
9898
virtual bd_size_t get_erase_size() const;
9999

features/filesystem/littlefs/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## mbed wrapper for the little filesystem
1+
## Mbed wrapper for the little filesystem
22

33
This is the mbed wrapper for [littlefs](https://github.com/geky/littlefs),
44
a little fail-safe filesystem designed for embedded systems.
@@ -13,20 +13,20 @@ a little fail-safe filesystem designed for embedded systems.
1313
```
1414

1515
**Bounded RAM/ROM** - The littlefs is designed to work with a limited amount
16-
of memory. Recursion is avoided and dynamic memory is limited to configurable
16+
of memory. Recursion is avoided, and dynamic memory is limited to configurable
1717
buffers that can be provided statically.
1818

1919
**Power-loss resilient** - The littlefs is designed for systems that may have
20-
random power failures. The littlefs has strong copy-on-write guaruntees and
20+
random power failures. The littlefs has strong copy-on-write guarantees, and
2121
storage on disk is always kept in a valid state.
2222

23-
**Wear leveling** - Since the most common form of embedded storage is erodible
23+
**Wear leveling** - Because the most common form of embedded storage is erodible
2424
flash memories, littlefs provides a form of dynamic wear leveling for systems
25-
that can not fit a full flash translation layer.
25+
that cannot fit a full flash translation layer.
2626

2727
## Usage
2828

29-
If you are already using a filesystem in mbed, adopting the littlefs should
29+
If you are already using a filesystem in Mbed, adopting the littlefs should
3030
just require a name change to use the [LittleFileSystem](LittleFileSystem.h)
3131
class.
3232

@@ -82,11 +82,11 @@ int main() {
8282
## Reference material
8383
8484
[DESIGN.md](littlefs/DESIGN.md) - DESIGN.md contains a fully detailed dive into
85-
how littlefs actually works. I would encourage you to read it since the
85+
how littlefs actually works. We encourage you to read it because the
8686
solutions and tradeoffs at work here are quite interesting.
8787
8888
[SPEC.md](littlefs/SPEC.md) - SPEC.md contains the on-disk specification of
89-
littlefs with all the nitty-gritty details. Can be useful for developing
89+
littlefs with all the nitty-gritty details. This can be useful for developing
9090
tooling.
9191
9292
## Related projects
@@ -96,9 +96,9 @@ currently lives.
9696
9797
[littlefs-fuse](https://github.com/geky/littlefs-fuse) - A [FUSE](https://github.com/libfuse/libfuse)
9898
wrapper for littlefs. The project allows you to mount littlefs directly in a
99-
Linux machine. Can be useful for debugging littlefs if you have an SD card
99+
Linux machine. This can be useful for debugging littlefs if you have an SD card
100100
handy.
101101
102-
[littlefs-js](https://github.com/geky/littlefs-js) - A javascript wrapper for
102+
[littlefs-js](https://github.com/geky/littlefs-js) - A JavaScript wrapper for
103103
littlefs. I'm not sure why you would want this, but it is handy for demos.
104104
You can see it in action [here](http://littlefs.geky.net/demo.html).

0 commit comments

Comments
 (0)