viff

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 diff
     1.1 --- a/doc/util.txt	Fri Apr 25 09:27:18 2008 +0200
     1.2 +++ b/doc/util.txt	Fri Apr 25 14:16:08 2008 +0200
     1.3 @@ -4,3 +4,24 @@
     1.4  
     1.5  .. automodule:: viff.util
     1.6     :members:
     1.7 +
     1.8 +   .. envvar:: SEED
     1.9 +
    1.10 +      The :data:`rand` random generator is seeded using this
    1.11 +      environment variable, if it is defined.
    1.12 +
    1.13 +   .. data:: rand
    1.14 +
    1.15 +      All VIFF code uses this random number generator for all
    1.16 +      randomness needed.
    1.17 +
    1.18 +      The generator is by default initialized with a random seed,
    1.19 +      unless the environment variable :envvar:`SEED` is set to a
    1.20 +      value, in which case that value is used instead. If
    1.21 +      :envvar:`SEED` is defined, but empty, then no seed is used and a
    1.22 +      protocol run cannot be reproduced exactly.
    1.23 +
    1.24 +   .. envvar:: VIFF_NO_WRAP
    1.25 +
    1.26 +      Setting this environment variable to any value will turn
    1.27 +      :func:`wrapper` into a no-op.