Diff of /README [473574] .. [ff7730] Maximize Restore

  Switch to unified view

a/README b/README
...
...
113
    $ python setup.py install
113
    $ python setup.py install
114
114
115
115
116
RUNNING DOCTESTS:
116
RUNNING DOCTESTS:
117
117
118
To run doctests on all *.py files in the pyke directory, cd to the pyke
118
Pyke uses the doctest-tools package to run its doctests.  You can run the
119
directory and:
119
"testall" program from doctest-tools in any subdirectory, or in the top-level
120
directory.  You can install doctest-tools with:
120
121
121
    $ ./testpyke
122
    $ sudo easy-install doctest-tools
122
123
123
To run doctests on the whole source directory, cd to the top-level directory
124
The top-level directory also has it's own "testall" script that removes all
124
and:
125
compiled_krb directories, then runs the standard testall scripts twice.  The
126
first time forces pyke to recompile everything, and the second time runs the
127
same tests again having pyke re-use the compiled results from the previous
128
run.  This "testall" program should not be on your path, so run it as:
125
129
126
    $ ./testall
130
    $ ./testall
131
132
to distinguish it from the "testall" program installed with doctest-tools.
127
133
128
134
129
COMPILING kfbparser_tables.py, krbparser_tables.py and scanner_tables.py:
135
COMPILING kfbparser_tables.py, krbparser_tables.py and scanner_tables.py:
130
136
131
    $ python
137
    $ python
132
    >>> from pyke.krb_compiler import kfbparser, krbparser, scanner
138
    >>> from pyke.krb_compiler import kfbparser, krbparser, scanner
133
    >>> scanner.init(scanner, 0, True)
139
    >>> scanner.init(scanner, 0, True)
134
    >>> krbparser.init(krbparser, True)
140
    >>> krbparser.init(krbparser, True)
135
    >>> kfbparser.init(kfbparser, True)
141
    >>> kfbparser.init(kfbparser, True)
136
142
137
    or just run testpyke:
143
    or just run the "testall" program from the doctest-tools package:
138
144
139
    $ cd pyke
145
    $ cd pyke/krb_compiler
140
    $ ./testpyke
146
    $ testall
141
147
142
148
143
COMPILING THE COMPILER.KRB FILE:
149
COMPILING THE COMPILER.KRB FILE:
144
150
145
In pyke/krb_compiler:
151
In pyke/krb_compiler:
146
152
147
    $ python
153
    $ PYTHONPATH=../.. python
148
    >>> from pyke import krb_compiler
154
    >>> from pyke import krb_compiler
149
    >>> krb_compiler.compile_krb('compiler', 'compiled_krb', 'compiled_krb', 'compiler.krb')
155
    >>> krb_compiler.compile_krb('compiler', 'compiled_krb', 'compiled_krb', 'compiler.krb')
150
    $ mv compiled_krb/compiler_bc.py .
156
    $ mv compiled_krb/compiler_bc.py .
151
157
152
COMPILING THE DOCUMENTATION:
158
COMPILING THE DOCUMENTATION:
...
...
180
    $ bin/gen_html
186
    $ bin/gen_html
181
187
182
This regenerates everything from doc/source into doc/html.  It takes about
188
This regenerates everything from doc/source into doc/html.  It takes about
183
9 seconds to run.
189
9 seconds to run.
184
190
185
If you want to run doctest on all of the *.txt files in doc/source:
191
If you want to run doctest on all of the *.txt files in doc/source, use the
192
"testall" program from the doctest-tools package:
186
193
187
    $ cd doc
194
    $ cd doc
188
    $ ./testdocs
195
    $ testall
189
196