mirror of
https://github.com/trussed-dev/littlefs2.git
synced 2026-06-20 04:16:32 -07:00
fix: Update urls and docs for:
- Urls to former users - badges - upstream release Signed-off-by: Lachezar Lechev <elpiel93@gmail.com>
This commit is contained in:
committed by
Robin Krahl
parent
f906960d56
commit
8ed5ea2e5b
@@ -19,8 +19,8 @@
|
||||
alt="API docs" />
|
||||
</a>
|
||||
<!-- Continuous build -->
|
||||
<a href="https://github.com/nickray/littlefs2/actions?query=branch%3Amain">
|
||||
<img src="https://img.shields.io/github/workflow/status/nickray/littlefs2/CI/main?style=for-the-badge"
|
||||
<a href="https://github.com/trussed-dev/littlefs2/actions?query=branch%3Amain">
|
||||
<img src="https://img.shields.io/github/actions/workflow/status/trussed-dev/littlefs2/ci.yml?branch=main&style=for-the-badge"
|
||||
alt="CI" height="20"/>
|
||||
</a>
|
||||
</div>
|
||||
@@ -35,14 +35,14 @@ We follow [`std::fs`][std-fs] as much as reasonable.
|
||||
|
||||
The low-level bindings are provided by the [littlefs2-sys][littlefs2-sys] library.
|
||||
|
||||
Upstream release: [v2.1.4][upstream-release]
|
||||
Upstream release: [v2.2.1][upstream-release]
|
||||
|
||||
[geky]: https://github.com/geky
|
||||
[littlefs]: https://github.com/ARMmbed/littlefs
|
||||
[release-notes-2]: https://github.com/ARMmbed/littlefs/releases/tag/v2.0.0
|
||||
[littlefs]: https://github.com/littlefs-project/littlefs
|
||||
[release-notes-2]: https://github.com/littlefs-project/littlefs/releases/tag/v2.0.0
|
||||
[std-fs]: https://doc.rust-lang.org/std/fs/index.html
|
||||
[littlefs2-sys]: https://lib.rs/littlefs2-sys
|
||||
[upstream-release]: https://github.com/ARMmbed/littlefs/releases/tag/v2.1.4
|
||||
[upstream-release]: https://github.com/littlefs-project/littlefs/releases/tag/v2.2.1
|
||||
|
||||
## `no_std`
|
||||
|
||||
@@ -56,7 +56,7 @@ This library is `no_std` compatible, but there are two gotchas.
|
||||
|
||||
#### License
|
||||
|
||||
<sup>littlefs is licensed under [BSD-3-Clause](https://github.com/ARMmbed/littlefs/blob/master/LICENSE.md).</sup>
|
||||
<sup>littlefs is licensed under [BSD-3-Clause](https://github.com/littlefs-project/littlefs/blob/master/LICENSE.md).</sup>
|
||||
<sup>This API for littlefs is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.</sup>
|
||||
<sup>Previous bindings exist in the [rust-littlefs](https://github.com/brandonedens/rust-littlefs) repository, also dual-licensed under Apache-2.0 and MIT.</sup>
|
||||
<br>
|
||||
|
||||
@@ -69,7 +69,7 @@ impl<Storage: driver::Storage> Allocation<Storage> {
|
||||
|
||||
debug_assert!(read_size > 0);
|
||||
debug_assert!(write_size > 0);
|
||||
// https://github.com/ARMmbed/littlefs/issues/264
|
||||
// https://github.com/littlefs-project/littlefs/issues/264
|
||||
// Technically, 104 is enough.
|
||||
debug_assert!(block_size >= 128);
|
||||
debug_assert!(cache_size > 0);
|
||||
@@ -732,8 +732,8 @@ impl<'a, 'b, Storage: driver::Storage> File<'a, 'b, Storage>
|
||||
/// TODO: check if this can be closed >1 times, if so make it safe
|
||||
///
|
||||
/// Update: It seems like there's an assertion on a flag called `LFS_F_OPENED`:
|
||||
/// https://github.com/ARMmbed/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2549
|
||||
/// https://github.com/ARMmbed/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2566
|
||||
/// https://github.com/littlefs-project/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2549
|
||||
/// https://github.com/littlefs-project/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2566
|
||||
///
|
||||
/// - On second call, shouldn't find ourselves in the "mlist of mdirs"
|
||||
/// - Since we don't have dynamically allocated buffers, at least we don't hit the double-free.
|
||||
@@ -783,7 +783,7 @@ impl<'a, 'b, Storage: driver::Storage> File<'a, 'b, Storage>
|
||||
// This belongs in `io::Read` but really don't want that to have a generic parameter
|
||||
pub fn read_to_end<const N: usize>(&self, buf: &mut heapless::Vec<u8, N>) -> Result<usize> {
|
||||
// My understanding of
|
||||
// https://github.com/ARMmbed/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2816
|
||||
// https://github.com/littlefs-project/littlefs/blob/4c9146ea539f72749d6cc3ea076372a81b12cb11/lfs.c#L2816
|
||||
// is that littlefs keeps reading until either the buffer is full, or the file is exhausted
|
||||
|
||||
let had = buf.len();
|
||||
|
||||
+6
-6
@@ -2,19 +2,19 @@
|
||||
|
||||
/*!
|
||||
|
||||
[littlefs](https://github.com/ARMmbed/littlefs) is a filesystem for microcontrollers
|
||||
[littlefs](https://github.com/littlefs-project/littlefs) is a filesystem for microcontrollers
|
||||
written in C, that claims to be *fail-safe*:
|
||||
- power-loss resilience, by virtue of copy-on-write guarantees
|
||||
- bounded RAM/ROM, with stack-allocated buffers
|
||||
|
||||
Since [version 2](https://github.com/ARMmbed/littlefs/releases/tag/v2.0.0), it has
|
||||
Since [version 2](https://github.com/littlefs-project/littlefs/releases/tag/v2.0.0), it has
|
||||
some nifty features such as:
|
||||
- dynamic wear-leveling, including detection of bad Flash blocks
|
||||
- custom user attributes
|
||||
- inline files, avoiding block waste
|
||||
|
||||
For more background, see its [design notes](https://github.com/ARMmbed/littlefs/blob/master/DESIGN.md)
|
||||
and the [specification](https://github.com/ARMmbed/littlefs/blob/master/SPEC.md) of its format.
|
||||
For more background, see its [design notes](https://github.com/littlefs-project/littlefs/blob/master/DESIGN.md)
|
||||
and the [specification](https://github.com/littlefs-project/littlefs/blob/master/SPEC.md) of its format.
|
||||
|
||||
### What is this?
|
||||
|
||||
@@ -29,8 +29,8 @@ constants associated to traits will be treated as constants by the compiler.
|
||||
|
||||
Another complication is the fact that files (and directories) need to be closed before they go out of scope,
|
||||
since the main littlefs state structure contains a linked list which would exhibit UB (undefined behaviour)
|
||||
otherwise, see [issue #3](https://github.com/nickray/littlefs2/issues/3) and
|
||||
[issue #5](https://github.com/nickray/littlefs2/issues/5). We choose *not* to call `close` in `drop` (as
|
||||
otherwise, see [issue #3](https://github.com/trussed-dev/littlefs2/issues/3) and
|
||||
[issue #5](https://github.com/trussed-dev/littlefs2/issues/5). We choose *not* to call `close` in `drop` (as
|
||||
`std::fs` does), since these operations could panic if for instance `littlefs` detects Flash corruption
|
||||
(from which the application might otherwise recover).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user