changeset 740:1d741230801b

Document viff.util.rand and some environment variables.
author Martin Geisler <mg@daimi.au.dk>
date Fri, 25 Apr 2008 14:16:08 +0200
parents 1f60fba69309
children 16035b12d7ae
files doc/util.txt
diffstat 1 files changed, 21 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/util.txt	Fri Apr 25 09:27:18 2008 +0200
+++ b/doc/util.txt	Fri Apr 25 14:16:08 2008 +0200
@@ -4,3 +4,24 @@
 
 .. automodule:: viff.util
    :members:
+
+   .. envvar:: SEED
+
+      The :data:`rand` random generator is seeded using this
+      environment variable, if it is defined.
+
+   .. data:: rand
+
+      All VIFF code uses this random number generator for all
+      randomness needed.
+
+      The generator is by default initialized with a random seed,
+      unless the environment variable :envvar:`SEED` is set to a
+      value, in which case that value is used instead. If
+      :envvar:`SEED` is defined, but empty, then no seed is used and a
+      protocol run cannot be reproduced exactly.
+
+   .. envvar:: VIFF_NO_WRAP
+
+      Setting this environment variable to any value will turn
+      :func:`wrapper` into a no-op.