summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Ã…dahl <jadahl@gmail.com>2021-03-09 20:40:39 +0100
committerMarge Bot <marge-bot@gnome.org>2021-03-09 20:52:16 +0000
commitdcbd96df38f69b10e6ad9eb213c89f5193240381 (patch)
tree242dcdaeb1dce874f91e7ea74a9763cbaf192ccd
parent86435d88a24dc534dd6eb9ea3ea6d1d240d304d9 (diff)
downloadmutter-dcbd96df38f69b10e6ad9eb213c89f5193240381.tar.gz
README: Clarify how to name flag types
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1765>
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index cedaf25b4..d57296a7c 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,16 @@ with some additions:
that may have side effects.
- Instead of boolean arguments in functions, prefer enums or flags when
- they're more expressive.
+ they're more expressive. The naming convention for flags is
+
+```c
+typedef _MetaSomeThingFlags
+{
+ META_SOME_THING_FLAG_NONE = 0,
+ META_SOME_THING_FLAG_ALTER_REALITY = 1 << 0,
+ META_SOME_THING_FLAG_MANIPULATE_PERCEPTION = 1 << 1,
+} MetaSomeThingFlags;
+```
- Use `g_new0()` etc instead of `g_slice_new0()`.