The Tor Browser / file comparison
comparison: security/nss/lib/freebl/mpi/doc/mpi-test.pod
security/nss/lib/freebl/mpi/doc/mpi-test.pod
- changeset 0
- 6474c204b198
equal
deleted
inserted
replaced
| -1:000000000000 | 0:fd3c8d8116fd |
|---|---|
| 1 # This Source Code Form is subject to the terms of the Mozilla Public | |
| 2 # License, v. 2.0. If a copy of the MPL was not distributed with this | |
| 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. | |
| 4 | |
| 5 =head1 NAME | |
| 6 | |
| 7 mpi-test - automated test program for MPI library | |
| 8 | |
| 9 =head1 SYNOPSIS | |
| 10 | |
| 11 mpi-test <suite-name> [quiet] | |
| 12 mpi-test list | |
| 13 mpi-test help | |
| 14 | |
| 15 =head1 DESCRIPTION | |
| 16 | |
| 17 The B<mpi-test> program is a general unit test driver for the MPI | |
| 18 library. It is used to verify that the library works as it is | |
| 19 supposed to on your architecture. As with most such things, passing | |
| 20 all the tests in B<mpi-test> does not guarantee the code is correct, | |
| 21 but if any of them fail, there are certainly problems. | |
| 22 | |
| 23 Each major function of the library can be tested individually. For a | |
| 24 list of the test suites understood by B<mpi-test>, run it with the | |
| 25 I<list> command line option: | |
| 26 | |
| 27 mpi-test list | |
| 28 | |
| 29 This will display a list of the available test suites and a brief | |
| 30 synopsis of what each one does. For a brief overview of this | |
| 31 document, run B<mpi-test> I<help>. | |
| 32 | |
| 33 B<mpi-test> exits with a zero status if the selected test succeeds, or | |
| 34 a nonzero status if it fails. If a I<suite-name> which is not | |
| 35 understood by B<mpi-test> is given, a diagnostic is printed to the | |
| 36 standard error, and the program exits with a result code of 2. If a | |
| 37 test fails, the result code will be 1, and a diagnostic is ordinarily | |
| 38 printed to the standard error. However, if the I<quiet> option is | |
| 39 provided, these diagnostics will be suppressed. | |
| 40 | |
| 41 =head1 RESTRICTIONS | |
| 42 | |
| 43 Only a few canned test cases are provided. The solutions have been | |
| 44 verified using the GNU bc(1) program, so bugs there may cause problems | |
| 45 here; however, this is very unlikely, so if a test fails, it is almost | |
| 46 certainly my fault, not bc(1)'s. | |
| 47 | |
| 48 =head1 AUTHOR | |
| 49 | |
| 50 Michael J. Fromberger <sting@linguist.dartmouth.edu> | |
| 51 Thayer School of Engineering, Hanover, New Hampshire, USA |
