Skip to content

Commit 3477f2f

Browse files
author
Julio Merino
committed
Prepare distribution documents for release
Set the release date of 0.1 to today and update the installation notes to match reality. This change was r33 in Subversion.
1 parent 4807006 commit 3477f2f

2 files changed

Lines changed: 30 additions & 6 deletions

File tree

INSTALL

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Optionally, if you want to build and run the tests (recommended), you
3838
need:
3939

4040
* Kyua 0.2 or greater.
41-
* ATF 0.14 or greater.
41+
* ATF 0.15 or greater.
4242

4343
If you are building Lutok from the code on the repository, you will also
4444
need the following tools:
@@ -127,6 +127,23 @@ The following flags are specific to Lutok's 'configure' script:
127127
detection features regardless of the value of this flag. However, such
128128
warnings are only fatal when --enable-developer is 'yes'.
129129

130+
* --with-atf
131+
Possible values: yes, no, auto.
132+
Default: auto.
133+
134+
Enables usage of ATF to build (and later install) the tests.
135+
136+
Setting this to 'yes' causes the configure script to look for ATF
137+
unconditionally and abort if not found. Setting this to 'auto' lets
138+
configure perform the best decision based on availability of ATF.
139+
Setting this to 'no' explicitly disables ATF usage.
140+
141+
When support for tests is enabled, the build process will generate the
142+
test programs and will later install them into the tests tree.
143+
Running 'make check' or 'make installcheck' from within the source
144+
directory will cause these tests to be run with Kyua (assuming it is
145+
also installed).
146+
130147
* --with-doxygen
131148
Possible values: yes, no, auto or a path.
132149
Default: auto.
@@ -140,15 +157,22 @@ The following flags are specific to Lutok's 'configure' script:
140157
setting this to a path forces configure to use a specific Doxygen
141158
binary, which must exist.
142159

160+
When support for Doxygen is enabled, the build process will generate
161+
HTML documentation for the Lutok API. This documentation will later
162+
be installed in the HTML directory specified by the configure script.
163+
You can change the location of the HTML documents by providing your
164+
desired override with the '--htmldir' flag to the configure script.
165+
143166

144167
Run the tests!
145168
==============
146169

147-
Lastly, after a successful installation, you should periodically run the
148-
tests from the final location to ensure things remain stable. Do so as
170+
Lastly, after a successful installation (and assuming you built the
171+
sources with support for ATF), you should periodically run the tests
172+
from the final location to ensure things remain stable. Do so as
149173
follows:
150174

151-
$ cd /usr/local/tests/lutok && kyua test
175+
$ kyua test -k /usr/local/tests/lutok/Kyuafile
152176

153177
And if you see any tests fail, do not hesitate to report them in:
154178

NEWS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Changes in version 0.1
22
======================
33

4-
STILL UNDER DEVELOPMENT; NOT RELEASED YET.
4+
Released on 2012/01/29.
55

6-
This is the first public release of the Lutok package.
6+
* This is the first public release of the Lutok package.

0 commit comments

Comments
 (0)