Skip to content

docs: document cryptopp-modern + ENABLE_CCACHE + DEFAULT_VERSION_CHECK#181

Merged
got3nks merged 1 commit into
amule-org:mainfrom
got3nks:docs/cryptopp-modern-and-packager-flags
Jun 17, 2026
Merged

docs: document cryptopp-modern + ENABLE_CCACHE + DEFAULT_VERSION_CHECK#181
got3nks merged 1 commit into
amule-org:mainfrom
got3nks:docs/cryptopp-modern-and-packager-flags

Conversation

@got3nks

@got3nks got3nks commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Companion docs update for amule-org/amule#169 (merged) — brings the developer compilation pages in line with what landed in the source tree.

Changes

  • index.md: Crypto++ row in the Requirements table notes "classic or cryptopp-modern", with a follow-up paragraph naming both upstreams and explaining the auto-detection. Two new rows in the Build Options table:

    • ENABLE_CCACHE (AUTO/ON/OFF) — ccache as compiler launcher; OFF for distro builds that chain ccache themselves.
    • DEFAULT_VERSION_CHECK (ON/OFF) — initial state of the in-app "Check for new aMule version" preference; OFF for OS-package builds.
  • linux.md / bsd.md: the "Crypto++ version too old" troubleshooting block now offers cryptopp-modern as an alternative install path next to building classic Crypto++ from source.

What's not touched

  • macos.md — its Crypto++ troubleshooting is about Homebrew path discovery (CPATH), not version. No change needed.
  • windows.md — references the central index.md#build-options table; picks up the new rows automatically.

Brings the developer compilation docs in line with what landed in
amule-org/amule#169 (cryptopp-modern support + two packager-friendly
cmake flags).

* index.md: Crypto++ row in the Requirements table now notes "classic
  or cryptopp-modern", with a follow-up paragraph naming both upstreams
  and explaining the auto-detection. New rows in the Build Options
  table for `ENABLE_CCACHE` (AUTO/ON/OFF) and `DEFAULT_VERSION_CHECK`
  (ON/OFF).

* linux.md / bsd.md: troubleshooting section for "Crypto++ version too
  old" now mentions cryptopp-modern as an alternative install path.

Macos.md needs no change (its troubleshooting is about Homebrew path
discovery, not version). Windows.md just links back to the central
Build Options table and picks up the new rows automatically.
@got3nks got3nks merged commit 12a81b8 into amule-org:main Jun 17, 2026
2 checks passed
@got3nks got3nks deleted the docs/cryptopp-modern-and-packager-flags branch June 17, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant