You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
UCG WG - Rust's Unsafe Code Guidelines Working Group
2
+
UCG - Rust's Unsafe Code Guidelines
9
3
===
10
4
11
-
The goal of the UCG WG is to produce the [Unsafe Code Guidelines
12
-
Reference][ucg_book]: a "guide" for writing unsafe code that "recommends" what
13
-
kinds of things unsafe code can and cannot do, and that documents which
14
-
guarantees unsafe code may rely on. It is largely a work-in-progress right now.
15
-
16
-
Unless we state otherwise, the information in the guide is mostly a
17
-
"recommendation" and still subject to change. The main goal for the WG in 2019
18
-
is to RFC parts of the guide into the language specification, and move those
19
-
parts into the [Rust Language Reference] proper.
20
-
21
-
[Rust Language Reference]: https://doc.rust-lang.org/reference/index.html
22
-
23
-
> **note**: the instructions to build the UCG reference book are in the
24
-
> [`.travis.yml`][travis_yml] file.
25
-
26
-
[travis_yml]: .travis.yml
27
-
28
-
## Process
29
-
30
-
A more complete description of our process is available in [the `process.md`
31
-
file][process]. Briefly:
32
-
33
-
[process]: process.md
5
+
The purpose of this repository is to collect and discuss all sorts of questions that come up when writing unsafe code.
6
+
It is primarily used by the [opsem team](https://github.com/rust-lang/opsem-team/) to track open questions around the operational semantics, but we also track some "non-opsem" questions that fall into T-lang or T-type's purview, if they are highly relevant to unsafe code authors.
34
7
35
-
***active discussion area**: At any given time, the UCG working group is
36
-
focused on one particular **area** of discussion. The current area is
37
-
[**Validity Invariants**][current_area] -- read that link for more background
38
-
and information. You can find the [active discussion threads
39
-
here][active_discussion].
8
+
The [Unsafe Code Guidelines Reference "book"][ucg_book] is a past effort to systematize a consensus on some of these questions.
9
+
It is not actively maintained any more, but can still be a good source of information and references.
10
+
Note however that unless stated otherwise, the information in the guide is mostly a "recommendation" and still subject to change.
0 commit comments