capdl icon indicating copy to clipboard operation
capdl copied to clipboard

parse-capDL creates invalid dot file

Open axel-h opened this issue 3 years ago • 2 comments

parse-capDL --dot ...creates invalid dot file. Seems the problem is, that there are lines containing a quoted filename within a quoted string, which dot can't process.

"frame_ticker_group_bin_0000" [label = "{<Object> frame_ticker_group_bin_0000 \n frame (64k, fill: [{0 65536 CDL_FrameFill_FileData "ticker_group_bin" 0}])}"];

The inner quotes must be escaped as \".

axel-h avatar Apr 22 '21 13:04 axel-h

Good catch, it should be pretty straightforward to escape those quotes.

However, looking at this has made me consider whether arguments like the FrameFill should be printed at all in the generated dot files. The original intention was for this output to provide a more abstract view of the various components in simple capDL specifications, and I don't think that these more technical details are really useful for that. In fact, removing them might make it a bit simpler for dot to process the files, and lead to more readable output.

Do you have a specific use case where you were wanting to look at the generated graphs? If you did, do you have an opinion on whether the various specific object parameters should be printed, or whether it should just focus on the relationship between the objects and capabilities?

corlewis avatar May 18 '21 05:05 corlewis

No specific usecase, I was just looking for more visualizations the build process could generate to improve system documentation. So leaving out some deep details seems ok.

axel-h avatar May 18 '21 05:05 axel-h