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

include_src ok but what about include_include ? #99

Closed
opensam opened this issue Dec 3, 2013 · 4 comments
Closed

include_src ok but what about include_include ? #99

opensam opened this issue Dec 3, 2013 · 4 comments

Comments

@opensam
Copy link

opensam commented Dec 3, 2013

Hello,

I'm new to relx. It seems cool. Thanks.
I've {include_src, false}. in my relx config.
After building the release the "src" directory and its content are not included as expected.
I have also {i, "include"} in erl_opts in rebar.config . After building the release the "include" directory and its source content is packaged in the release. I didn't expect that as I think included src is src.
Is this an issue with {include_src, false} ?

Have fun

@opensam
Copy link
Author

opensam commented Jan 21, 2014

Gentle bump. Any thoughts about not including "include" when not including "src" ?

@tsloughter
Copy link
Member

@ericbmerritt what do you think?

@ericbmerritt
Copy link
Member

@opensam in general the 'include' directory is where you put your public include files. That is, the include files that must be available to work with your library. If you are publishing something that is not designed to be a library, the include directory should be empty. This comes down to the expected use of that directory.

It is expected that you will put private include files (those you use internally for your app) into the src directory with the rest of your source files. Your public include files, those that are part of your API go in the include directory.

With that in mind if we didn't include the 'include' directory, even when the src directory is excluded, we would break things.

@opensam
Copy link
Author

opensam commented Jan 21, 2014

Thank you for explaining. I think my (private) "include" is badly located and I should move it to "src/include".
Thanks Tristan & Eric.

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

3 participants