Move disted but non-public headers to "detail" subdirectory #2648
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Policy change: There are some headers that we just have to make part of the OIIO distribution, but they aren't officially part of the supported OIIO public API. We are moving them into an include/OpenImageIO/detail subdirectory. Anything in there is, therefore, allowed to be changed arbitrarily for any minor version numbered release, including source back-incompatible changes that would ordinarily require a change in major release version if they were part of the public API. They nonetheless cannot change in patch releases in ways that would break ABI or linkage. Initially, this includes the imported headers from fmt and pugixml, but in possible subsequent patches, I may move other headers there, or split some headers to have declarations be public but certain inline implementation details split into separate files in detail. We were also able to move SHA1.h out of the public include area and locally into libutil, since it should only be needed by SHA1.cpp. It was also used by imagebufalgo_compiler.cpp, but didn't need to be, so we changed the direct use into use of the hash.h wrapper. Also add a build_pugixml.bash to make it easier for people to install that dependency. We will eventually migrate to a fully external pugixml, but right now old versions of OSL depend on it being part of OIIO. We'll change on the OIIO side after another release. Signed-off-by: Larry Gritz <lg@larrygritz.com>
Signed-off-by: Larry Gritz <lg@larrygritz.com>
fpsunflower
approved these changes
Jul 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Policy change:
There are some headers that we just have to make part of the OIIO
distribution, but they aren't officially part of the supported OIIO
public API. We are moving them into an include/OpenImageIO/detail
subdirectory.
Anything in there is, therefore, allowed to be changed arbitrarily for
any minor version numbered release, including source back-incompatible
changes that would ordinarily require a change in major release
version if they were part of the public API. They nonetheless cannot
change in patch releases in ways that would break ABI or linkage.
Initially, this includes the imported headers from fmt and pugixml,
but in possible subsequent patches, I may move other headers there, or
split some headers to have declarations be public but certain inline
implementation details split into separate files in detail.
We were also able to move SHA1.h out of the public include area and
locally into libutil, since it should only be needed by SHA1.cpp.
It was also used by imagebufalgo_compiler.cpp, but didn't need to be,
so we changed the direct use into use of the hash.h wrapper.
Also add a build_pugixml.bash to make it easier for people to install
that dependency. We will eventually migrate to a fully external
pugixml, but right now old versions of OSL depend on it being part of
OIIO. We'll change on the OIIO side after another release.
Signed-off-by: Larry Gritz lg@larrygritz.com