search

Samsung / netcoredbg

NetCoreDbg is a managed code debugger with MI interface for CoreCLR.
MIT License
780 stars 101 forks source link

Documentation #26

Open sebasmonia opened 5 years ago

sebasmonia commented 5 years ago

It would be great to have some documentation on each command. I managed to run a few things using the unit tests as an example, but that's less than ideal.

Doesn't need to be a full fledged manual, just a Wiki page can work.

ayuckhulk commented 5 years ago

Hi! Thank you for expressing your interest in netcoredbg. Could you please specify a little bit more details about documentation than you need? The debugger supports 2 protocols, which are intended for interoperability with IDE (although not all commands are supported by netcoredbg):

sebasmonia commented 5 years ago

I am interested in the GDB/MI interface, will check out the link supplied.

A list of the commands supported and the link to the docs could be a good start for the README page.

puremourning commented 5 years ago

For DAP the one thing that has to be documented is the launch request, as it is completely server-defined and users have to configure it.

serezlan commented 2 years ago

Hi,

Is there some getting started guide? I'm trying to get it working for a while without much progress.

Thanks

alpencolt commented 2 years ago

@serezlan what kind of starting guide you are looking? For developing NCDB or for using it?

serezlan commented 2 years ago

@alpencolt I am thinking about guide on how to use the debugger. Also it would be great if you can throw some guide on debugging unit test. It would mean a lot.

alpencolt commented 2 years ago

Next week we're going to synchronize source code with our main repo, manual will be added. Now you can run debugger following way:

$ netcoredbg 
ncdb> file dotnet
ncdb> set-args your_app.dll app_param1 app_param2
ncdb> run

CLI commands for debugging are similar to GDB ones. To not enter file ... set-args... (and other command, e.g. setting breakpoints) you may save them to file and run NCDB as:

$netcoredbg --command=command_file

Also it's possible to run NCDB from VS Code.

alpencolt commented 2 years ago

Check this for VSCode https://github.com/OmniSharp/omnisharp-vscode/issues/3943#issuecomment-668142734

alpencolt commented 2 years ago

@serezlan check this manual https://github.com/Samsung/netcoredbg/blob/master/doc/cli.md