[master] 830151a Adhere to style manual

Lasse Karstensen lkarsten at varnish-software.com
Thu Mar 20 17:37:15 CET 2014

commit 830151a85ef4a65b9278c6005c6834257151aa21
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date:   Thu Mar 20 17:36:28 2014 +0100

    Adhere to style manual

diff --git a/doc/sphinx/installation/platformnotes.rst b/doc/sphinx/installation/platformnotes.rst
index 7f11eaa..0eca96f 100644
--- a/doc/sphinx/installation/platformnotes.rst
+++ b/doc/sphinx/installation/platformnotes.rst
@@ -12,9 +12,10 @@ Transparent hugepages on Redhat Enterprise Linux 6
 On RHEL6 Transparent Hugepage kernel support is enabled by default.
 This is known to cause sporadic crashes of Varnish.
-It is recommended to disable transparent hugepages on affected systems::
-    $ echo "never" > /sys/kernel/mm/redhat_transparent_hugepage/enabled
+It is recommended to disable transparent hugepages on affected systems. This
+can be done with 
+``echo "never" > /sys/kernel/mm/redhat_transparent_hugepage/enabled`` (runtime) and changes to
+`/etc/sysctl.conf` (persisted.)
 On Debian/Ubuntu systems running 3.2 kernels the default value is "madvise" and
 does not need to be changed.
@@ -34,11 +35,8 @@ the maximum stack size before starting Varnish.
 The default allocates too much memory per thread, which will make Varnish fail
 as soon as the number of threads (traffic) increases.
-Reduce the maximum stack size by running::
-    ulimit -s 256
-in the Varnish startup script.
+Reduce the maximum stack size by adding ``ulimit -s 256`` before starting
+Varnish in the init script.
 TCP keep-alive configuration
diff --git a/doc/sphinx/installation/prerequisites.rst b/doc/sphinx/installation/prerequisites.rst
index 7ef0bd7..05aea31 100644
--- a/doc/sphinx/installation/prerequisites.rst
+++ b/doc/sphinx/installation/prerequisites.rst
@@ -1,7 +1,6 @@
 In order for you to install Varnish you must have the following:
   * A recent, preferably server grade, computer.

More information about the varnish-commit mailing list