diff options
| author | Mike Kaganski <mike.kaganski@collabora.com> | 2017-10-27 15:39:12 +0300 |
|---|---|---|
| committer | Stephan Bergmann <sbergman@redhat.com> | 2017-11-03 08:53:07 +0100 |
| commit | 646448dda41484dfa936f906356d7c58c8a28605 (patch) | |
| tree | 4a8ebea7315c643d3d2433579c0016803a862d1d /README.md | |
| parent | be2729b4b52d7aea51b847cd0e07dd1992196bf8 (diff) | |
loplugin:includeform: document the requirements
See commits acb3ed0615a1b4e31257fa1014e9e2f2188c602c and
189abcf0db61c41a565bd355294bf6e712fc3e5a, and mail thread
<https://lists.freedesktop.org/archives/libreoffice/2017-October/078601.html>
Change-Id: I2eea0b0a13bfe7f2919f36c94e76796b6a8cf122
Reviewed-on: https://gerrit.libreoffice.org/43945
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
Tested-by: Stephan Bergmann <sbergman@redhat.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
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 |