summaryrefslogtreecommitdiff
path: root/crates/arti/src/arti-example-config.toml
diff options
context:
space:
mode:
Diffstat (limited to 'crates/arti/src/arti-example-config.toml')
-rw-r--r--crates/arti/src/arti-example-config.toml21
1 files changed, 16 insertions, 5 deletions
diff --git a/crates/arti/src/arti-example-config.toml b/crates/arti/src/arti-example-config.toml
index 4d80738c7..1ce4770ed 100644
--- a/crates/arti/src/arti-example-config.toml
+++ b/crates/arti/src/arti-example-config.toml
@@ -473,15 +473,26 @@
#max_files = 16384
# Are we limiting memory use and if so to how much?
-# The default is unlimited.
#
-# Maximum memory use, after which reclamation starts:
+# Maximum memory use, after which reclamation starts.
+#
+# The default is "auto", which uses a value derived from the total system
+# memory. It should not be assumed that the value used for "auto" will remain
+# stable across different versions of arti. The value used for "auto" may also
+# take into account other OS-specific features, such as cgroups on Linux.
+#
+# If `system.memory.low_water` is given as an explicit value,
+# `system.memory.max` must also be given as an explicit value.
+#
# memory.max = "8 GiB"
-# (If anything is specified in `[system.memory]`, this value is mandatory.)
#
-# When reclaiming memory, we stop when we reach this amount:
+# When reclaiming memory, we stop when we reach this amount.
+#
+# The default is "auto", which uses 3/4 of `system.memory.max`. It should not be
+# assumed that the value used for "auto" will remain stable across different
+# versions of arti.
+#
# memory.low_water = "6 GiB"
-# (The default is 3/4 of `system.memory.max`.)
##### ONION SERVICES
#