From 0e10ff1aa3b524c621341284f887c2c92a763d82 Mon Sep 17 00:00:00 2001 From: Martin Tzvetanov Grigorov Date: Mon, 16 Jun 2025 09:21:47 +0300 Subject: [PATCH] docs: Recommend using a custom path for the benches' data This reduces the build time of the `benchmarks` crate from ~220secs to 45secs (according to `cargo build --timings`) on my dev machine Additionally I've introduced a parent folder for the Meili related cache paths - ~/.cache/meili Signed-off-by: Martin Tzvetanov Grigorov --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e129e5600..57d52116e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,9 +57,17 @@ This command will be triggered to each PR as a requirement for merging it. You can set the `LINDERA_CACHE` environment variable to speed up your successive builds by up to 2 minutes. It'll store some built artifacts in the directory of your choice. -We recommend using the standard `$HOME/.cache/lindera` directory: +We recommend using the `$HOME/.cache/meili/lindera` directory: ```sh -export LINDERA_CACHE=$HOME/.cache/lindera +export LINDERA_CACHE=$HOME/.cache/meili/lindera +``` + +You can set the `MILLI_BENCH_DATASETS_PATH` environment variable to further speed up your builds. +It'll store some big files used for the benchmarks in the directory of your choice. + +We recommend using the `$HOME/.cache/meili/benches` directory: +```sh +export MILLI_BENCH_DATASETS_PATH=$HOME/.cache/meili/benches ``` Furthermore, you can improve incremental compilation by setting the `MEILI_NO_VERGEN` environment variable.