How to use Herodotos
release 0.6.0rc1

At this point, you must have Herodotos installed. You now have to setup your environment and write a Herodotos Configuration file.

1. Setup the environment
   • Copy default make files and define your working directory. If you installed Herodotos from source, the default make files are herodotos/scripts. For a package install, copy the files from the Herodotos examples¹.
   • Write a HC file which declares your projects, patterns and graphs.
     If you want to have several .hc files, you should define the CONF environment variable to select a default one. Every following make command will then use that configuration file.
2. Initialize the environment:

   make init

3. Compute raw data:

   make -j2

4. Correlate bug reports and propose an initial set of correlations:

   make correl

   Note: Herodotos will automatically compute the changeset.

5. Manually edit the remaining correlations

   $EDITOR results/*/*.correl.org

   Emacs with the Org mode is recommended. Org mode view-link add-on will transform your emacs in a wizard to handle Coccinelle reports.

   See ./tools/org-view-link.el

6. Use the new complementary correlation information

   make correl (recompute the correlation and use the correlation set manually provided)

7. Check the result:

   make stat

8. Look for false positive
   • cp results/*/*.edit.org results/*/*.new.org
   • Edit the new copy and annotate the reported TODO with either BUG or FP.
9. Generate graphs (or website):

   make [graph|web]

10. Edit and adjust your HC file
    Iterate on steps 9 and 10.

1

/usr/share/doc/herodotos/examples/scripts

This document was translated from L^AT_EX by H^EV^EA.