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

Coqdoc flags --with-header and --with-footer should imply a dependency on the argument files #11017

Open
rlepigre opened this issue Oct 17, 2024 · 2 comments
Labels

Comments

@rlepigre
Copy link
Contributor

The --with-header and --with-footer arguments of coqdoc (specified via a (coqdoc_flags ...) thingy) have file argument that should be dependencies of all the generated documentation files. It appears that they are currently not considered dependencies, which means that the documentation is not recompiled when the header / footer files change. (And the situation is worse when using the cache.)

To work around this, I typically put these files in /tmp/some_folder/ using a wrapper makefile, and disable the cache. However, this leads to very long building times that could otherwise mostly hit the cache.

@maiste maiste added the coq label Oct 17, 2024
@ejgallego
Copy link
Collaborator

That should be really easy to fix, I wonder tho if dune can support having (coqdoc_flags (--with-header=%{dep:foo.html})) directly?

Fix can be either by:

  • analizing the flags and injecting the deps
  • adding / refining a new field for the header options

@Alizter
Copy link
Collaborator

Alizter commented Nov 13, 2024

I would suggest adding a new field for these kinds of options. The general coqdoc_flags field can be thought of as a last-resort tweak for features unsupported. Having a dedicated fields will allow you to unambiguously expand passed arguments by using all the stanza magic we have in dune.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants