Skip to content

Commit

Permalink
Auto merge of #3510 - JohnTitor:prepare-libc-0.3, r=JohnTitor
Browse files Browse the repository at this point in the history
Prepare docs for libc v0.3
  • Loading branch information
bors committed Jan 7, 2024
2 parents e5612b9 + f8c19f5 commit 72093f3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -3,6 +3,13 @@
Welcome! If you are reading this document, it means you are interested in contributing
to the `libc` crate.

## v0.2 changes

If you want to add your changes to v0.2, please submit them to the `libc-0.2` branch.
If you want to add any breaking changes, it should be submitted to the main branch,
which has changes for v0.3.
We will support and make a new release for v0.2 until we make the first release of v0.3.

## Adding an API

Want to use an API which currently isn't bound in `libc`? It's quite easy to add
Expand Down
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -16,6 +16,15 @@ More detailed information about the design of this library can be found in its

[rfc]: https://github.com/rust-lang/rfcs/blob/HEAD/text/1291-promote-libc.md

## v0.3 Roadmap

The main branch is now for v0.3 which has some breaking changes.

For v0.2, please submit PRs to the `libc-0.2` branch instead.
We will stop making new v0.2 releases once we release v0.3 on crates.io.

See the [tracking issue](https://github.com/rust-lang/libc/issues/3248) for details.

## Usage

Add the following to your `Cargo.toml`:
Expand Down

0 comments on commit 72093f3

Please sign in to comment.