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

doc: explain cookbooks/check.mk #5273

Merged
merged 1 commit into from Jul 14, 2023

Conversation

tjhei
Copy link
Member

@tjhei tjhei commented Jul 12, 2023

fixes #5232

Copy link
Member

@gassmoeller gassmoeller left a comment

Choose a reason for hiding this comment

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

👍

@gassmoeller
Copy link
Member

Indent wants to replace the tabs with spaces in the documentation. Not sure what to do about that.

at the end of the document, which will compile a plugin found in
`free_surface_with_crust/plugin/` and then run `test.prm` in the
folder `free_surface_with_crust/`. Feel free to ask for help in your
pull request.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
pull request.
pull request.
:::{note}
The `make` program has a peculiar format where the indented rows in the snippets above consist of exactly one tab character, rather than eight spaces. This does not translate to what is shown above, but `make` will generate difficult-to-read error messages if you use spaces instead of the required tab.
:::

@tjhei
Copy link
Member Author

tjhei commented Jul 13, 2023

Thanks. Updated.

spaces instead of the required tab.
:::

Finally, you will get bonus points if you also create a test (see
Copy link
Member

Choose a reason for hiding this comment

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

nice!

@MFraters MFraters merged commit b1033f2 into geodynamics:main Jul 14, 2023
6 checks passed
@tjhei tjhei deleted the doc-cookbook-benchmark branch July 14, 2023 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document what to do with check.mk when writing new cookbooks
4 participants