Skip to content

add introduction to book #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion reference/book.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[book]
authors = ["Niko Matsakis"]
authors = ["The Rust Project Developers"]
multilingual = false
src = "src"
title = "Unsafe Code Guidelines Reference"
4 changes: 2 additions & 2 deletions reference/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
14 changes: 14 additions & 0 deletions reference/src/introduction.md
Original file line number Diff line number Diff line change
@@ -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