Back to files

How can we test ServDoc ?

Error Checking

One of the goals of ServDoc is to get the information you want without errors, warnings and so on.

That goal isn't easy to achieve because not every installation is identical. E.g. some have some commands under /usr/bin, some have them under /opt/bin or elseweher and some haven't that software installed at all.

An easy, automatically way of testing therefor is to run ServDoc, and to compare the output of STDERR with "known" messages. Everything unknown has then to be a new error and therefor the test isn't successfull.

There are some messages common to all systems supported by servdoc. They are listed in known_errors.all.

There are some messages special to a special OS and maybe to a special user (root / not root). They are listed in known_errors.<OSNAME>.<root/nonroot>.

Documentation Checking

Another goal of ServDoc is a complete :-) documentation in the modules with perldoc.

We can't check automatically the documentation for completeness, but we can check for perldoc errors.