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: Add link to ccache docs for more description #29604

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

spicyzboss
Copy link
Contributor

@spicyzboss spicyzboss commented Mar 8, 2024

Add description link to base_dir option in ccache.

Before
image

After
image

@DrahtBot
Copy link
Contributor

DrahtBot commented Mar 8, 2024

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type Reviewers
Concept ACK tdb3

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

@DrahtBot DrahtBot added the Docs label Mar 8, 2024
@tdb3
Copy link
Contributor

tdb3 commented Mar 8, 2024

Concept ACK.
Seems beneficial to add clarification.

nit: In case the link to the ccache doc goes stale, perhaps also include the rationale from it directly in productivity.md (although I can also appreciate deferring to ccache docs for specifics because it's not Bitcoin's task to maintain other project documentation).

You _must not_ set base_dir to "/", or anywhere that contains system headers (according to the [ccache docs](https://ccache.dev/manual/latest.html#_configuration_options)), since doing this will make ccache also rewrite paths to system header files, which typically is counterproductive.

@tdb3
Copy link
Contributor

tdb3 commented Mar 8, 2024

Rather than change the same line in two commits, it would be better to squash those commits. (See https://github.com/tdb3/toolbox/blob/main/git/commitSquashExample.md for an example). This way the commit log is cleaner.

@maflcko
Copy link
Member

maflcko commented Mar 11, 2024

Not sure. Is it really that hard to use a search engine? https://duckduckgo.com/?q=base_dir+ccache+docs

@spicyzboss
Copy link
Contributor Author

I guess the explanation with link seems to make docs more complete

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

Successfully merging this pull request may close these issues.

None yet

5 participants