diff --git a/Download-Types.md b/Download-Types.md index f7dab64..e13b5cf 100644 --- a/Download-Types.md +++ b/Download-Types.md @@ -1,4 +1,6 @@ -`repertory` supports 3 different types of downloads for files. The `PreferredDownloadType` setting in `config.json` determines which of these modes is preferred. This does not guarantee the mode will always be chosen, as `repertory` will choose an appropriate mode based on the type of file operation being performed. If a file is currently open in read mode and a request to write is performed, `repertory` will automatically switch to `default` mode without any interruptions to file i/o. +`repertory` supports 3 different types of downloads for files: `direct`, 'ring_buffer`, and `direct`. + +The `PreferredDownloadType` setting in `config.json` determines which of these modes is preferred. This does not guarantee the mode will always be chosen, as `repertory` will choose an appropriate mode based on the type of file operation being performed. If a file is currently open in read mode and a request to write is performed, the file will automatically be changed to `default` mode without any interruptions to file i/o. 1. Default * In `default' mode, a file of equal size is allocated in the`cache` directory. @@ -6,8 +8,8 @@ * This mode will be forced if any request to write is performed. * This mode supports read and write. -2. Ring-buffer - * In `ring-buffer` mode, a fixed-size file (default 1GiB) is allocated within the `buffer` directory. +2. Ring buffer + * In `ring_buffer` mode, a fixed-size file (default 1GiB) is allocated within the `buffer` directory. * This mode will cache up to 1GiB of a file locally preventing the need to fully allocate a file for read operations. * This mode is only chosen when the actual file size is greater than the ring-buffer size. * This mode only supports read.