From 646448dda41484dfa936f906356d7c58c8a28605 Mon Sep 17 00:00:00 2001 From: Mike Kaganski Date: Fri, 27 Oct 2017 15:39:12 +0300 Subject: loplugin:includeform: document the requirements See commits acb3ed0615a1b4e31257fa1014e9e2f2188c602c and 189abcf0db61c41a565bd355294bf6e712fc3e5a, and mail thread Change-Id: I2eea0b0a13bfe7f2919f36c94e76796b6a8cf122 Reviewed-on: https://gerrit.libreoffice.org/43945 Reviewed-by: Stephan Bergmann Tested-by: Stephan Bergmann --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') 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 -- cgit