This is an automated email from the ASF dual-hosted git repository. cmcfarlen pushed a commit to branch 10.0.x in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit 09ed8acfbde513144a57442bea38e8922ae0bf07 Author: Brian Neradt <[email protected]> AuthorDate: Mon Feb 26 14:18:26 2024 -0600 cmake README.md tweaks (#11098) Some updates to README.md for the ATS 10 release. (cherry picked from commit e381a5831514b4a3d267b11413973ed26b4eab0d) --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2f92efcfe1..be287c357c 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,11 @@ plugins to build large scale web applications. # Important notice to ATS developers -ATS is transitioning to cmake as its build system. At the moment, the autotools build is broken and will soon be removed from the repository. Below is a quick-start guide to cmake: +AS of version 10, ATS has transitioned to cmake as its build system. Below is a quick-start guide to building ATS with cmake: ### Step 1: Configuration -With cmake, you definitely want to create an out-of-source build. You will give that directory to every cmake command. For these examples, it will just be `build` +With cmake, you definitely want to create an out-of-source build. You will give that directory to every cmake command. For these examples, it will just be `build`. ``` $ cmake -B build @@ -46,7 +46,7 @@ $ ccmake build #### Specifying locations of dependencies -To specify the location of a dependency (like --with-*), you generally set a variable with the `ROOT`. The big exception to this is for openssl. This variable is called `OPENSSL_ROOT_DIR` +To specify the location of a dependency (like `--with-*` for autotools builds), you generally set a variable with the `ROOT`. The big exception to this is for openssl. This variable is called `OPENSSL_ROOT_DIR` ``` $ cmake -B build -Djemalloc_ROOT=/opt/jemalloc -DPCRE_ROOT=/opt/edge -DOPENSSL_ROOT_DIR=/opt/boringssl @@ -54,7 +54,7 @@ $ cmake -B build -Djemalloc_ROOT=/opt/jemalloc -DPCRE_ROOT=/opt/edge -DOPENSSL_R #### Using presets to configure the build -cmake has a feature for grouping configurations together to make configuration and reproduction easier. The file CMakePresets.json declares presets that you can use from the command line. You can provide your own CMakeUserPresets.json and further refine those via inheritance: +cmake has a feature for grouping configurations together to make configuration and reproduction easier. The file `CMakePresets.json` declares presets that you can use from the command line. You can provide your own `CMakeUserPresets.json` and further refine those via inheritance: ``` $ cmake --preset dev @@ -373,9 +373,8 @@ export LIB_FUZZING_ENGINE=-fsanitize=fuzzer ### Compile ```bash -mkdir -p build && cd build/ -cmake -DENABLE_POSIX_CAP=OFF -DENABLE_FUZZING=ON -DYAML_BUILD_SHARED_LIBS=OFF ../. -make -j$(nproc) +cmake -B build -DENABLE_POSIX_CAP=OFF -DENABLE_FUZZING=ON -DYAML_BUILD_SHARED_LIBS=OFF +cmake --build build ``` ## ADDITIONAL INFO
