aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2025-11-07 14:49:13 +0100
committerGitHub Enterprise <[email protected]>2025-11-07 14:49:13 +0100
commit24e43a913f29ac3b314354e8ce5175f135bcc64f (patch)
treeca442937ceeb63461012b33a4576e9835099f106 /docs
parentget oplog attachments (#622) (diff)
downloadzen-24e43a913f29ac3b314354e8ce5175f135bcc64f.tar.xz
zen-24e43a913f29ac3b314354e8ce5175f135bcc64f.zip
switch to xmake for package management (#611)
This change removes our dependency on vcpkg for package management, in favour of bringing some code in-tree in the `thirdparty` folder as well as using the xmake build-in package management feature. For the latter, all the package definitions are maintained in the zen repo itself, in the `repo` folder. It should now also be easier to build the project as it will no longer depend on having the right version of vcpkg installed, which has been a common problem for new people coming in to the codebase. Now you should only need xmake to build. * Bumps xmake requirement on github runners to 2.9.9 to resolve an issue where xmake on Windows invokes cmake with `v144` toolchain which does not exist * BLAKE3 is now in-tree at `thirdparty/blake3` * cpr is now in-tree at `thirdparty/cpr` * cxxopts is now in-tree at `thirdparty/cxxopts` * fmt is now in-tree at `thirdparty/fmt` * robin-map is now in-tree at `thirdparty/robin-map` * ryml is now in-tree at `thirdparty/ryml` * sol2 is now in-tree at `thirdparty/sol2` * spdlog is now in-tree at `thirdparty/spdlog` * utfcpp is now in-tree at `thirdparty/utfcpp` * xmake package repo definitions is in `repo` * implemented support for sanitizers. ASAN is supported on windows, TSAN, UBSAN, MSAN etc are supported on Linux/MacOS though I have not yet tested it extensively on MacOS * the zencore encryption implementation also now supports using mbedTLS which is used on MacOS, though for now we still use openssl on Linux * crashpad * bumps libcurl to 8.11.0 (from 8.8.0) which should address a rare build upload bug
Diffstat (limited to 'docs')
-rw-r--r--docs/xmake.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/xmake.md b/docs/xmake.md
new file mode 100644
index 000000000..501d5d170
--- /dev/null
+++ b/docs/xmake.md
@@ -0,0 +1,46 @@
+# xmake notes and tips and tricks
+
+We use xmake to build code in this tree. We also use xmake to handle some of our third-party dependencies which are
+not in the tree.
+
+This document is intended as a basic guide on how to accomplish some common things when working with the Zen codebase.
+
+The official documentation for xmake is located here: https://xmake.io/ it covers most features but isn't
+necessarily rich in examples on how to accomplish things on different platforms and environments.
+
+# Build basics
+
+xmake is what I'd call a "stateful" build system in that there is a 'configuration' step which you
+will generally want to run before actually building the code. This allows you to specify which
+mode you want to build (in our case, "debug" or "release"), and also allows you to perform additional
+configuration of options such as whether we should include support for Sentry crash reporting, use
+of 'mimalloc' for memory allocations etc etc
+
+Configure xmake for building 'debug' (which includes building all third-party packages) and
+triggering a build, issue these commands in the shell:
+
+```
+dev/zen> xmake config --mode=debug
+dev/zen> xmake
+```
+
+If all goes well, you will be able to run the compiled programs using:
+
+```
+dev/zen> xmake run zenserver
+dev/zen> xmake run zen
+```
+
+# Cleaning out *all* build state
+
+## Windows
+
+```
+dev\zen> rmdir /s /q .xmake build %LOCALAPPDATA%\.xmake %TEMP%\.xmake
+```
+
+## Linux / MacOS
+
+```
+dev/zen> rm -rf .xmake build ~/.xmake
+```