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.

Sign up for GitHub

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

Jump to bottom

DOC: add docs on using the build-dir config setting #616

Merged
merged 1 commit into from
May 16, 2024
Merged

DOC: add docs on using the build-dir config setting #616

merged 1 commit into from
May 16, 2024

Conversation

rgommers
Copy link
Contributor

Closes gh-540

Also touches on gh-246, which is a common enough hiccup that it's useful to explicitly show dealing with meson-log.txt in CI.

@rgommers rgommers added the documentation Improvements or additions to documentation label Apr 17, 2024
dnicolodi
dnicolodi previously requested changes Apr 17, 2024
View reviewed changes
Copy link
Member

@dnicolodi dnicolodi left a comment

Choose a reason for hiding this comment

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

Thanks @rgommers It is a very useful addition to the docs. I have a few stylistic comment and a remark regarding a limitation that is described but I don't think is there.

docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/how-to-guides/config-settings.rst Outdated Show resolved Hide resolved
docs/reference/config-settings.rst Show resolved Hide resolved
@rgommers rgommers added this to the v0.17.0 milestone May 2, 2024
@rgommers
Copy link
Contributor Author

rgommers commented May 2, 2024

Addressed all comments, I think this is ready now.

@rgommers
Copy link
Contributor Author

rgommers commented May 2, 2024

Cirrus is not happy. Can be ignored for this PR, since its docs-only.

@dnicolodi
Copy link
Member

@rgommers I find fixing prose via GitHub reviews not very efficient. I edited your text to make it flow better and pushed it to your branch. No conceptual changes intended. Please have a look.

@rgommers @dnicolodi
DOC: add docs on using the build-dir config setting
f56d087 
Closes mesonbuildgh-540

Also touches on mesonbuildgh-246, which is a common enough hiccup that it's
useful to explicitly show dealing with `meson-log.txt` in CI.
@henryiii
Copy link
Contributor

We could change the other places that have a pip version to use -C now, I think? (Not in this PR!)

@rgommers
Copy link
Contributor Author

We could change the other places that have a pip version to use -C now, I think? (Not in this PR!)

Agreed.

@rgommers rgommers dismissed dnicolodi’s stale review May 16, 2024 17:55

Proposed changes were pushed.

@rgommers
Copy link
Contributor Author

The rephrasings LGTM - time to get this in. Thanks @dnicolodi and @henryiii

@rgommers rgommers merged commit 0d2df77 into mesonbuild:main May 16, 2024
15 checks passed
@rgommers rgommers deleted the docs-builddir branch May 16, 2024 17:56
@rgommers rgommers mentioned this pull request May 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dnicolodi dnicolodi dnicolodi left review comments

@eli-schwartz eli-schwartz eli-schwartz left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.17.0
Development

Successfully merging this pull request may close these issues.

Document how to use a persistent build directory and associated caveats
4 participants
@rgommers @dnicolodi @henryiii @eli-schwartz