Herodotus: Difference between revisions

Revision as of 05:51, 6 October 2018

(It's a work in progress.)

Herodotus is a project for tracking and linking analytic and synthetic facts about (the releases of) a package. The tracking is to be done independently per package. (Sisyphus is an example of a repository of packages where this can be applied.)

(Herodotus is inspired by, and partly based in the implementation, on herodotos tool. Note the different spelling of the name of this tool and of our project. Named after Herodotus.)

Which computed or external meta-information for a package is tracked

Analytic facts (computed from the "internal" content of package releases):

Static analysis of the C/C++ code (warnings):

by coccinelle
by cppcheck
...

Discovery of source files which are not used during the build of the package (by means of strace or by the access time)
...

Synthetic facts (added "externally" by maintainers)

Resolutions for the warnings from the static analysis (a reason why they are invalid or a fix).
...

Representation

Each fact is linked to the corresponding Git (Gear) commit or tag.
(The facts can be stored in the same Git repository in a separate branch.)
If the "same" fact appears for several releases, all its occurrences are linked together, so that a maintainer can view them as a single fact. Only when the facts change between releases, it should need attention.

User interfaces

Files (obtained via Git), org-mode editor (Emacs; org-mode is like a personal wiki)
...

Implementation details

The core: herodotos tool

herodotos tool tool runs the analyzers for different releases and then links identical facts (modulo the diff, i.e., the changes of the source code).

Description of herodotos tool

http://coccinelle.lip6.fr/papers/aosd10.pdf
https://kernelnewbies.org/NicolasPalix (its developer; this page has a short description of the tool)

coccinelle support

coccinelle is natively supported by herodotos tool.

Actually, herodotos tool can work with any analyzer which gives output in the org-mode format.

cppcheck support

cppcheck is supported by flycheck (an Emacs package)
flycheck can be hacked to output the information in the format suitable for herodotos tool (org-mode)

So, we could easily get the support for any analyzer known to flycheck.

Discovery of source files which are not used during the build of the package

Either builds under strace can be used to discover files which are not used, or the access time (an idea by boyarsh@, which has already been probably implemented by him).

@@ Line 5: / Line 5: @@
 '''Herodotus''' is a project for tracking and linking analytic and synthetic facts about (the releases of) a package. The tracking is to be done independently per package. ([[Sisyphus]] is an example of a repository of packages where this can be applied.)
-(Herodotus is inspired by, and partly based in the implementation, on [http://coccinelle.lip6.fr/herodotos/herodotos.php herodotos] tool. Note the different spelling of the name of this tool and of our project. Named after [https://en.wikipedia.org/wiki/Herodotus Herodotus].)
+(Herodotus is inspired by, and partly based in the implementation, on [[#The core: herodotos tool|herodotos]] tool. Note the different spelling of the name of this tool and of our project. Named after [https://en.wikipedia.org/wiki/Herodotus Herodotus].)
 ;Which computed or external meta-information for a package is tracked:
@@ Line 13: / Line 13: @@
 :::* by cppcheck
 :::* ...
-::* Discovery of source files which are not used during the build of the package:
+::* Discovery of source files which are not used during the build of the package (by means of strace or by the access time)
-:::* by means of strace
-:::* by means of the access time
 ::* ...
 :*Synthetic facts (added "externally" by maintainers)
@@ Line 31: / Line 29: @@
 ===The core: herodotos tool===
-herodotos tool runs the analyzers for different releases and then links identical facts (modulo the diff, i.e., the changes of the source code).
+[http://coccinelle.lip6.fr/herodotos/herodotos.php herodotos] tool tool runs the analyzers for different releases and then links identical facts (modulo the diff, i.e., the changes of the source code).
 ====Description of herodotos tool====