diff --git a/README.md b/README.md index f171a09a..4eca1360 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ UCG WG - Rust's Unsafe Code Guidelines Working Group The goal of the UCG WG is to produce the [Unsafe Code Guidelines Reference][ucg_book]: a "guide" for writing unsafe code that "recommends" what -kinds of things unsafe code can and cannot do. It is largely a work-in-progress -right now. +kinds of things unsafe code can and cannot do, and that documents which +guarantees unsafe code may rely on. It is largely a work-in-progress right now. Unless we state otherwise, the information in the guide is mostly a "recommendation" and still subject to change. The main goal for the WG in 2019 diff --git a/reference/book.toml b/reference/book.toml index 449827bc..598619a2 100644 --- a/reference/book.toml +++ b/reference/book.toml @@ -1,5 +1,5 @@ [book] -authors = ["Niko Matsakis"] +authors = ["The Rust Project Developers"] multilingual = false src = "src" title = "Unsafe Code Guidelines Reference" diff --git a/reference/src/SUMMARY.md b/reference/src/SUMMARY.md index b3cc4129..3dcb465b 100644 --- a/reference/src/SUMMARY.md +++ b/reference/src/SUMMARY.md @@ -1,7 +1,7 @@ # Summary -[Glossary](./glossary.md) - +- [Introduction](./introduction.md) +- [Glossary](./glossary.md) - [Data layout](./layout.md) - [Structs and tuples](./layout/structs-and-tuples.md) - [Scalars](./layout/scalars.md) diff --git a/reference/src/introduction.md b/reference/src/introduction.md new file mode 100644 index 00000000..f3220ef3 --- /dev/null +++ b/reference/src/introduction.md @@ -0,0 +1,14 @@ +## Rust's Unsafe Code Guidelines Reference + +This document is produced by the [UCG WG][ucg_wg] to provide a "guide" for +writing unsafe code that "recommends" what kinds of things unsafe code can and +cannot do, and that documents which guarantees unsafe code may rely on. It is +largely a work-in-progress right now. + +Unless we state otherwise, the information in the guide is mostly a +"recommendation" and still subject to change. The main goal for the WG in 2019 +is to RFC parts of the guide into the language specification, and move those +parts into the [Rust Language Reference] proper. + +[ucg_wg]: https://github.com/rust-lang/unsafe-code-guidelines +[Rust Language Reference]: https://doc.rust-lang.org/reference/index.html