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

[Feature Request]: should mason doc add /doc to .gitignore #25015

Open
jeremiah-corrado opened this issue May 8, 2024 · 1 comment
Open

[Feature Request]: should mason doc add /doc to .gitignore #25015

jeremiah-corrado opened this issue May 8, 2024 · 1 comment

Comments

@jeremiah-corrado
Copy link
Contributor

jeremiah-corrado commented May 8, 2024

The mason doc command uses chpldoc to generate docs for the project, storing the html in a /doc directory.

Like the project's binaries in the /target directory, the docs aren't something the user necessary wants to commit to their repo. Should mason automatically add /doc to the project's .gitignore (either when creating the project or generating the docs)?

Note that we already to this for /target.

(alternatively, we could put the /doc directory in /target to avoid this issue)

@lucaferranti
Copy link
Contributor

I think having mason include the /doc in the .gitignore when creating the project would indeed be very nice. Having mason doc modify and existing .gitignore sounds maybe a bit riskier or at least proner to issues?

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

No branches or pull requests

3 participants