From 493020c0a6051757049c7d6ffc26c47667b82cc9 Mon Sep 17 00:00:00 2001 From: Austin Seipp Date: Thu, 28 Mar 2024 15:45:31 -0500 Subject: [PATCH] docs: add an entry for `snapshot.max-new-file-size` This was not documented, for some reason. Signed-off-by: Austin Seipp Change-Id: I01a86a2d62b225c0175ed690fe9966ed22c92745 --- docs/config.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/config.md b/docs/config.md index 7b9597b49..98cadc64e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -730,6 +730,29 @@ executable on your system](https://facebook.github.io/watchman/docs/install). You can check whether Watchman is enabled and whether it is installed correctly using `jj debug watchman status`. +## Snapshot settings + +### Maximum size for new files + +By default, as an anti-footgun measure, `jj` will refuse to add new files to the +snapshot that are larger than a certain size; the default is 1MiB. This can be +changed by setting `snapshot.max-new-file-size` to a different value. For +example: + +```toml +snapshot.max-new-file-size = "10MiB" +# the following is equivalent +snapshot.max-new-file-size = 10485760 +``` + +The value can be specified using a human readable string with typical suffixes; +`B`, `MiB`, `GB`, etc. By default, if no suffix is provided, or the value is a +raw integer literal, the value is interpreted as if it were specified in bytes. + +Files that already exist in the working copy are not subject to this limit. + +Setting this value to zero will disable the limit entirely. + ## Ways to specify `jj` config: details ### User config file