Remove unconventional location for header files #54
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.
This PR is an alternative approach to #49.
The rationale for this solution is that moving the file, instead of aliasing it, is a much simpler approach and it makes the code base use a more conventional inclusion pattern. While having sub-directories within
include
and including headers with `-include('my_dir/my_header.hrl') technically works in OTP, it's a non conventional choice that makes it harder to include the file from external applications. Tools such as Erlang LS may require additional tweaking by the user to get code navigation and other features working with the code base, too.Breaking backward compatibility is probably not a big deal in this case, given that the header file was explicitly marked as internal in the previous implementation. Making the move explicit would also allow users to immediately spot (and correct) the difference at compile time and take the opportunity to cleanup extra paths and directories in their configuration which were only present due to the current setup. So, it feels like a step in the right direction.