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

Add docs for gdbinit and lldbinit #12227

Closed
danbev opened this issue Apr 5, 2017 · 4 comments
Closed

Add docs for gdbinit and lldbinit #12227

danbev opened this issue Apr 5, 2017 · 4 comments
Labels
doc Issues and PRs related to the documentations. v8 engine Issues and PRs related to the V8 dependency.

Comments

@danbev
Copy link
Contributor

danbev commented Apr 5, 2017

  • Version:
  • Platform:
  • Subsystem:

Currently when running make install gdbinit and soon lldbinit are installed to $PREFIX//share/doc/node/, where prefix is the value specified using --prefix to configure, but there is no documentation regarding how to use these file.

This issue should add such documentation to the appropriate place. Perhaps the guides/debugging_getting_started.md is a good place?

@danbev danbev added the doc Issues and PRs related to the documentations. label Apr 5, 2017
@fhinkel
Copy link
Member

fhinkel commented Apr 5, 2017

I think Node core debugging (with gdb or lldb) does not belong in the guide for --inspect debugging.

Those are really V8 files. I'd suggest uploading a CL in the V8 repo with documentation. I'd prefer it inside the config files to avoid outdated documentation. Seems strange to me to document another project's config files in a separate file in Node.

@fhinkel fhinkel added the v8 engine Issues and PRs related to the V8 dependency. label Apr 5, 2017
@danbev
Copy link
Contributor Author

danbev commented Apr 5, 2017

I'd suggest uploading a CL in the V8 repo with documentation.

Yeah, that does sound better. I'll do that.

I'd prefer it inside the config files to avoid outdated documentation.

Could you point me to some config file that does this so I can follow the same format?

@fhinkel
Copy link
Member

fhinkel commented Apr 5, 2017

I don't think V8 has a specific format for documentation. I see you already have a comment for every command. You can just add one or more paragraphs in the beginning with whatever you think would be useful. Thanks for adding some documentation!

@danbev
Copy link
Contributor Author

danbev commented Apr 6, 2017

I don't think V8 has a specific format for documentation. I see you already have a comment for every command. You can just add one or more paragraphs in the beginning with whatever you think would be useful.

Great, I'll do that thanks!

@danbev danbev closed this as completed Apr 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. v8 engine Issues and PRs related to the V8 dependency.
Projects
None yet
Development

No branches or pull requests

2 participants