Attachment "tcllib.readme.patches" to
ticket [1784836fff]
added by
lvirden
2007-08-30 20:32:58.
--- README.bak Fri Jan 16 02:04:59 2004
+++ README Thu Aug 30 09:20:16 2007
@@ -44,5 +44,5 @@
[*] Possible forms: doctools, TMML/XML, nroff (man), or HTML.
- The first format is the most prefered as it can be processed with
+ The first format is the most preferred as it can be processed with
tools provided by tcllib itself (See module doctools). The first
- two are prefered in general as they are semantic markup and thus
+ two are preferred in general as they are semantic markup and thus
easier to convert into other formats.
--- README.developer.bak Sat Aug 25 02:09:50 2007
+++ README.developer Thu Aug 30 09:31:18 2007
@@ -12,3 +12,3 @@
-working on Tcllib to help him with his tasks, i.e. making them easier
+working on Tcllib to help him with his tasks, i.e. making the tasks easier
to perform. It is our hope that this will improve the quality of even
@@ -20,4 +20,4 @@
-The intended audience are first and foremost developers beginning to
-work on Tclib. To an experienced developer this document will be less
+The intended audience, are first and foremost, developers beginning to
+work on Tcllib. To an experienced developer this document will be less
of a guide and more of a reference. Anybody else interested in working
@@ -53,5 +53,5 @@
- * If available a/the testsuite(s) should use 'tcltest' and the
+ * If available, the testsuite(s) should use 'tcltest' and the
general format as used by the other modules in Tcllib
- (Declaration of minimally needed Tcl, tcltest, supporting
+ (declaration of minimally needed Tcl, tcltest, supporting
packages, etc.). The file(s) should have the extension
@@ -59,3 +59,3 @@
- * If available a/the testsuite(s) should use 'bench' and the
+ * If available, the testsuite(s) should use 'bench' and the
general format as used by the other modules in Tcllib. The
@@ -66,9 +66,10 @@
-(2) If the new module has an example applications A which is
- polished enough for general use put this application into the
+(2) If the new module has an example application A which is
+ polished enough for general use, put this application into the
file "T/apps/A.tcl", and its documentation into the file
- "T/apps/EA.man". The latter is optional.
+ "T/apps/A.man". While documentation for the application is optional,
+ it is preferred.
- For examples which are not full-fledged applications, or a
- skeleton, or not really polished for use, etc. create the
+ For examples which are not full-fledged applications, a
+ skeleton, or not really polished for use, etc., create the
directory T/examples/FOO/ and put them there.
@@ -80,7 +81,7 @@
whereas the applications are also for users of Tcllib which do
- not have an interest in developing for and with it. As such
- they are installed as regular binaries, acessible through the
- PATH, and examples are not.
+ not have an interest in developing for and with it. As such,
+ they are installed as regular commands, accessible through the
+ PATH, while example filess are not installed.
-(3) To make Tcllib's installer aware of FOO edit the file
+(3) To make Tcllib's installer aware of FOO, edit the file
@@ -129,3 +130,3 @@
To run the testsuite of a module FOO in tcllib use the 'test run'
-command of sak.tcl, like so:
+argument of sak.tcl, like so:
@@ -137,3 +138,3 @@
-To run the testsuites of all modules eiter invoke 'test run' without a
+To run the testsuites of all modules either invoke 'test run' without a
module name, or use 'make test'. The latter assumes that configure was
@@ -146,9 +147,9 @@
In all of the above cases the result will be a combination of progress
-display and testsuite log, showing for which modules tests failed and
-how many (summary at the end).
+display and testsuite log, showing for each module the tests that pass or
+failed and how many of each in a summary at the end.
-To get a detailed log it is necessary to invoke 'test run' with
+To get a detailed log, it is necessary to invoke 'test run' with
additional options.
-For one:
+First example:
% ./sak.tcl test run -l LOG FOO
@@ -159,3 +160,3 @@
-For two:
+Second example:
% ./sak.tcl test run -v FOO
@@ -164,3 +165,3 @@
This writes the detailed log to stdout, or to the file LOG, instead of
-the short log. In all cases the detailed log contains a list of all
+the short log. In all cases, the detailed log contains a list of all
test cases executed, which failed, and how they failed (expected
