summaryrefslogtreecommitdiff
path: root/CPP_STYLE_GUIDE.md
diff options
context:
space:
mode:
authorAnna Henningsen <anna@addaleax.net>2019-11-20 00:57:49 +0100
committerAnna Henningsen <anna@addaleax.net>2019-11-22 21:28:32 +0100
commitc132035f7c44bf6b720dc5c7faa87517922cff31 (patch)
treeb8d6f85356c252d83b0fef0ff6e6dd4add019370 /CPP_STYLE_GUIDE.md
parent19e44efdfba4450ea6cc32780adda42fd31a10a7 (diff)
downloadandroid-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.tar.gz
android-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.tar.bz2
android-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.zip
src,doc: add C++ internals documentation
This aims to help explain some of the internal patterns and utilities that we use. It is by no means exhaustive, and suggestions for additions are welcome. Some of this is based on the existing work from #26929. Refs: https://github.com/nodejs/node/pull/26929 PR-URL: https://github.com/nodejs/node/pull/30552 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'CPP_STYLE_GUIDE.md')
-rw-r--r--CPP_STYLE_GUIDE.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/CPP_STYLE_GUIDE.md b/CPP_STYLE_GUIDE.md
index 8808405b2c..f29c8df321 100644
--- a/CPP_STYLE_GUIDE.md
+++ b/CPP_STYLE_GUIDE.md
@@ -1,5 +1,8 @@
# C++ Style Guide
+See also the [C++ codebase README](src/README.md) for C++ idioms in the Node.js
+codebase not related to stylistic issues.
+
## Table of Contents
* [Guides and References](#guides-and-references)