Skip to content

Add section on how to build debug build #22510

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.

Sign up for GitHub

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

Closed
tlbdk wants to merge 7 commits into from
Closed

Add section on how to build debug build #22510

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c4a7b72
Add section on how to build debug build
Aug 24, 2018
b81cd6a
doc: clarify building a debug build
mathiastj Aug 29, 2018
5e3717b
Merge pull request #1 from mathiastj/patch-2
tlbdk Aug 29, 2018
d5c02d5
Added a bit of detail on gdb and backtrace
Aug 29, 2018
91fe56d
Minor tweaks from @lundibundi
Aug 29, 2018
aa7d6ad
minor tweaks from @vsemozhetbyt
mathiastj Aug 30, 2018
2f3d272
Merge pull request #2 from mathiastj/patch-3
tlbdk Aug 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,23 @@ To install this version of Node.js into a system directory:
$ [sudo] make install
```

#### Building a debug build

If you run into a issue where Node.js segfaults and the "segfault-handler" does not provide enough information, you might have to build a debug build of Node.js to get enough information to debug the issue further, this is done by :
Copy link
Copy Markdown
Member

@addaleax addaleax Aug 24, 2018

Choose a reason for hiding this comment

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

Nit: We generally wrap lines at 80 characters (and there’s an extra space before the :)

This can also be taken care of when landing, I’d say.

Copy link
Copy Markdown
Member

@lundibundi lundibundi Aug 24, 2018

Choose a reason for hiding this comment

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

Please replace 'a issue' -> 'an issue'.

Copy link
Copy Markdown
Contributor

@refack refack Aug 24, 2018

Choose a reason for hiding this comment

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

Can I suggest:

If you run into a issue where Node.js does not provide enough debug information, you can try to build a debug enabled binary:

Copy link
Copy Markdown
Member

@addaleax addaleax Aug 27, 2018

Choose a reason for hiding this comment

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

@refack I’d prefer something that makes clear that this relates almost exclusively to native errors.

Copy link
Copy Markdown
Contributor

@refack refack Aug 27, 2018

Choose a reason for hiding this comment

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

If you run into a issue where the information provided by the JS stack trace is not enough, or if you suspect the error happens outside of the JS VM, you can try to build a debug enabled binary.


```console
$ ./configure --debug
$ make -j4
Copy link
Copy Markdown
Contributor

@refack refack Aug 24, 2018

Choose a reason for hiding this comment

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

I might suggest make -C out BUILDTYPE=Debug -j4 to avoid unnececerily building the Release binary. That could allow you to replace the following paragraph with:

If the build finished successfully, the debug enabled binary will be at `out/Debug/node`

```

A make with "./configure --debug" generates two binaries, the regular release one in "out/Release/node" and a debug build in "out/Debug/node", only the release version is actually installed when you run "make install".
Copy link
Copy Markdown
Member

@lundibundi lundibundi Aug 24, 2018

Choose a reason for hiding this comment

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

I'm not sure but I think this 'A' is not needed here, so it's just 'Make with ...' or 'make with'.

Also, I think it'll be better with 'a debug build in' -> 'a debug binary in'.

Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Aug 25, 2018

Choose a reason for hiding this comment

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

Also maybe it is worth to replace double quotes with backticks for all 4 cases here.


To use the debug build with with all the normal dependencies overwrite the release version in the install directory:
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Aug 25, 2018

Choose a reason for hiding this comment

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

with with -> with


``` console
$ make install --prefix=/opt/node-debug/
$ cp -a -f out/Debug/node /opt/node-debug/node
```

### Windows

Expand Down