From 802d67bf04b8f669acf4a73356d0911605074f89 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Tue, 14 Jan 2020 13:16:36 -0500 Subject: [PATCH] Use RFC language for opaque structs --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3abf82..aafc66a 100644 --- a/README.md +++ b/README.md @@ -422,15 +422,16 @@ Programmers **MUST alpha-sort their headers, and group by locality.** - First include external (`<>`) headers, then internal headers (`""`), then sort them alphabetically within their groups. -- Order-sensitive headers must be included all at once upfront, then followed +- Order-sensitive headers MUST be included all at once upfront, then followed by the remaining headers sorted according to the previous rule. - However, order-sensitive headers are to be generally avoided. + However, order-sensitive headers SHOULD NOT be used if possible. Programmers **SHOULD NOT include other headers.** -- If you need a struct with a defined storage type (for inlining), you may +- If you need a struct with a defined storage type (for inlining), you MAY include the header which defines it. -- If you need a struct to take a pointer to, forward declare an opaque struct. +- If you need a struct to take a pointer to, you SHOULD forward declare an + opaque struct. ```c struct my_struct; -- 2.45.2