Add section on how to build debug build #22510

tlbdk · 2018-08-24T18:59:02Z

There is very little documentation on how to build a debug build and a quick google is less than helpful, this makes generating useful core dumps for reported issues harder than it should be.

The idea is that the nice people that help debug issue could have something to point for the common folks that were unlucky enough to hit a segmentation fault but pretty much have been happy using the official binaries and don't know too much about how the build or debug process works.

For extra points, it would be nice if there were an official debug build that one could just download.

tlbdk · 2018-08-24T18:59:30Z

@addaleax Would this work?

addaleax

Maybe also mention that a core dump is much more useful when the corresponding original binary is also available?

addaleax · 2018-08-24T19:13:54Z

BUILDING.md

@@ -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 :


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.

lundibundi

LGTM with a few nits. Good work.

lundibundi · 2018-08-24T19:18:46Z

BUILDING.md

@@ -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 :


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

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:

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

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.

lundibundi · 2018-08-24T19:29:36Z

BUILDING.md

+$ make -j4
+```
+
+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". 


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'.

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

refack · 2018-08-24T20:00:22Z

BUILDING.md

+
+```console
+$ ./configure --debug
+$ make -j4


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`

refack · 2018-08-24T20:01:25Z

Hello @tlbdk and thank you for the contribution 🥇

refack · 2018-08-24T20:22:46Z

FYI @tlbdk you can check that the email that is configured in your local git is to you preference (can bee see here). We use this only to properly attributing your changes to you in the AUTHORS file and the changelog.
If you would like for the Github UI to link the commit to your account and award you the Contributor label after the changes have been merged, make sure this local email is also added to your GitHub email list.

vsemozhetbyt · 2018-08-25T08:00:44Z

BUILDING.md

+
+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". 
+
+To use the debug build with with all the normal dependencies overwrite the release version in the install directory:


with with -> with

doc: clarify building a debug build

tlbdk · 2018-08-29T21:15:10Z

We implemented all the requested changes and added a bit about the issue you can run into with gdb not matching the platform the core dump was captured on, I think it is ready to merge. Do we need to do anything more?

lundibundi

Just a few language/phrasing nits.

lundibundi · 2018-08-29T21:18:04Z

BUILDING.md

+
+`make` with `./configure --debug` generates two binaries, the regular release
+one in `out/Release/node` and a debug binary in `out/Debug/node`, only the
+ release version is actually installed when you run `make install`. 


Nit: unnecessary space at the beginning.

lundibundi · 2018-08-29T21:18:25Z

BUILDING.md

+ release version is actually installed when you run `make install`. 
+
+To use the debug build with all the normal dependencies overwrite the release
+ version in the install directory:


Also space.

lundibundi · 2018-08-29T21:25:16Z

BUILDING.md

@@ -280,6 +280,17 @@ When using the debug binary, core dumps will be generated in case of crashes.
 These core dumps are useful for debugging when provided with the 
 corresponding original debug binary and system information.

+Reading the core dump requires a gdb that was build on the same platform as the


I'd suggest:
Reading the core dump requires gdb built on the same platform core dump was captured on, wdyt?

lundibundi · 2018-08-29T21:31:03Z

BUILDING.md

@@ -280,6 +280,17 @@ When using the debug binary, core dumps will be generated in case of crashes.
 These core dumps are useful for debugging when provided with the 
 corresponding original debug binary and system information.

+Reading the core dump requires a gdb that was build on the same platform as the
+core dump was captured, so 64bit gdb if node was build as 64bit and Linux gdb if node


so 64bit gdb if node was build as 64bit and Linux gdb if node... -> (i.e. 64bit gdb for node built on a 64bit system, Linux gdb for node built on Linux) wdyt?

lundibundi · 2018-08-29T21:32:33Z

BUILDING.md

@@ -280,6 +280,17 @@ When using the debug binary, core dumps will be generated in case of crashes.
 These core dumps are useful for debugging when provided with the 
 corresponding original debug binary and system information.

+Reading the core dump requires a gdb that was build on the same platform as the
+core dump was captured, so 64bit gdb if node was build as 64bit and Linux gdb if node
+was built on Linux else you might get errors like "not in executable format: File format not recognized".


s/else/otherwise/

Also, shouldn't might be will, as I think it cannot work at all for such cases?

vsemozhetbyt

Some nits.

vsemozhetbyt · 2018-08-30T00:32:13Z

BUILDING.md

+These core dumps are useful for debugging when provided with the 
+corresponding original debug binary and system information.
+
+Reading the core dump requires gdb built on the same platform core dump was 


gdb -> `gdb` here and below?

vsemozhetbyt · 2018-08-30T00:32:51Z

BUILDING.md

+corresponding original debug binary and system information.
+
+Reading the core dump requires gdb built on the same platform core dump was 
+captured on(i.e. 64bit gdb for node built on a 64bit system, Linux gdb 


on(i.e. -> on (i.e. (missing space)

node -> Node.js here and below (or node -> `node`).

Not sure but maybe 64bit -> 64 bit for consistency with other cases in this doc.

@vsemozhetbyt

minor tweaks from @vsemozhetbyt

lundibundi · 2018-08-30T13:35:37Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/732/

vsemozhetbyt

Doc format LGTM, but I am not sure if merge commits will make any trouble for the lander.

addaleax · 2018-08-31T17:25:55Z

Landed in 030ef35, thanks for the PR! 🎉

PR-URL: #22510 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

Add section on how to build debug build

c4a7b72

nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Aug 24, 2018

addaleax approved these changes Aug 24, 2018

View reviewed changes

lundibundi approved these changes Aug 24, 2018

View reviewed changes

refack reviewed Aug 24, 2018

View reviewed changes

vsemozhetbyt reviewed Aug 25, 2018

View reviewed changes

mathiastj and others added 3 commits August 29, 2018 14:33

doc: clarify building a debug build

b81cd6a

Merge pull request #1 from mathiastj/patch-2

5e3717b

doc: clarify building a debug build

Added a bit of detail on gdb and backtrace

d5c02d5

lundibundi approved these changes Aug 29, 2018

View reviewed changes

Minor tweaks from @lundibundi

91fe56d

vsemozhetbyt reviewed Aug 30, 2018

View reviewed changes

mathiastj and others added 2 commits August 30, 2018 09:52

minor tweaks from @vsemozhetbyt

aa7d6ad

Merge pull request #2 from mathiastj/patch-3

2f3d272

minor tweaks from @vsemozhetbyt

lundibundi approved these changes Aug 30, 2018

View reviewed changes

lundibundi added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 30, 2018

vsemozhetbyt approved these changes Aug 30, 2018

View reviewed changes

addaleax closed this Aug 31, 2018

addaleax pushed a commit that referenced this pull request Aug 31, 2018

doc: add section on how to build debug build

030ef35

PR-URL: #22510 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

addaleax pushed a commit that referenced this pull request Aug 31, 2018

doc: add section on how to build debug build

8da21a7

PR-URL: #22510 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

targos pushed a commit that referenced this pull request Sep 3, 2018

doc: add section on how to build debug build

5c2a6d8

PR-URL: #22510 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

targos mentioned this pull request Sep 5, 2018

Release proposal: v10.10.0 #22716

Merged

targos pushed a commit that referenced this pull request Sep 6, 2018

doc: add section on how to build debug build

21068d1

PR-URL: #22510 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>

This was referenced Sep 6, 2018

2018-09-06 Version 10.10.0 (Current) @targos beevelop/docker-android-nodejs#236

Closed

2018-09-06 Version 10.10.0 (Current) @targos beevelop/docker-nodejs#221

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add section on how to build debug build #22510

Add section on how to build debug build #22510

tlbdk commented Aug 24, 2018

tlbdk commented Aug 24, 2018

addaleax left a comment

addaleax Aug 24, 2018

lundibundi left a comment

lundibundi Aug 24, 2018

refack Aug 24, 2018

addaleax Aug 27, 2018

refack Aug 27, 2018

lundibundi Aug 24, 2018

vsemozhetbyt Aug 25, 2018

refack Aug 24, 2018

refack commented Aug 24, 2018

refack commented Aug 24, 2018

vsemozhetbyt Aug 25, 2018

tlbdk commented Aug 29, 2018

lundibundi left a comment

lundibundi Aug 29, 2018

lundibundi Aug 29, 2018

lundibundi Aug 29, 2018 •

edited

Loading

lundibundi Aug 29, 2018

lundibundi Aug 29, 2018

vsemozhetbyt left a comment

vsemozhetbyt Aug 30, 2018

vsemozhetbyt Aug 30, 2018

vsemozhetbyt Aug 30, 2018

vsemozhetbyt Aug 30, 2018

lundibundi commented Aug 30, 2018

vsemozhetbyt left a comment

addaleax commented Aug 31, 2018


		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".

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

Add section on how to build debug build #22510

Add section on how to build debug build #22510

Conversation

tlbdk commented Aug 24, 2018

tlbdk commented Aug 24, 2018

addaleax left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lundibundi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Aug 24, 2018

refack commented Aug 24, 2018

Choose a reason for hiding this comment

tlbdk commented Aug 29, 2018

lundibundi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lundibundi Aug 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lundibundi commented Aug 30, 2018

vsemozhetbyt left a comment

Choose a reason for hiding this comment

addaleax commented Aug 31, 2018

lundibundi Aug 29, 2018 •

edited

Loading