Skip to content

Commit d27d3af

Browse files
committed
Wrap README.md and COPYRIGHT files consistently.
1 parent f8c0844 commit d27d3af

File tree

7 files changed

+39
-33
lines changed

7 files changed

+39
-33
lines changed

COPYRIGHT

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
Short version for non-lawyers:
22

3-
`cap-std` is triple-licensed under Apache 2.0 with the LLVM Exception, Apache 2.0,
4-
and MIT terms.
3+
`cap-std` is triple-licensed under Apache 2.0 with the LLVM Exception,
4+
Apache 2.0, and MIT terms.
55

66

77
Longer version:
88

9-
Copyrights in the `cap-std` project are retained by their contributors. No
10-
copyright assignment is required to contribute to the `cap-std` project.
9+
Copyrights in the `cap-std` project are retained by their contributors.
10+
No copyright assignment is required to contribute to the `cap-std`
11+
project.
1112

1213
Some files include code derived from Rust's `libstd`; see the comments in
1314
the code for details.
1415

15-
Except as otherwise noted (below and/or in individual files), `cap-std` is
16-
licensed under:
16+
Except as otherwise noted (below and/or in individual files), `cap-std`
17+
is licensed under:
1718

1819
- the Apache License, Version 2.0, with the LLVM Exception
1920
<LICENSE-Apache-2.0_WITH_LLVM-exception> or

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
</p>
1212
</div>
1313

14-
`cap-std` crate provides a capability-based version of [`std`]. It provides all the
15-
interfaces you are used to, but in a capability-based version.
14+
`cap-std` crate provides a capability-based version of [`std`]. It provides all
15+
the interfaces you are used to, but in a capability-based version.
1616

1717
[`std`]: https://doc.rust-lang.org/std/
1818

@@ -57,8 +57,8 @@ Attempts to access paths not contained within the directory:
5757

5858
return `PermissionDenied` errors.
5959

60-
This allows application logic to configure its own access, without changing
61-
the behavior of the whole host process, setting up a separate host process, or
60+
This allows application logic to configure its own access, without changing the
61+
behavior of the whole host process, setting up a separate host process, or
6262
requiring external configuration.
6363

6464
## How do I obtain a `Dir`?

cap-async-std/COPYRIGHT

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Apache 2.0, and MIT terms.
66

77
Longer version:
88

9-
Copyrights in the `cap-async-std` project are retained by their contributors. No
10-
copyright assignment is required to contribute to the `cap-async-std` project.
9+
Copyrights in the `cap-async-std` project are retained by their contributors.
10+
No copyright assignment is required to contribute to the `cap-async-std`
11+
project.
1112

1213
Some files include code derived from Rust's `libstd`; see the comments in
1314
the code for details.
1415

15-
Except as otherwise noted (below and/or in individual files), `cap-async-std` is
16-
licensed under:
16+
Except as otherwise noted (below and/or in individual files), `cap-async-std`
17+
is licensed under:
1718

1819
- the Apache License, Version 2.0, with the LLVM Exception
1920
<LICENSE-Apache-2.0_WITH_LLVM-exception> or

cap-async-std/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,24 @@
1111
</p>
1212
</div>
1313

14-
This crate provides a capability-based version of [`async-std`]. It provides all the
15-
interfaces you are used to, but in a capability-based version.
14+
This crate provides a capability-based version of [`async-std`]. It provides all
15+
the interfaces you are used to, but in a capability-based version.
1616

17-
See the [`cap-std` README.md] for more information about capability-based security.
17+
See the [`cap-std` README.md] for more information about capability-based
18+
security.
1819

1920
[`async-std`]: https://crates.io/crates/async-std
2021
[`cap-std`]: https://crates.io/crates/cap-std
2122
[`cap-std` README.md]: https://github.com/sunfishcode/cap-std/blob/main/README.md
2223

2324
At the moment, `cap-async-std` is a very rudimentary translation of `cap-std` to
24-
`async-std`. Like `cap-std`, it uses [`cap-primitives`] to perform the underlying
25-
operations. It hasn't yet been optimized to make effective use of `async`.
25+
`async-std`. Like `cap-std`, it uses [`cap-primitives`] to perform the
26+
underlying operations. It hasn't yet been optimized to make effective use of
27+
`async`.
2628

27-
The filesystem module, `fs`, is known to compile on Linux, macOS, and FreeBSD, and
28-
probably can be easily ported to other modern Unix-family platforms. Ports to
29-
Windows and WASI platforms are in development, though not yet usable.
29+
The filesystem module, `fs`, is known to compile on Linux, macOS, and FreeBSD,
30+
and probably can be easily ported to other modern Unix-family platforms. Ports
31+
to Windows and WASI platforms are in development, though not yet usable.
3032

3133
The networking module, `net`, is not yet usable.
3234

cap-directories/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@
1111
</p>
1212
</div>
1313

14-
The `cap-directories` crate provides utilities for accessing standard directories
15-
via the [`directories`] crate, but which provide [`Dir`]s instead of `Path`s.
14+
The `cap-directories` crate provides utilities for accessing standard
15+
directories via the [`directories`] crate, but which provide [`Dir`]s instead of
16+
`Path`s.
1617

1718
[`directories`]: https://crates.io/crates/directories
1819
[`Dir`]: https://docs.rs/cap-std/latest/cap_std/fs/struct.Dir.html

cap-primitives/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
</p>
1212
</div>
1313

14-
The `cap-primitives` crate provides primitive sandboxing operations that [`cap-std`]
15-
and [`cap-async-std`] are built on.
14+
The `cap-primitives` crate provides primitive sandboxing operations that
15+
[`cap-std`] and [`cap-async-std`] are built on.
1616

1717
[`cap-std`]: https://crates.io/crates/cap-std
1818
[`cap-async-std`]: https://crates.io/crates/cap-async-std

fuzz/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
This crate defines various `libFuzzer` targets for `cap-std` which can be run
44
via `cargo-fuzz` plugin.
55

6-
Currently, there is only a simple fuzzer for the `cap-primitives` crate which constructs
7-
random paths and attempts random filesystem operations on them. If `cap-primitives`'
8-
sandbox is working as intended, these operations either stay within a temporary directory
9-
or fail. Many of the operations in `cap-primitives` have backup checks in
10-
`not(feature = "no_racy_asserts")` builds, to diagnose sandbox escapes.
6+
Currently, there is only a simple fuzzer for the `cap-primitives` crate which
7+
constructs random paths and attempts random filesystem operations on them. If
8+
`cap-primitives`' sandbox is working as intended, these operations either stay
9+
within a temporary directory or fail. Many of the operations in `cap-primitives`
10+
have backup checks in `not(feature = "no_racy_asserts")` builds, to diagnose
11+
sandbox escapes.
1112

1213
Caution is recommended when running this fuzzer, since it is a filesystem
13-
fuzzer, and if it should find a way to escape the sandbox and avoid the
14-
backup checks, it could cause data loss.
14+
fuzzer, and if it should find a way to escape the sandbox and avoid the backup
15+
checks, it could cause data loss.
1516

1617
## Example: fuzzing `cap-primitives`
1718

0 commit comments

Comments
 (0)