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

Decision: Make projects.h a private header after the next release? #543

Closed
kbevers opened this issue Jul 7, 2017 · 3 comments
Closed

Decision: Make projects.h a private header after the next release? #543

kbevers opened this issue Jul 7, 2017 · 3 comments
Assignees

Comments

@kbevers
Copy link
Member

kbevers commented Jul 7, 2017

I suggested on the mailing list that the projects.h header be made private after the next release. There was much debate, but no real conclusion. We need to make a decision before the next release, so that a potential removal of projects.h from the public API can be announced in the release notes.

There are two options:

  1. Leave it as is
  2. Make projects.h private

The discussion on the mailing list revealed that there are still a handful or two projects that rely on functions in projects.h. Various package maintainers recommended that nothing be changed. I, and a few others, on the other hand are in favour of removing projects.h from the public interface since it will enable us to change more things internally in PROJ.4. Additionally projects.h has been marked for internal use only for many years and it was even removed between version 4.8 and 4.9. I think it is fair to say that users of projects.h has been warned long enough already.
With the introduction of the new API in the next release we have the opportunity to bridge the gap between the functionality in projects.h and proj_api.h and create an API that is superior to both. We are already well on the way. Migration should be fairly simple in most cases.

@hobu, in the end this is your decision I think (hence the ticket assignment). Others should of course feel free to chime in with their opion.

@busstoptaktik
Copy link
Member

+1

@pl-nfwarmerdam
Copy link

I do not have any strong objection, but it will end up causing some pain to a few downstream projects. I would encourage loudly declaring this change in the release notes.

@kbevers
Copy link
Member Author

kbevers commented Feb 2, 2018

The decision has been made to remove projects.h with version 6.0.0. Has been announced in the release notes attached to PROJ 5.0.0RC1 that was just released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
2017 release
Decisions
Development

No branches or pull requests

4 participants