[tor-commits] [tor/master] Add notes about OS support for our scheduler types

[nickm at torproject.org]

commit 3537f7801dbf6f72e641e7fe1430db755ee5b920
Author: Matt Traudt <sirmatt at ksu.edu>
Date:   Thu Nov 16 09:21:12 2017 -0500

    Add notes about OS support for our scheduler types
---
 changes/ticket24254 | 3 +++
 doc/tor.1.txt       | 8 +++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/changes/ticket24254 b/changes/ticket24254
new file mode 100644
index 000000000..80dd74125
--- /dev/null
+++ b/changes/ticket24254
@@ -0,0 +1,3 @@
+  o Documentation:
+    Add notes in man page regarding OS support for the various scheduler types.
+    Closes ticket 24254.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f05246433..f627659f5 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -801,14 +801,16 @@ GENERAL OPTIONS
  +
     **KIST**: Kernel Informed Socket Transport. Tor will use the kernel tcp
     information stack per-socket to make an informed decision on if it should
-    send or not the data. (Only available on Linux)
+    send or not the data. As implemented, KIST will only work on Linux kernel
+    version 2.6.39 or higher.
  +
     **KISTLite**: Same as KIST but without kernel support which means that tor
     will use all the same mecanics as KIST but without the TCP information the
-    kernel can provide.
+    kernel can provide. KISTLite will work on all kernels and operating
+    systems.
  +
     **Vanilla**: The scheduler that tor has always used that is do as much as
-    possible or AMAP.
+    possible or AMAP. Vanilla will work on all kernels and operating systems.
 
 [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**::
     If KIST or KISTLite is used in Schedulers option, this control at which