Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

parse-capDL creates invalid dot file #22

Open
axel-h opened this issue Apr 22, 2021 · 2 comments
Open

parse-capDL creates invalid dot file #22

axel-h opened this issue Apr 22, 2021 · 2 comments
Assignees
Labels
Haskell Haskell part of capDL

Comments

@axel-h
Copy link
Member

axel-h commented Apr 22, 2021

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 \".

@corlewis
Copy link
Member

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 corlewis self-assigned this May 18, 2021
@axel-h
Copy link
Member Author

axel-h commented May 18, 2021

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.

@lsf37 lsf37 added the Haskell Haskell part of capDL label Dec 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Haskell Haskell part of capDL
Projects
None yet
Development

No branches or pull requests

3 participants