From f0de6a4c909f33fbbf85aca3e126b3b57715f726 Mon Sep 17 00:00:00 2001 From: Zhuoyun Wei Date: Thu, 20 Jul 2017 12:52:52 -0400 Subject: [PATCH] Doc: add warning about changing segments_per_dir values --- docs/internals/data-structures.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/internals/data-structures.rst b/docs/internals/data-structures.rst index e9a98e023..dd7eaefd2 100644 --- a/docs/internals/data-structures.rst +++ b/docs/internals/data-structures.rst @@ -88,7 +88,10 @@ Segments ~~~~~~~~ Objects referenced by a key are stored inline in files (`segments`) of approx. -500 MB size in numbered subdirectories of ``repo/data``. +500 MB size in numbered subdirectories of ``repo/data``. The number of segments +per directory is controlled by the value of ``segments_per_dir``. If you change +this value in a non-empty repository, you may also need to relocate the segment +files manually. A segment starts with a magic number (``BORG_SEG`` as an eight byte ASCII string), followed by a number of log entries. Each log entry consists of: