Skip to content

Commit

Permalink
fix several typos (#127)
Browse files Browse the repository at this point in the history
Signed-off-by: Bernd Waibel <[email protected]>
  • Loading branch information
waebbl authored Mar 15, 2021
1 parent 6d14064 commit 5620697
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions docs/PortingGuide2-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,23 @@ Why is this happening? Here is the relevant history.
The OpenEXR project has historically consisted of four separate subprojects:

* OpenEXR - the Imf image format
* IlmBase - supporint utilities (Imath, Half, Iex, IlmThread)
* IlmBase - supporting utilities (Imath, Half, Iex, IlmThread)
* PyIlmBase - python bindings for the IlmBase libraries
* OpenEXR_Viewers - code for an example EXR image viewer

Prior to the 2.4 release in 2019, OpenEXR relied primarily on the Gnu
autotools build system and was released as four separate tarballs
(ilmbase, pyilmbase, openexr, openexr_viewers) that were constructed
via the Gnug tools. This gave direct access to the "IlmBase" libraries
indepdendent of the OpenEXR format library. The project also included
via the Gnu tools. This gave direct access to the "IlmBase" libraries
independent of the OpenEXR format library. The project also included
CMake files but CMake support was incomplete.

With the adoption of OpenEXR by the Academy Software Foundation in
2019, the technical steering committee made several key changes:

1. Drop support for autotools in favor of CMake. A significant portion
of the OpenEXR user base uses Windows, which the Gnu autotools does
no support. Supporting two build systems is a maintenance burden
not support. Supporting two build systems is a maintenance burden
that the TSC opted to avoid. We now assume that all modern users of
OpenEXR can reasonably be expected to rely on CMake.

Expand All @@ -59,7 +59,7 @@ With the adoption of OpenEXR by the Academy Software Foundation in
autotools setup.

3. Deprecate the OpenEXR_Viewers code. It was impossibly out of date
and of litle modern value.
and of little modern value.

Thus, with the 2.4 release, the "IlmBase" libraries are no longer
distributed in a form that is readily separable from the rest of
Expand All @@ -68,11 +68,11 @@ project is complicated by the fact it consists of four separate
projects, which added signifcant complexity to the CMake setup.

Because Imath is generally useful to the community, the TSC decided to
simply the configuration by separating Imath into its own indepdent
simplify the configuration by separating Imath into its own independent
project, maintained and released independently of OpenEXR, and
introducing it as a new external dependency of OpenEXR.

To further simply matters, the new Imath library includes the half
To further simplify matters, the new Imath library includes the half
data type directly, rather than maintaining it in a separate
library. Also, the community at large has a strong desire for simple
vector/matrix utilities that are unencumbered by Iex, the IlmBase
Expand All @@ -83,7 +83,7 @@ support for Iex has been removed from Imath, and the Iex library is
now packaged as a component of OpenEXR.

The Imath python bindings are a part of Imath as a configuration
option, although support is off by default to simply the build process
option, although support is off by default to simplify the build process
for most users.

## New Library Names and Repository Structures
Expand Down Expand Up @@ -181,7 +181,6 @@ Finding either/both packages:
endif ()
find_package(OpenEXR CONFIG)


To link against them, we use CMake generator expressions so that we can
reference *both* sets of targets, but it will only use the ones
corresponding to the package version that was found.
Expand All @@ -207,16 +206,16 @@ that you don't actually need for your application.

The OpenEXR 2.x CMake configuration had options to simultaneously
build both shared and statically linked libraries. This has been
deprecated. A CMake configuration setting specifics whether to build
deprecated. A CMake configuration setting specifies whether to build
static or shared, but if you want both, you will need to run cmake and
build twice.

### Simultaneous Python 2/3 Build

The PyIlmBase 2.x CMake configuration had options to simultaneously
build both both python2 and python3 bindings. This has been
deprecated. A CMake configuration setting specifics whether to build
for python 2 or python 3, but if you want both, you will need to run
build both python2 and python3 bindings. This has been deprecated.
A CMake configuration setting specifies whether to build for
python 2 or python 3, but if you want both, you will need to run
cmake and build twice.

## Imath Include Files Are in a Different Subdirectory
Expand Down Expand Up @@ -262,7 +261,6 @@ using a more complicated idiom:
# include <OpenEXR/half.h>
#endif


## Symbols Are Hidden by Default

To reduce library size and make linkage behavior similar across
Expand All @@ -283,12 +281,11 @@ correspond to the failure (e.g., `std::invalid_argument`,
now only part of the OpenEXR library (where they are still used in the same
manner they were for OpenEXR 2.x).

Imath 3.x has very few functions that throw exceptions. Each is are clearly
Imath 3.x has very few functions that throw exceptions. Each is clearly
marked as such, and each has a version that does not throw exceptions (so
that it may be used from code where exceptions are avoided). The functions
that do not throw exceptions are now marked `noexcept`.


## Some Headers and Classes Have Been Removed from Imath 3.x

* The `Math<T>` class (and `ImathMath.h` header file) are
Expand Down Expand Up @@ -470,7 +467,7 @@ Other changes:
### ImathVecAlgo.h

The following functions are no longer defined for integer-based
vecgtors, because such behavior is not clearly defined:
vectors, because such behavior is not clearly defined:

* `project (const Vec& s, const Vec& t)`

Expand Down Expand Up @@ -501,7 +498,7 @@ vecgtors, because such behavior is not clearly defined:
- `normalizedExc()`

- `normalizedNonNull()`

* Interoperability Constructors: The Vec and Matrix classes now have
constructors that take as an argument any data object of similar
size and layout.
Expand Down

0 comments on commit 5620697

Please sign in to comment.