summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Traudt <sirmatt@ksu.edu>2017-11-16 09:21:12 -0500
committerNick Mathewson <nickm@torproject.org>2017-11-17 09:25:01 -0500
commit3537f7801dbf6f72e641e7fe1430db755ee5b920 (patch)
tree287fdf2beaf0f81c459d03b7afb2624b5ff06752
parent85778dc92d652e4781812659590099ae9232e175 (diff)
downloadtor-3537f7801dbf6f72e641e7fe1430db755ee5b920.tar.gz
tor-3537f7801dbf6f72e641e7fe1430db755ee5b920.zip
Add notes about OS support for our scheduler types
-rw-r--r--changes/ticket242543
-rw-r--r--doc/tor.1.txt8
2 files changed, 8 insertions, 3 deletions
diff --git a/changes/ticket24254 b/changes/ticket24254
new file mode 100644
index 0000000000..80dd74125f
--- /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 f052464332..f627659f55 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