From 32cfd712d066fdc674d2fe8165b2df8eb5476439 Mon Sep 17 00:00:00 2001 From: Etienne Dechamps Date: Sun, 13 Oct 2024 14:35:32 +0100 Subject: [PATCH] Clarify file order and indexes (#7120) See the discussion in #5578. I don't think anyone would expect otherwise, but it doesn't hurt to be explicit. --- docs/rpc-spec.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/rpc-spec.md b/docs/rpc-spec.md index 0cdbdf77e..326ab52a9 100644 --- a/docs/rpc-spec.md +++ b/docs/rpc-spec.md @@ -300,8 +300,9 @@ The 'source' column here corresponds to the data structure there. | `beginPiece` | number | tr_file_view | `endPiece` | number | tr_file_view +Files are returned in the order they are laid out in the torrent. References to "file indices" throughout this specification should be interpreted as the position of the file within this ordering, with the first file bearing index 0. -`fileStats`: a file's non-constant properties. An array of `tr_info.filecount` objects, each containing: +`fileStats`: a file's non-constant properties. An array of `tr_info.filecount` objects, in the same order as `files`, each containing: | Key | Value Type | transmission.h source |:--|:--|:--