From bb72217faf08d336307d551f26b591383c1fe5af Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 27 Aug 2019 00:07:14 -0400 Subject: [PATCH] doc: heading levels should only increment by one These are flagged by Markdownlint MD001 rule. PR-URL: https://github.com/nodejs/node/pull/29331 Reviewed-By: Rich Trott Reviewed-By: Trivikram Kamat Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- CHANGELOG.md | 2 +- doc/guides/node-postmortem-support.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 69e6ecf89047f0..02273c6b60958f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -105,7 +105,7 @@ release. -### Notes +## Notes * The [Node.js Long Term Support plan](https://github.com/nodejs/Release) covers LTS releases. diff --git a/doc/guides/node-postmortem-support.md b/doc/guides/node-postmortem-support.md index 9a4370016ce64a..bc9ff51949284e 100644 --- a/doc/guides/node-postmortem-support.md +++ b/doc/guides/node-postmortem-support.md @@ -6,14 +6,14 @@ when analyzing its memory (either on a running process or a core dump). Node.js provides this metadata in its builds for V8 and Node.js internal structures. -### V8 Postmortem metadata +## V8 Postmortem metadata V8 prefixes all postmortem constants with `v8dbg_`, and they allow inspection of objects on the heap as well as object properties and references. V8 generates those symbols with a script (`deps/v8/tools/gen-postmortem-metadata.py`), and Node.js always includes these constants in the final build. -### Node.js Debug Symbols +## Node.js Debug Symbols Node.js prefixes all postmortem constants with `nodedbg_`, and they complement V8 constants by providing ways to inspect Node.js-specific structures, like @@ -22,7 +22,7 @@ V8 constants by providing ways to inspect Node.js-specific structures, like `src/node_postmortem_metadata.cc`, and most of them are calculated at compile time. -#### Calculating offset of class members +### Calculating offset of class members Node.js constants referring to the offset of class members in memory are calculated at compile time.