issue #4 Incorrect dot code for newer versions of dot

phmarek / fsvs

Full System Versioning System

GNU General Public License v3.0

6 stars 3 forks source link

issue #4 Incorrect dot code for newer versions of dot #5

Closed albert-github closed 1 year ago

albert-github commented 1 year ago

The dot code gives in the newer dot versions (at least version 2.50 and newer) warnings like:

Warning: flat edge between adjacent nodes one of which has a record shape - replace records with HTML-like labels
  Edge key -> 1
Error: lost key 1 edge
Warning: flat edge between adjacent nodes one of which has a record shape - replace records with HTML-like labels
  Edge key -> 1
Error: lost key 1 edge
Warning: flat edge between adjacent nodes one of which has a record shape - replace records with HTML-like labels
  Edge 1 -> key_C
Error: lost key_A key_B edge
Error: lost 1 key_C edge
Warning: flat edge between adjacent nodes one of which has a record shape - replace records with HTML-like labels
  Edge 1 -> key_C
Error: lost key_A key_B edge
Error: lost 1 key_C edge

this can be overcome by replacing the mentioned code, as indicated, with HTML like labels.

phmarek commented 1 year ago

Thanks a lot, merged!

If you'd like to spend some more time here: I noticed that generating the documentation (make docs) seems broken - I guess newer doxygen versions require a few changes. If you're bored and want to help, I'd be grateful!

albert-github commented 1 year ago

I'm not bored there is enough to be done with doxygen, but lets give it a quick wiz. Indeed the files in the directory src/doxygen-data are quite old (referring to version 1.5.9 and the documentation is created with 1.6.1 at https://doc.fsvs-software.org/doxygen-gif/ and created October 12, 2009.

I tried make docs but this failed as there is no target docs, so it looks like some steps need to be done beforehand. Please guide.

albert-github commented 1 year ago

Some steps to go to the current doxygenn 1.9.5 version

disable HTML_HEADER / HTML_FOOTER / HTML_STYLESHEET to use the current official versions. Later on some tuning (when necessary) can be done here.
fix the warnings as indicated by the doxygen run
remove the strange constructs /§* and *§/ or look for more doxygen like constructs.
study the -. construct and remove it (when possible).

@phmarek What do you think?

phmarek commented 1 year ago

Well, when running doxygen I noticed lots of messages, and that the generated doxygen/html/index.html is unusable. I haven't had time for more investigation yet...

IIRC -. was necessary to get the following stuff included in the generated documentation and indexed, or something like that.

Anything that you can do to help would be welcome!