Bloof Websuite is a user application that generates a suite of webpages from a set of Bloof XML result files.
To use Bloof Websuite, you will need a Java TM runtime environment version 1.4 or greater. Sun provides Java runtimes for Win32, Solaris and Linux from their website at http://www.javasoft.com/j2se/ . IBM also provides various Java runtimes for a number of platforms at http://www.ibm.com/java/jdk/download/ .
When Java has been installed on your system, unpack the Bloof Websuite distribution file to a directory in your file system. Then you are ready to analyse the software project of your choise. Simply run the Websuite script that is shipped with Bloof Websuite.
When you find a bug in Bloof we want to hear about it. Your bug reports play an important part in making Bloof more reliable.
The following suggestions are intended to assist you in forming bug reports that can be handled in an effective fashion. No one is required to follow them but it tends to be to everyone's advantage.
We cannot promise to fix every bug right away. If the bug is obvious, critical, or affects a lot of users, chances are good that someone will look into it. It could also happen that we tell you to update to a newer version to see if the bug happens there. Or we might decide that the bug cannot be fixed before some major rewrite we might be planning is done. Or perhaps it is simply too hard and there are more important things on the agenda.
Before you report a bug, please read and re-read the documentation to verify that you can really do whatever it is you are trying. If it is not clear from the documentation whether you can do something or not, please report that too; it is a bug in the documentation. If it turns out that the program does something different from what the documentation says, that is a bug. That might include, but is not limited to, the following circumstances:
Here "program" refers to any executable, not only the application.
Being slow or resource-hogging is not necessarily a bug. Read the documentation or ask on one of the mailing lists for help in tuning your applications.
Before you continue, check on the TODO list and in the FAQ to see if your bug is already known. If you cannot decode the information on the TODO list, report your problem. The least we can do is make the TODO list clearer.
The most important thing to remember about bug reporting is to state all the facts and only facts. Do not speculate what you think went wrong, what "it seemed to do" or which part of the program has a fault. If you are not familiar with the implementation you would probably guess wrong and not help us a bit. And even if you are, educated explanations are a great supplement to but no substitute for facts. If we are going to fix the bug we still have to see it happen for ourselves first. Reporting the bare facts is relatively straightforward (you can probably copy and paste them from the screen) but all too often important details are left out because someone thought it does not matter or the report would be understood anyway.
The following items should be contained in every bug report:
Do not be afraid if your bug report becomes rather lengthy. That is a fact of life. It is better to report everything the first time than us having to squeeze the facts out of you. On the other hand, if your input files are huge, it is fair to ask first whether somebody is interested in looking into it.
Do not spend all your time to figure out which changes in the input make the problem go away. This will probably not help solving it. If it turns out that the bug cannot be fixed right away, you will still have time to find and share your work-around. Also, once again, do not waste your time guessing why the bug exists. We will find that out soon enough.
When writing a bug report, please choose non-confusing terminology. The software package in total is called Bloof.
In general, announce bug reports to the bug report tracker at http://sourceforge.net/tracker/?group_id=71700
Do not send bug reports to any of the user mailing lists, such as email@example.com These mailing lists are for answering user questions and their subscribers normally do not wish to receive bug reports. More importantly, they are unlikely to fix them.
Also, please do not send reports to the developers' mailing list firstname.lastname@example.org This list is for discussing the development of Bloof and it would be nice if we could keep the bug reports separate.
If you have a problem with the documentation, the best place to report it is the bug tracker . Please be specific about what part of the documentation you are unhappy with.