Sitelet https://github.com/nodejs/node/issues/12227
Skip to content

Add docs for gdbinit and lldbinit #12227

Description

@danbev
  • 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?

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    on Apr 5, 2017
  2. fhinkel commented on Apr 5, 2017

    @fhinkel
    Contributor

    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.

  3. added
    v8 engineIssues and PRs related to the V8 dependency.
    on Apr 5, 2017
  4. danbev commented on Apr 5, 2017

    @danbev
    ContributorAuthor

    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?

  5. fhinkel commented on Apr 5, 2017

    @fhinkel
    Contributor

    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!

  6. danbev commented on Apr 6, 2017

    @danbev
    ContributorAuthor

    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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.v8 engineIssues and PRs related to the V8 dependency.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions