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

Document latest features #377

Merged
merged 9 commits into from
Oct 25, 2024
Merged

Document latest features #377

merged 9 commits into from
Oct 25, 2024

Conversation

nberth
Copy link
Collaborator

@nberth nberth commented Oct 24, 2024

Document code lens, symbol renaming and CFG explorer.

@nberth nberth added the documentation Improvements or additions to documentation label Oct 24, 2024
@nberth nberth self-assigned this Oct 24, 2024
@nberth nberth marked this pull request as ready for review October 24, 2024 11:23
@nberth nberth changed the title More documentation Add documentation Oct 24, 2024
@nberth nberth changed the title Add documentation Document latest features Oct 24, 2024
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@emilienlemaire emilienlemaire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just a few too many spaces 😃

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@engboris engboris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typos

@nberth
Copy link
Collaborator Author

nberth commented Oct 24, 2024

Looks good to me, just a few too many spaces 😃

That's a habit I kept from the time I edited LaTeX: it's actually very useful to distinguish sentences, and has no impact on markdown semantics.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nberth nberth force-pushed the more-documentation branch from e5f214d to f87f803 Compare October 24, 2024 15:22
Comment on lines 260 to 262
## Debugging

In order to debug a COBOL program, you first need to run a *build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section misses things like attaching, setting program/procedure breakpoints, watchpoints, ...

If you change the extension to keep the debugging in its own separate extension (with a dependency in this extension to the debug extension but not vice-versa if the other extension does not use the LSP), then you'd only need a teaser here and can reference to that's extension's README, which should already include parts of this.

Also I'd highly suggest to not only hint to the debug build task, because that is only useful for small/testing programs [
but there it is very useful, especially for beginners]. With bigger environments you'll have either external build flows or (most preferably) done it by make.

For this scenario it is important to document which options need to be passed to cobc (I think for GC 3.2+ the -g option is enough).

As the coverage handling is also part of that extension, the same applies there - but in any case I'd suggest to have at least a screenshot of that here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added basic details about the additional flags passed to cobc.

Regarding dependencies, at the moment the debug extension is tuned with a preLaunchTask that directs to a build task of the main extension; this is mainly to help newcomers (they can just press F5 to automatically compile and run programs). I'd like to keep the extensions separate, but for now we found no convincing way to do that and keep the aforementioned behavior (it's also still debatable whether this fully automated behavior is really worth the hassle — see also the other debug-related issues).

At the moment I'm trying to do a quick release (long overdue); so aspects mentioned in this comment will be addressed later.

Note we don't rely on the debug extension to show coverage information (there's no reason to have those two features so tied together I think): a dedicated gcov-viewer extension that we found simpler/more maintainable than the coverage-related code of the debug extension is used instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a dedicated gcov-viewer extension that we found simpler/more maintainable than the coverage-related code of the debug extension is used instead.

That's good - can you keep that in a separate (depending = automatically installed [as long as you're connected to the internet]) extension or does that needs to "included" as well?

Please create an issue to drop the coverage stuff from the debugging extension (because it is not needed any more and is "too much" there as well).

README.md Show resolved Hide resolved
@nberth nberth merged commit f6d4830 into OCamlPro:master Oct 25, 2024
4 checks passed
@nberth nberth deleted the more-documentation branch October 25, 2024 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants