Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CMake: Do not install config.h, as it is not a public header file. #585

Closed

Conversation

besser82
Copy link
Contributor

@besser82 besser82 commented Apr 20, 2020

Installing this file will lead to clashes with applications, that link against json-c and include their own build-time config.h.
Anyways, that particular header file is not needed to build and link against json-c.

Likewise any public headers with generic names should be prefixed with json_c to avoid possible undesired clashes.


Please backport these commits to 0.14 as the current release may break building any apllication randomly for no obvious reason for this header file being present.

Installing this file will lead to clashes with applications, that
link against json-c and include their own build-time config.h.
Anyways, that particular header file is not needed to build and
link against json-c.
@coveralls
Copy link

coveralls commented Apr 20, 2020

Coverage Status

Coverage remained the same at 85.924% when pulling 759ccf6 on besser82:topic/besser82/config_h_no_public into ba45279 on json-c:master.

This done for the same reasons as we do not ship config.h.
This done for the same reasons as we do not ship config.h.
This done for the same reasons as we do not ship config.h.
This done for the same reasons as we do not ship config.h.
@besser82 besser82 force-pushed the topic/besser82/config_h_no_public branch from 4f62839 to 9a0c54e Compare April 20, 2020 04:22
This is done to avoid possible undesired clashes by too generic naming.
@hawicz
Copy link
Member

hawicz commented Apr 21, 2020

Excluding config.h is fine, but we can't do this with arraylist.h, printbuf.h nor linkhash.h. For better or for worse, they're part of the public API and have been for some time now. This would be a good item to put on the todo list for a major 1.0 release though.

@hawicz
Copy link
Member

hawicz commented Apr 21, 2020

hawicz added a commit that referenced this pull request Apr 21, 2020
hawicz added a commit that referenced this pull request Apr 21, 2020
(cherry picked from commit 8b511c4)
@hawicz
Copy link
Member

hawicz commented Apr 21, 2020

config.h is now excluded from install on master and the json-c-0.14 branch. Since that's the best we can do at the moment, I'm closing this.

@hawicz hawicz closed this Apr 21, 2020
@besser82 besser82 deleted the topic/besser82/config_h_no_public branch May 10, 2020 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants