Skip to content

Commit 23a831c

Browse files
authored
Merge pull request #4066 from tgross35/format-markdown
Format all markdown files to rewrap text
2 parents 7667d4d + 6c9d576 commit 23a831c

File tree

3 files changed

+44
-41
lines changed

3 files changed

+44
-41
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ This crate exports all underlying platform types, functions, and constants under
1111
the crate root, so all items are accessible as `libc::foo`. The types and values
1212
of all the exported APIs match the platform that libc is compiled for.
1313

14-
Windows API bindings are not included in this crate. If you are looking for WinAPI
15-
bindings, consider using crates like [windows-sys].
14+
Windows API bindings are not included in this crate. If you are looking for
15+
WinAPI bindings, consider using crates like [windows-sys].
1616

1717
More detailed information about the design of this library can be found in its
1818
[associated RFC][rfc].
@@ -43,32 +43,31 @@ libc = "0.2"
4343

4444
## Features
4545

46-
* `std`: by default `libc` links to the standard library. Disable this
47-
feature to remove this dependency and be able to use `libc` in `#![no_std]`
48-
crates.
46+
* `std`: by default `libc` links to the standard library. Disable this feature
47+
to remove this dependency and be able to use `libc` in `#![no_std]` crates.
4948

5049
* `extra_traits`: all `struct`s implemented in `libc` are `Copy` and `Clone`.
5150
This feature derives `Debug`, `Eq`, `Hash`, and `PartialEq`.
5251

53-
* `const-extern-fn`: Changes some `extern fn`s into `const extern fn`s.
54-
If you use Rust >= 1.62, this feature is implicitly enabled.
55-
Otherwise it requires a nightly rustc.
52+
* `const-extern-fn`: Changes some `extern fn`s into `const extern fn`s. If you
53+
use Rust >= 1.62, this feature is implicitly enabled. Otherwise it requires a
54+
nightly rustc.
5655

5756
## Rust version support
5857

59-
The minimum supported Rust toolchain version is currently **Rust 1.63.0**
60-
(libc does not currently have any policy regarding changes to the minimum
61-
supported Rust version; such policy is a work in progress).
58+
The minimum supported Rust toolchain version is currently **Rust 1.63.0** (libc
59+
does not currently have any policy regarding changes to the minimum supported
60+
Rust version; such policy is a work in progress).
6261

6362
## Platform support
6463

65-
You can see the platform(target)-specific docs on [docs.rs], select a platform you want to see.
64+
You can see the platform(target)-specific docs on [docs.rs], select a platform
65+
you want to see.
6666

67-
See
68-
[`ci/build.sh`](https://github.com/rust-lang/libc/blob/HEAD/ci/build.sh)
69-
for the platforms on which `libc` is guaranteed to build for each Rust
70-
toolchain. The test-matrix at [GitHub Actions] and [Cirrus CI] show the
71-
platforms in which `libc` tests are run.
67+
See [`ci/build.sh`](https://github.com/rust-lang/libc/blob/HEAD/ci/build.sh) for
68+
the platforms on which `libc` is guaranteed to build for each Rust toolchain.
69+
The test-matrix at [GitHub Actions] and [Cirrus CI] show the platforms in which
70+
`libc` tests are run.
7271

7372
<div class="platform_docs"></div>
7473

@@ -86,13 +85,13 @@ at your option.
8685

8786
## Contributing
8887

89-
We welcome all people who want to contribute. Please see the [contributing
90-
instructions] for more information.
88+
We welcome all people who want to contribute. Please see the
89+
[contributing instructions] for more information.
9190

9291
[contributing instructions]: https://github.com/rust-lang/libc/blob/HEAD/CONTRIBUTING.md
9392

94-
Contributions in any form (issues, pull requests, etc.) to this project
95-
must adhere to Rust's [Code of Conduct].
93+
Contributions in any form (issues, pull requests, etc.) to this project must
94+
adhere to Rust's [Code of Conduct].
9695

9796
[Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
9897

ci/README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ result the CI is pretty complicated and also pretty large! Hopefully this can
44
serve as a guide through the sea of scripts in this directory and elsewhere in
55
this project.
66

7-
Note that this documentation is quite outdated. See CI config and scripts
8-
in the `ci` directory how we run CI now.
7+
Note that this documentation is quite outdated. See CI config and scripts in the
8+
`ci` directory how we run CI now.
99

1010
# Files
1111

@@ -20,8 +20,9 @@ First up, let's talk about the files in this directory:
2020

2121
# CI Systems
2222

23-
Currently this repository leverages a combination of GitHub Actions and Cirrus CI
24-
for running tests. You can find tested triples in [Actions config] or [Cirrus config].
23+
Currently this repository leverages a combination of GitHub Actions and Cirrus
24+
CI for running tests. You can find tested triples in [Actions config] or
25+
[Cirrus config].
2526

2627
The Windows triples are all pretty standard, they just set up their environment
2728
then run tests, no need for downloading any extra target libs (we just download
@@ -101,8 +102,10 @@ about above), and then shut down.
101102

102103
1. [Download the latest stable amd64-bootonly release ISO](https://www.freebsd.org/where.html).
103104
E.g. FreeBSD-11.1-RELEASE-amd64-bootonly.iso
104-
2. Create the disk image: `qemu-img create -f qcow2 FreeBSD-11.1-RELEASE-amd64.qcow2 2G`
105-
3. Boot the machine: `qemu-system-x86_64 -cdrom FreeBSD-11.1-RELEASE-amd64-bootonly.iso -drive if=virtio,file=FreeBSD-11.1-RELEASE-amd64.qcow2 -net nic,model=virtio -net user`
105+
2. Create the disk image:
106+
`qemu-img create -f qcow2 FreeBSD-11.1-RELEASE-amd64.qcow2 2G`
107+
3. Boot the machine:
108+
`qemu-system-x86_64 -cdrom FreeBSD-11.1-RELEASE-amd64-bootonly.iso -drive if=virtio,file=FreeBSD-11.1-RELEASE-amd64.qcow2 -net nic,model=virtio -net user`
106109
4. Run the installer, and install FreeBSD:
107110
1. Install
108111
1. Continue with default keymap
@@ -159,9 +162,9 @@ about above), and then shut down.
159162

160163
1. Exit the post install shell: `exit`
161164
1. Back in the installer choose Reboot
162-
1. If all went well the machine should reboot and show a login prompt.
163-
If you switch to the serial console by choosing View > serial0 in
164-
the qemu menu, you should be logged in as root.
165+
1. If all went well the machine should reboot and show a login prompt. If you
166+
switch to the serial console by choosing View > serial0 in the qemu menu,
167+
you should be logged in as root.
165168
1. Shutdown the machine: `shutdown -p now`
166169

167170
Helpful links
@@ -178,8 +181,8 @@ Helpful links
178181
4. run installer
179182
5. `echo 'set tty com0' >> /etc/boot.conf`
180183
6. `echo 'boot' >> /etc/boot.conf`
181-
7. Modify /etc/ttys, change the `tty00` at the end from 'unknown off' to
182-
'vt220 on secure'
184+
7. Modify /etc/ttys, change the `tty00` at the end from 'unknown off' to 'vt220
185+
on secure'
183186
8. Modify same line in /etc/ttys to have `"/root/foo.sh"` as the shell
184187
9. Add this script to `/root/foo.sh`
185188

libc-test/semver/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ ensure that APIs aren't removed between libc releases.
66
## File order
77

88
Files are including in the following order:
9-
* Family, e.g. `unix.txt`. NOTE: Windows is skipped here and includes as OS
10-
name below.
11-
* Vendor, e.g. `apple.txt`. This allows us to have a single file with system
12-
calls shared between multiple OSs, e.g. `ios.txt`, `macos.txt` share the same
13-
kernel.
14-
* OS, e.g `linux.txt`, `macos.txt`, `windows.txt`.
15-
* Architecture specific system calls, e.g. `linux-x86_64.txt` or
16-
`linux-aarch64.txt`.
17-
* Target environment, e.g. `windows-mscv.txt` or `windows-gnu.txt`.
9+
10+
* Family, e.g. `unix.txt`. NOTE: Windows is skipped here and includes as OS name
11+
below.
12+
* Vendor, e.g. `apple.txt`. This allows us to have a single file with system
13+
calls shared between multiple OSs, e.g. `ios.txt`, `macos.txt` share the same
14+
kernel.
15+
* OS, e.g `linux.txt`, `macos.txt`, `windows.txt`.
16+
* Architecture specific system calls, e.g. `linux-x86_64.txt` or
17+
`linux-aarch64.txt`.
18+
* Target environment, e.g. `windows-mscv.txt` or `windows-gnu.txt`.

0 commit comments

Comments
 (0)