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

Remove "irtk" prefix from file names when headers are installed in "irtk" subdirectory #15

Open
schuhschuh opened this issue Dec 13, 2015 · 2 comments

Comments

@schuhschuh
Copy link
Member

This is a low priority issue. But generally I would like a project to choose either to prefix all (header) files with a project-specific prefix such as "irtk" and install the files in the top-level include directory, or use a meaningful subdirectory structure with the project name as top-level subdirectory. That is the current approach now for module header files and I prefer it as well. But in this case, I would like to get rid of the archaic "irtk" prefix in file and class names (after moving to an "irtk" namespace instead).

@schuhschuh schuhschuh changed the title Remove "irtk" prefix from source files names when headers are installed in "irtk" subdirectory Remove "irtk" prefix from file names when headers are installed in "irtk" subdirectory Dec 13, 2015
@ghisvail
Copy link
Member

Renaming the public headers implies breaking the inclusion API. Do we want users of existing code to have to change all their includes and use the appropriate namespace, only for cosmetic reason ? This is a decision not to be taken lightly, just saying.

@schuhschuh
Copy link
Member Author

Do we really have (m)any users of IRTK as a library? Because of this, we should make such decision now that we anyway break with the past by replacing entire modules with new implementations (i.e. transformation and registration...). The IRTK thus far has not been a library, but a collection of command-line tools. As noted at many occasions, now is the chance and time to restart this project with proper up-to-date best standards. There is no such thing as "backwards compatibility" here. We break it in any case. Many choices made for IRTK more than 10 years ago (e.g., to not use the const keyword as VTK does/did at the time) are as outdated as those for ITK <4 and VTK <6 were. And those much larger projects have decided to break backwards compatibility even though this affected a large user base. A user base the IRTK is just now hoping to attract.

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

No branches or pull requests

2 participants