diff options
| author | crueter <crueter@eden-emu.dev> | 2025-12-31 17:16:46 +0100 |
|---|---|---|
| committer | crueter <crueter@eden-emu.dev> | 2025-12-31 17:16:46 +0100 |
| commit | 966fcc0c30d8ade96ebc795745d5b5af6111f83e (patch) | |
| tree | 7c1ef75fcffdd39864f09c359a88896aac38997c /docs/CPMUtil | |
| parent | 80327312dd981c8ec94588402dfe6ae410d679a5 (diff) | |
[cmake, docs, tools] update CPMUtil (#3183)
Rewrote the entire tooling scheme. That's about it, just make sure
tooling works as expected everywhere.
Signed-off-by: crueter <crueter@eden-emu.dev>
Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/3183
Reviewed-by: MaranBr <maranbr@eden-emu.dev>
Reviewed-by: CamilleLaVey <camillelavey99@gmail.com>
Reviewed-by: Lizzie <lizzie@eden-emu.dev>
Diffstat (limited to 'docs/CPMUtil')
| -rw-r--r-- | docs/CPMUtil/AddCIPackage | 17 | ||||
| -rw-r--r-- | docs/CPMUtil/README.md | 19 |
2 files changed, 16 insertions, 20 deletions
diff --git a/docs/CPMUtil/AddCIPackage b/docs/CPMUtil/AddCIPackage deleted file mode 100644 index 559db69ea9..0000000000 --- a/docs/CPMUtil/AddCIPackage +++ /dev/null @@ -1,17 +0,0 @@ -# AddPackage - -- `VERSION` (required): The version to get (the tag will be `v${VERSION}`) -- `NAME` (required): Name used within the artifacts -- `REPO` (required): CI repository, e.g. `crueter-ci/OpenSSL` -- `PACKAGE` (required): `find_package` package name -- `EXTENSION`: Artifact extension (default `tar.zst`) -- `MIN_VERSION`: Minimum version for `find_package`. Only used if platform does not support this package as a bundled artifact -- `DISABLED_PLATFORMS`: List of platforms that lack artifacts for this package. Options: - * `windows-amd64` - * `windows-arm64` - * `android` - * `solaris-amd64` - * `freebsd-amd64` - * `linux-amd64` - * `linux-aarch64` - * `macos-universal`
\ No newline at end of file diff --git a/docs/CPMUtil/README.md b/docs/CPMUtil/README.md index 8fe4df5237..3f0cb2c741 100644 --- a/docs/CPMUtil/README.md +++ b/docs/CPMUtil/README.md @@ -10,12 +10,13 @@ Global Options: You are highly encouraged to read AddPackage first, even if you plan to only interact with CPMUtil via `AddJsonPackage`. -<!-- TOC --> - [AddPackage](#addpackage) - [AddCIPackage](#addcipackage) - [AddJsonPackage](#addjsonpackage) - [Lists](#lists) -<!-- /TOC --> +- [For Packagers](#for-packagers) + - [Network Sandbox](#network-sandbox) + - [Unsandboxed](#unsandboxed) ## AddPackage @@ -43,4 +44,16 @@ For an example of how this might be implemented in an application, see Eden's im - [`dep_hashes.h.in`](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/src/dep_hashes.h.in) - [`GenerateDepHashes.cmake`](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CMakeModules/GenerateDepHashes.cmake) -- [`deps_dialog.cpp`](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/src/yuzu/deps_dialog.cpp)
\ No newline at end of file +- [`deps_dialog.cpp`](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/src/yuzu/deps_dialog.cpp) + +## For Packagers + +If you are packaging a project that uses CPMUtil, read this! + +### Network Sandbox + +For sandboxed environments (e.g. Gentoo, nixOS) you must install all dependencies to the system beforehand and set `-DCPMUTIL_FORCE_SYSTEM=ON`. If a dependency is missing, get creating! + +### Unsandboxed + +For others (AUR, MPR, etc). CPMUtil will handle everything for you, including if some of the project's dependencies are missing from your distribution's repositories. That is pretty much half the reason I created this behemoth, after all.
\ No newline at end of file |