summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3fe1dabac50d..fa614b033d38 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,16 @@ canvas/ | new (UNO) canvas rendering model with various backends
cppcanvas/ | C++ helper classes for using the UNO canvas
drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily.
+## Rules for #include directives (C/C++)
+
+Use the `"..."` form if and only if the included file is found next to the
+including file. Otherwise, use the `<...>` form. (For further details, see the
+mail [Re: C[++]: Normalizing include syntax ("" vs
+<>)](https://lists.freedesktop.org/archives/libreoffice/2017-November/078778.html).)
+
+The UNO API include files should consistently use double quotes, for the
+benefit of external users of this API.
+
## Finding out more