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

Move examples to data-files section #2189

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

xsebek
Copy link
Member

@xsebek xsebek commented Oct 20, 2024

Otherwise, change to example would cause recompilation.

Otherwise, change to example would cause recompilation.
@xsebek xsebek requested review from kostmo and byorgey October 20, 2024 09:47
swarm.cabal Outdated
@@ -61,6 +60,7 @@ data-files:
test/standalone-topography/*.png
test/standalone-topography/*.yaml
worlds/*.world
example/*.sw
Copy link
Member Author

@xsebek xsebek Oct 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I guess we have it in extra-source-files because it is not in data directory?

Maybe we could workaround it by a symlink? EDIT: Or by inlining datadir to others as I did.

@byorgey
Copy link
Member

byorgey commented Oct 20, 2024

Can you explain in more detail? I'm not sure I understand the problem we're trying to solve here.

@xsebek
Copy link
Member Author

xsebek commented Oct 20, 2024

@byorgey, if you want to iterate on a swarm file in the example directory, Cabal will check each library to see if it needs recompiling because the example is listed in extra sources. At least, that is my hypothesis based on observation. 🙂

Copy link
Member

@byorgey byorgey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me. I think data-files get installed in a special location when cabal install runs, which is irrelevant for example, but I don't think it matters that much.

Copy link
Member

@byorgey byorgey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, actually, now I am not so sure. I think the reason the tests are failing is that they are looking for the example directory---which isn't there because only things listed in extra-source-files get unpacked into the source tree when building + running tests. That also means if someone does cabal get they will no longer get the example directory. extra-source-files actually seems like the right place for it.

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.

2 participants