From b17d7149d2e04e81dcc6e478caa72acbbbfd9af4 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Sat, 29 Dec 2018 17:38:50 +0100
Subject: [PATCH] src/catar/binary_search_tree.rs: improve docu

---
 src/catar/binary_search_tree.rs | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/catar/binary_search_tree.rs b/src/catar/binary_search_tree.rs
index 8f1f5dd0..c74d458a 100644
--- a/src/catar/binary_search_tree.rs
+++ b/src/catar/binary_search_tree.rs
@@ -19,14 +19,16 @@
 /// with strictly monotonically increasing indexes.
 ///
 /// Algorithm is from casync (camakebst.c), simplified and optimized
-/// for rust. Permutation function originally by L. Bressel, 2017.
-///
+/// for rust. Permutation function originally by L. Bressel, 2017. We
+/// pass permutation info to user provided callback, which actually
+/// implements the data copy.
 ///
 
 fn copy_binary_search_tree_inner<F:  FnMut(usize, usize)>(
     copy_func: &mut F,
+    // we work on input array input[o..o+n]
     n: usize,
-    o: usize, // Note: virtual offset for input array
+    o: usize,
     e: usize,
     i: usize,
 ) {