Skip to content

Commit 231bbf2

Browse files
authored
[Coding Guidelines] Add meeting minutes 2024-12-04 (#117)
* [Coding Guidelines] Meeting minutes 2024-12-04 * Clarify source of safe keyword change
1 parent a2baf16 commit 231bbf2

File tree

1 file changed

+102
-8
lines changed
  • subcommittee/coding-guidelines/meetings/2024-December-04

1 file changed

+102
-8
lines changed

subcommittee/coding-guidelines/meetings/2024-December-04/minutes.md

Lines changed: 102 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,40 @@
66
2. Open a discussion on timelines/milestones for goals (Pete LeVasseur)
77
3. `unsafe` Practicum Chapter Task Force - progress report (Pete LeVasseur)
88
4. `unsafe` Docs Review Task Force - progress report (Pete LeVasseur)
9-
5. MISRA + Rust (Alex Celeste)
10-
6. Round table
9+
5. Round table
1110

1211
Supplemental material to the agenda can be found on the [GitHub repo](https://github.com/rustfoundation/safety-critical-rust-consortium/tree/main/subcommittee/coding-guidelines).
1312

1413
## Check-in area
1514

1615
**Please add your name, and an emoji that describes your day.**
1716

18-
*
17+
* Pete LeVasseur, ✌️
18+
* Joel Marcey, 🥱
19+
* Kyle Heins, 🥱
20+
* Andrew Fernandes 🥱☕️
21+
* Joni Pelham 😣
22+
* Marc Schoolderman 🎅
23+
* Alexandru Vochescu 🥱
24+
* Dillon McEwan 😴
25+
* Jordan McQueen 😴🗻❄️
26+
* Jonas Wolf 😀
27+
* Joe Johnson 😴
28+
* Vincent Eckert 😃
29+
* Douglas Deslauriers 😀
30+
* Arthur Hicken 😀🔦🔬
31+
* Nadhmi JAZI 😀
32+
* Christof Petig 🎅
33+
* Walter Pearce 🤘
34+
* Enow Scott 😀
35+
* Wayne Chang 🎅
36+
* Munawar Hafiz 🙂
37+
* Oreste Bernardi
38+
1939

2040
**Notetaker:**
2141

22-
*
42+
* Douglas Deslauriers
2343

2444
## Housekeeping section, please add
2545

@@ -28,14 +48,88 @@ Supplemental material to the agenda can be found on the [GitHub repo](https://gi
2848

2949
## Tasks
3050

31-
*
51+
* [PL](mailto:plevasseur@gmail.com): Create a set of milestones for progress moving forward
3252

3353
## Meeting Minutes:
3454

35-
*
55+
* JW: Motion to accept the previous minutes
56+
* Meeting minutes were accepted unanimously
57+
58+
### Timelines and Milestones for Goals
59+
60+
* PL: Two task forces have been proposed, one for creation, one for review. More details on Zulip
61+
* DD: Would the two task forces meet outside of these meetings?
62+
* PL: That is possible
63+
* PL: Proposal: First step for Practicum group is to create some prose for safe
64+
use of unsafe to accompany [the examples](https://github.com/rustfoundation/safety-critical-rust-consortium/blob/main/subcommittee/coding-guidelines/initiatives/safe-use-of-unsafe-guidelines/unsafe-example-usage.md)
65+
* JM: Wants to add prose to the examples
66+
* AF: Would like to help add prose, but time constrained
67+
* JJ: Would also like to help. Wonders whether the standard/core library or both unsafe behaviour would be covered in the document?
68+
* PL: The idea would be to target both audiences that use standard library and not
69+
* CP: [Embassy](https://github.com/embassy-rs/embassy) would be a good example of unsafe usage
70+
* AF: There are many patterns in the C world that are accepted, and giving people design patterns would be useful to help the transition
71+
* JM: In response to the previous Practicum group proposal, agreed good first steps.
72+
* PL: Proposal for document review task group, to review the [Rust unsafe code
73+
guidelines](https://github.com/rust-lang/unsafe-code-guidelines)
74+
* DD: Agreed, would be beneficial
75+
* It was suggested that multiple people should review the guidelines
76+
77+
### Practicum Chapter Task Force Progress
78+
79+
* JM: Mostly looking where to start, and perhaps annotating the examples as suggested earlier
80+
* JM: Would the idea to be supplement the Learn Unsafe Rust book with coding guidelines
81+
* PL: Spoke to an author the book and was open to contributions and may even be able to transfer ownership to the Rust Foundation
82+
* JJ: The book has a good starting framework
83+
84+
### Docs Review Task Force Progress
85+
86+
* PL: Mostly review the unsafe code guidelines glossary
87+
88+
### Round Table
89+
90+
* WC: Interested in supply chain security of rust packages?
91+
* JM: This may be more relevant to the Tooling committee
92+
* AF: This may be out of scope, but is certainly would be looked at from a regulatory perspective
93+
* DD: The largest extent that of the coding guidelines would be tell users to have the coding guidelines apply to used packages as well
94+
* WP: Google has [Rust crate audits](https://github.com/google/rust-crate-audits), using [Cargo Vet](https://github.com/mozilla/cargo-vet)
95+
96+
---
97+
98+
* OB: Wanted to determine what unsafe/undefined behaviour is in reference to the hardware
99+
* PL: There is a section on undefined behaviour in the Learn Unsafe Rust book
100+
* OB: Can share document on safety in the scope of low level driver
101+
102+
---
103+
104+
* AH: Is the meeting going to be in January?
105+
* JM: It will be nearby to Rust Nation in February, on the 19th
106+
* PL: Would the venue be outside of Rust Nation?
107+
* JM: **It would be outside of the venue, and would not require tickets to Rust Nation**
108+
* JM: About 20 people have responded to the poll as going face to face
109+
110+
---
111+
112+
* JP: Different levels of assurance for different guidelines may be useful
113+
* AF: The definition of unsafe, means that the code will be unproven
114+
* JP: It should be clear in the guidelines that some unsafe should be used
115+
* JM: We should have specific recommendations with what to do with unsafe code
116+
* JJ: We shouldn’t just focus on the unsafe keyword
117+
* AF: Deadlocks and checked/unchecked arithmetic are examples of stuff outside of this
118+
* WP: Would this committee want to bless Cargo Vet or create recommendations for crates?
119+
* PL: Getting involved with Cargo Vet is a good idea
120+
* PL: Niko expressed a [thought](https://github.com/rust-lang/rfcs/pull/3484#issuecomment-2039501484) to change the safe keyword to trusted in Rust 2027
121+
* JW: Addressing the unsafe keyword first is good idea until different certifications are published
122+
* DD: Different levels of assurance could be addressed by annotating guidelines with levels of severity
123+
* PL: It does make sense to categorize how unsafe each example and pattern would be
124+
125+
---
126+
127+
* OB: In MISRA, there is emphasis on making code easy to read and understand. It would be a good idea to get an idea of common misunderstandings and propose guidelines that address them, even if the itself isn’t exactly necessarily unsafe.
128+
* OB: Should we address these misunderstandings and create guidelines to avoid them?
129+
* PL: Computers execute the code, but humans read it. Indeed we want to put out code review guidelines for unsafe
130+
131+
### Adjournment
36132

37133
## Material
38134

39135
Any material to read before the meeting should be included here.
40-
41-
*

0 commit comments

Comments
 (0)