Skip to content

Commit ea7acf5

Browse files
committed
Add note about local header #include to install.rst
Signed-off-by: Cary Phillips <cary@ilm.com>
1 parent 6998681 commit ea7acf5

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

website/install.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,18 @@ include directories above; a single ``-I$prefix/include`` without the
145145

146146
This layout preserves long-standing flat includes in existing code and
147147
documentation while keeping headers grouped under ``OpenEXR/`` on
148-
disk. There is no plan to remove either style in current release lines.
148+
disk. There is no plan to remove either style in current release
149+
lines.
150+
151+
Also note that within the OpenEXR source tree, all local headers are
152+
included with quotes, i.e. ``#include "ImfHeader.h"``, not angle
153+
brackets ``<>``, since for an internal build the headers come from the
154+
same library tree. Also note that since headers are stored alongside
155+
source files in each internal library directory (``OpenEXR``,
156+
``OpenEXRCore``, ``OpenEXRUtil``, ``Iex``, ``IlmThread``), not in a
157+
single common ``OpenEXR`` folder, they are included internally as bare
158+
files, without a ``OpenEXR/`` subdirectory. This intentionally differs
159+
from the installed layout.
149160

150161
OpenEXR/Imath Version Compatibility
151162
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)