Add documentation on how to debug Goblint with VS Code

[jerhard]

Add a Markdown description on how to debug Goblint with VS Code, using the hackwaly.ocamlearlybird extension. Closes #215. Related to #208.

[sim642]

Since it's not mentioned anywhere, I'm guessing earlybird doesn't require a particular OCaml version anymore? Or if it does, then it should be mentioned here.

[sim642]

I haven't gotten around to trying earlybird but when I read about it, it required OCaml bytecode compilation. I see this debug target does that:

analyzer/make.sh

Lines 61 to 63 in 11dcafd

	;; debug)
	ocb -tag debug $TARGET.d.byte &&
	cp _build/$TARGET.d.byte goblint.byte

Unlike the normal native build, this one still uses ocamlbuild instead of dune. Although this isn't necessarily about the documentation, I'm wondering if we could easily change this target to also build using dune.

---

This would be especially useful for speed because ocamlbuild doesn't do parallel building like dune I think, so it takes much longer.

[sim642]

Maybe this should also be part of make dev?

analyzer/make.sh

Lines 98 to 101 in 11dcafd

	;; dev)
	echo "Installing opam packages for development..."
	opam install utop ocaml-lsp-server ocp-indent ocamlformat ounit2
	# ocaml-lsp-server is needed for https://github.com/ocamllabs/vscode-ocaml-platform

[sim642]

I guess they can, but then such argument would be passed as if it was quoted in the shell to contain a literal space.

[sim642]

I just noticed something slightly annoying now. Having the bytecode build around makes regression testing script ask this every time:

analyzer/scripts/update_suite.rb

Lines 43 to 47 in a71e9ed

	goblintbyte = File.join(Dir.getwd,"goblint.byte")
	if File.exists?(goblintbyte) then
	puts "Running the byte-code version! Continue? (y/n)"
	exit unless $stdin.gets()[0] == 'y'
	goblint = goblintbyte

Maybe we should make it an option of the script instead?

[michael-schwarz]

Maybe we should make it an option of the script instead?

Maybe yes, but I would go with this behavior of asking as the default. If I have both around, it is not clear which one is up-to-date, and as a creature of habit one tends to run make test.

But maybe we could provide flags -b for bytecode and -n for native code?

[jerhard]

Since it's not mentioned anywhere, I'm guessing earlybird doesn't require a particular OCaml version anymore? Or if it does, then it should be mentioned here.

The latest version of earlybird does work with OCaml 4.11 and 4.12. As OCaml 4.11.1 is the default switch for the Goblint setup right now, it should not be necessary to specify the OCaml version here.

[sim642]

I added some ./docs on master now, which are also browsable via Read the Docs. You can merge in master and move your stuff at the end of ./docs/developer-guide/debugging.md (while adjusting heading levels appropriately). Or I can take care of this myself after this gets merged.

[jerhard]

You can merge in master and move your stuff at the end of ./docs/developer-guide/debugging.md (while adjusting heading levels appropriately).

Done.