-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
doc,meta: add references to outside C++ guides #23317
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.
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
Conversation
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Somehow I feel like this should be Semantics
and Memory Management
can be its own section?
(Also ideally we can have a section dedicated to C++/JS interactions and V8/libuv usage)
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit odd to put this section here...can we move it to the beginning of the document? We do inherit some formatting styles from Google's C++ style anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: its
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack x 2.
I'll try to reformat this.
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't mention clang-tidy
as a goal here since the last time I attempted to use it on our code base it took really long to complete linting...certainly much longer than cpplint and cpplint is already kind of slow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack.
Recent versions seems to work much much better. MSVS has it built in, and it runs in reasonable time (for just /src/
and with a limited ruleset). It does spit out a huge amount of recommendations.
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/ATM/At the moment/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
automatic teller machine*
5e72e11
to
546a42f
Compare
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want, you can remove this paragraph or merge it into the previous one, since it shares a lot of substance with it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eventually, I decided to keep it as is. I think it's better to keep semantic from formatting separate, even in this case.
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’d prefer to spell out the abbreviations.
Also, maybe make it a bit clearer that our style guide is closest to the Google one?
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
based of -> based on?
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A space between the link and (GCSG)
?
CPP_STYLE_GUIDE.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto.
with explicit priorities PR-URL: nodejs#23317 Reviewed-By: Anna Henningsen <[email protected]>
4f9a027
to
0f8eaa4
Compare
It's a week old. |
with explicit priorities PR-URL: #23317 Reviewed-By: Anna Henningsen <[email protected]>
with explicit priorities PR-URL: #23317 Reviewed-By: Anna Henningsen <[email protected]>
with explicit priorities PR-URL: #23317 Reviewed-By: Anna Henningsen <[email protected]>
with explicit priorities PR-URL: #23317 Reviewed-By: Anna Henningsen <[email protected]>
with explicit priorities PR-URL: #23317 Reviewed-By: Anna Henningsen <[email protected]>
Suggested words about outside coding guidelines, and set their priorities.
Fixes: #22862
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes