doc: Add link to ccache docs for more description #29604

pull spicyzboss wants to merge 1 commits into bitcoin:master from spicyzboss:patch-3 changing 1 files +1 −1
  1. spicyzboss commented at 7:17 PM on March 8, 2024: contributor

    Add description link to base_dir option in ccache.

    Before <img width="1063" alt="image" src="https://github.com/bitcoin/bitcoin/assets/73651621/00128a0f-2fb0-4cea-86c7-4e50ebdc6571">

    After <img width="1065" alt="image" src="https://github.com/bitcoin/bitcoin/assets/73651621/ca4dcedd-2c7e-41c8-90df-0c538a3e1c9d">

  2. DrahtBot commented at 7:17 PM on March 8, 2024: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage

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

    <!--021abf342d371248e50ceaed478a90ca-->

    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.

  3. DrahtBot added the label Docs on Mar 8, 2024
  4. tdb3 commented at 9:28 PM on March 8, 2024: contributor

    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.
    
  5. tdb3 commented at 10:05 PM on March 8, 2024: contributor

    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.

  6. spicyzboss force-pushed on Mar 8, 2024
  7. doc: Add link to ccache docs for more description 3c327d0679
  8. spicyzboss force-pushed on Mar 8, 2024
  9. maflcko commented at 10:20 AM on March 11, 2024: member

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

  10. spicyzboss commented at 10:47 PM on March 12, 2024: contributor

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

  11. hernanmarino approved
  12. fanquake commented at 3:48 PM on June 25, 2024: member

    Thanks, however I think we'll leave this as-is.

  13. fanquake closed this on Jun 25, 2024

  14. bitcoin locked this on Jun 25, 2025

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me