Skip to content

Commit 5ec2e50

Browse files
committed
ED: description improved
1 parent f4df0a7 commit 5ec2e50

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

doc/devel.txt

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# SID @(#) devel.txt 3.7 25/03/12 18:27:14
2+
# SID @(#) devel.txt 3.8 25/03/18 13:17:45
33

44

55
NAME
@@ -17,7 +17,11 @@ DESCRIPTION
1717
This is about hints and tricks for debugging, tracing and testing. It
1818
is the documentation for development!
1919

20-
For user documentation please refer to help.txt or use:.
20+
For a brief introduction to user testing please see:
21+
22+
$0 --help=test
23+
24+
For complete user documentation please refer to help.txt or use:
2125

2226
$0 --help
2327
$0 --help=HELP
@@ -52,8 +56,7 @@ DESCRIPTION
5256

5357
OVERVIEW
5458

55-
Using make for development uses additional external tools and/or Perl
56-
to get an overview about source, functions, methods and descriptions.
59+
To get an overview about source, functions, methods and descriptions.
5760
Following commands can be used.
5861

5962
Descriptions, Methods
@@ -439,18 +442,9 @@ TESTING
439442

440443
User testing
441444

442-
During normal use of the tool, "testing" is only required for hunting
443-
problems with the connected target. Following options for tracing and
444-
verbosity can be used for that:
445-
446-
--v
447-
448-
Print more information about checks.
449-
450-
--trace
445+
Please see:
451446

452-
Print debugging messages.
453-
For more details, please see X&Options for tracing and debugging& .
447+
$0 --help=test
454448

455449
Functional testing
456450

@@ -464,8 +458,8 @@ TESTING
464458
development. These tests are implemented in the ./t/ directory, see
465459
all 'Makefile.*' there, start with 'Makefile.pod'.
466460

467-
After initialising the development environment (for example when the
468-
tarball have been extracted), use following to create a logfile for
461+
After initialising the development environment (for example when the
462+
tarball have been extracted), use following to create a logfile for
469463
each test in t/log/ :
470464

471465
make test.log
@@ -478,8 +472,8 @@ TESTING
478472

479473
make test.log
480474

481-
and follow the instructions printed at end (compare logfile, accexpt
482-
new logfiles). Most likely, the next step is any of:
475+
and follow the instructions printed at end (compare|accept logfiles).
476+
Most likely, the next step is any of:
483477

484478
make test.log-compare
485479
make test.log-compare-v

0 commit comments

Comments
 (0)