Skip to content

Commit 5c3bc21

Browse files
marsonyaaduh95
authored andcommitted
doc: apply sentence case to guides headers
PR-URL: #37497 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
1 parent 7837d3f commit 5c3bc21

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

doc/guides/maintaining-V8.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document attempts to outline the current maintenance processes, proposes
1212
a workflow for maintaining the V8 branches in both Node.js LTS and current
1313
releases, and discusses how the Node.js and V8 teams at Google can help.
1414

15-
## V8 Release Schedule
15+
## V8 release schedule
1616

1717
V8 and Chromium follow a
1818
[roughly 6-week release cadence][ChromiumReleaseCalendar]. At any given time
@@ -30,7 +30,7 @@ For example, at the time of this writing:
3030

3131
All older branches are abandoned and are not maintained by the V8 team.
3232

33-
### V8 Merge Process Overview
33+
### V8 merge process overview
3434

3535
The process for backporting bug fixes to active branches is officially
3636
documented [on the V8 wiki][V8MergingPatching]. The summary of the process is:
@@ -48,7 +48,7 @@ documented [on the V8 wiki][V8MergingPatching]. The summary of the process is:
4848
* Merge requests to an abandoned branch will be rejected.
4949
* Only bug fixes are accepted for backporting.
5050

51-
## Node.js Support Requirements
51+
## Node.js support requirements
5252

5353
At any given time Node.js needs to be maintaining a few different V8 branches
5454
for the various Current, LTS, and nightly releases. At present this list
@@ -146,7 +146,7 @@ abandoned by upstream V8. However, Node.js needs to continue supporting
146146
these branches for many months (Current branches) or several
147147
years (LTS branches).
148148

149-
## Maintenance Process
149+
## Maintenance process
150150

151151
Once a bug in Node.js has been identified to be caused by V8, the first step is
152152
to identify the versions of Node.js and V8 affected. The bug may be present in
@@ -160,7 +160,7 @@ process.
160160
* Backports identified by the V8 team. Bugs identified by upstream V8 that we
161161
haven't encountered in Node.js yet.
162162

163-
### Unfixed Upstream Bugs
163+
### Unfixed upstream bugs
164164

165165
If the bug can be reproduced on the [Node.js `canary` branch][], Chromium
166166
canary, or V8 tip-of-tree, and the test case is valid, then the bug needs to be
@@ -176,7 +176,7 @@ fixed upstream first.
176176
branches that are still active or are branches that Node.js cares about.
177177
Follow the process for backporting below.
178178

179-
### Backporting to Active Branches
179+
### Backporting to active branches
180180

181181
If the bug exists in any of the active V8 branches, we may need to get the fix
182182
backported. At any given time there are [two active branches][V8ActiveBranches]
@@ -205,7 +205,7 @@ backport the fix:
205205
* Once the fix has been merged upstream, it can be picked up during an update of
206206
the V8 branch (see below).
207207

208-
### Backporting to Abandoned Branches
208+
### Backporting to abandoned branches
209209

210210
Abandoned V8 branches are supported in the Node.js repository. The fix needs
211211
to be cherry-picked in the Node.js repository and V8-CI must test the change.
@@ -278,7 +278,7 @@ PR-URL: https://github.com/nodejs/node/pull/7833
278278
normal and [V8 CI][] using the Node.js CI system. We only needed to backport
279279
to `v6.x` as the other LTS branches weren't affected by this bug.
280280

281-
### Backports Identified by the V8 Team
281+
### Backports identified by the V8 team
282282

283283
For bugs found through the browser or other channels, the V8 team marks bugs
284284
that might be applicable to the abandoned branches in use by Node.js. This is
@@ -317,7 +317,7 @@ V8 builds against the version of ICU supplied by Node.js,
317317
see [maintaining-icu.md](./maintaining-icu.md) for special considerations.
318318
Specifically, a V8 update may necessitate an ICU update.
319319

320-
### Minor Updates (Patch Level)
320+
### Minor updates (patch level)
321321

322322
Because there may be floating patches on the version of V8 in Node.js, it is
323323
safest to apply the patch level updates as a patch. For example, imagine that
@@ -347,7 +347,7 @@ Revision* from the 5.4 branch that can be useful in the update process above.
347347
The [`git-node`][] tool can be used to simplify this task. Run `git node v8 minor`
348348
to apply a minor update.
349349

350-
### Major Updates
350+
### Major updates
351351

352352
We upgrade the version of V8 in Node.js master whenever a V8 release goes stable
353353
upstream, that is, whenever a new release of Chrome comes out.
@@ -382,7 +382,7 @@ git node v8 major --branch=5.1-lkgr
382382

383383
This should be followed up with manual refloating of all relevant patches.
384384

385-
## Proposal: Using a Fork Repo to Track Upstream V8
385+
## Proposal: using a fork repo to track upstream V8
386386

387387
The fact that Node.js keeps a vendored, potentially edited copy of V8 in deps/
388388
makes the above processes a bit complicated. An alternative proposal would be to

doc/guides/node-postmortem-support.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Postmortem Support
1+
# Postmortem support
22

33
Postmortem metadata are constants present in the final build which can be used
44
by debuggers and other tools to navigate through internal structures of software
55
when analyzing its memory (either on a running process or a core dump). Node.js
66
provides this metadata in its builds for V8 and Node.js internal structures.
77

8-
## V8 Postmortem metadata
8+
## V8 postmortem metadata
99

1010
V8 prefixes all postmortem constants with `v8dbg_`, and they allow inspection of
1111
objects on the heap as well as object properties and references. V8 generates
1212
those symbols with a script (`deps/v8/tools/gen-postmortem-metadata.py`), and
1313
Node.js always includes these constants in the final build.
1414

15-
## Node.js Debug Symbols
15+
## Node.js debug symbols
1616

1717
Node.js prefixes all postmortem constants with `nodedbg_`, and they complement
1818
V8 constants by providing ways to inspect Node.js-specific structures, like
@@ -64,7 +64,7 @@ class ReqWrap : public AsyncWrap {
6464
There are also tests on `test/cctest/test_node_postmortem_metadata.cc` to make
6565
sure all Node.js postmortem metadata are calculated correctly.
6666

67-
## Tools and References
67+
## Tools and references
6868

6969
* [llnode](https://github.com/nodejs/llnode): LLDB plugin
7070
* [`mdb_v8`](https://github.com/joyent/mdb_v8): mdb plugin

0 commit comments

Comments
 (0)