Skip to content

Commit aa12887

Browse files
authored
Merge pull request #437 from RalfJung/readme
update README
2 parents e8fae1d + c77e8a6 commit aa12887

File tree

4 files changed

+16
-149
lines changed

4 files changed

+16
-149
lines changed

README.md

+16-68
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,18 @@
1-
[![Travis-CI Status]][travis] [![UCG Book]][ucg_book]
21

3-
[travis]: https://travis-ci.com/rust-lang/unsafe-code-guidelines
4-
[Travis-CI Status]: https://travis-ci.com/rust-lang/unsafe-code-guidelines.svg?branch=master
5-
[UCG Book]: https://img.shields.io/badge/UCG%20Book-Unsafe%20Code%20Guidelines%20Book-blue.svg
6-
[ucg_book]: https://rust-lang.github.io/unsafe-code-guidelines
7-
8-
UCG WG - Rust's Unsafe Code Guidelines Working Group
2+
UCG - Rust's Unsafe Code Guidelines
93
===
104

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.
347

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.
4011

41-
[current_area]: active_discussion/validity.md
42-
[active_discussion]: https://github.com/rust-lang/unsafe-code-guidelines/issues?q=is%3Aissue+is%3Aopen+label%3A%22active+discussion+topic%22
12+
Current consensus is documented in [t-opsem FCPs](https://github.com/rust-lang/opsem-team/blob/main/fcps.md) and the [Rust Language Reference].
4313

44-
* **communication channels**: Most of the discussion takes place here in GitHub
45-
issues. Many of us do also hang out on [Zulip's `wg-unsafe-code-guidelines`
46-
stream][Zulip]. There is rust-lang org team called
47-
[`WG-unsafe-code-guidelines`][rust_team] that is commonly cc'd when curious
48-
situations arise. Send a private message to @nikomatsakis on [internals] or
49-
[Zulip] if you would like to be added (note: membership does not imply any
50-
particular decision-making power).
51-
52-
[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/136281-wg-unsafe-code-guidelines
53-
[rust_team]: https://github.com/orgs/rust-lang/teams/wg-unsafe-code-guidelines
54-
[internals]: https://internals.rust-lang.org/
55-
56-
* **meetings**: Every Thursday at 12:15 UTC-4 (16:15 UTC), we hold a brief
57-
_non-technical_ meeting on [Zulip] to triage issues, PRs, assign work, etc.
58-
Everybody is welcome to attend.
59-
60-
Ideas for future "areas of discussion" are represented as [issues labeled with
61-
the "proposed discussion topic" label][proposed_discussion]. Feel free to open
62-
more such issues if you have a question that doesn't match any of the existing
63-
issues!
64-
65-
[proposed_discussion]: https://github.com/rust-rfcs/unsafe-code-guidelines/labels/proposed%20discussion%20topic
66-
67-
We follow the [Rust's Code of Conduct]. Any concerns should be addressed to the
68-
[moderation team] immediately.
69-
70-
[Rust's Code of Conduct]: https://www.rust-lang.org/en-US/conduct.html
71-
[moderation team]: https://www.rust-lang.org/team.html#Moderation-team
14+
[ucg_book]: https://rust-lang.github.io/unsafe-code-guidelines
15+
[Rust Language Reference]: https://doc.rust-lang.org/reference/index.html
7216

7317
## See also
7418

@@ -78,7 +22,11 @@ effort to explain how to write Rust code, rather than a reference.
7822

7923
[Rustonomicon]: https://doc.rust-lang.org/nightly/nomicon/
8024

81-
The [nikomatsakis/rust-memory-model] was a previous effort and contains a lot of
82-
good links and information.
25+
## Code of Conduct and licensing
26+
27+
All interactions on this repository (whether on issues, PRs, or
28+
elsewhere) are governed by the [Rust Code of
29+
Conduct](CODE_OF_CONDUCT.md).
8330

84-
[nikomatsakis/rust-memory-model]: https://github.com/nikomatsakis/rust-memory-model
31+
Further, all content on this repository is subject to the standard
32+
[Rust](LICENSE-MIT) [licensing](LICENSE-APACHE).

active_discussion.md

-1
This file was deleted.

process.md

-67
This file was deleted.

projects.md

-13
This file was deleted.

0 commit comments

Comments
 (0)