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

Documentation: Add basic description on how to run Goblint and on need for context widening #235

Merged
merged 3 commits into from
May 19, 2021

Conversation

jerhard
Copy link
Member

@jerhard jerhard commented May 19, 2021

In #206 (comment), @vogler noted that stack overflows that occur in calls for C-functions result in Goblint being killed with signal 11.

This PR adds a very basic documentation on how to run Goblint, with a remark to enable exp.widen-context when the analysis of recursive function leads to a stack overflow / signal 11.

Related to #208.

@sim642 sim642 added the documentation Documentation, comments label May 19, 2021
@michael-schwarz
Copy link
Member

Should we also explain the Makefile support here? Or is this best saved for a different page?

@sim642
Copy link
Member

sim642 commented May 19, 2021

Should we also explain the Makefile support here? Or is this best saved for a different page?

I think this page would be fine for that until it grows too big. Although often these Read the Docs style sites have quite long pages, but with sensible heading structure, the sidebar makes even long pages navigable.

Same goes for these common options/configurations explanations, e.g. exp.widen-context in this case: in the future if we already more of them documented, then we might have to move them to a separate page.

@jerhard
Copy link
Member Author

jerhard commented May 19, 2021

Should we also explain the Makefile support here? Or is this best saved for a different page?

We can put that into the same file, yes. It would need an a little bit more extensive explanation though, because it e.g. requires having a setup where the cilly executable is in the PATH – which it is not by default, IIRC. So I would move documenting this to another PR/Issue then.

@jerhard jerhard merged commit f99164f into master May 19, 2021
@jerhard jerhard deleted the running_goblint_doc branch May 19, 2021 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants