Skip to content

V
V8
Commit 17ab6c28 authored by hablich's avatar hablich Committed by Commit bot
Browse files
Options

[Docs] Fix some nits discovered while converting to Markdown 

LOG=N
R=machenbach@chromium.org

Review URL: https://codereview.chromium.org/1385873002

Cr-Commit-Position: refs/heads/master@{#31101}
parent 3615dae7
Hide whitespace changes
Inline Side-by-side
Showing with 16 additions and 25 deletions
docs/becoming_v8_committer.md
View file @ 17ab6c28
# Becoming a V8 committer
## What is a committer? ## What is a committer?
Technically, a committer is someone who has write access to the V8 SVN repository. A committer can submit his or her own patches or patches from others. Technically, a committer is someone who has write access to the V8 Git repository. A committer can submit his or her own patches or patches from others.
This privilege is granted with some expectation of responsibility: committers are people who care about the V8 project and want to help meet its goals. A committer is not just someone who can make changes, but someone who has demonstrated his or her ability to collaborate with the team, get the most knowledgeable people to review code, contribute high-quality code, and follow through to fix issues (in code or tests). This privilege is granted with some expectation of responsibility: committers are people who care about the V8 project and want to help meet its goals. A committer is not just someone who can make changes, but someone who has demonstrated his or her ability to collaborate with the team, get the most knowledgeable people to review code, contribute high-quality code, and follow through to fix issues (in code or tests).
...@@ -35,4 +37,4 @@ You don't really need to do much to maintain committer status: just keep being a ...@@ -35,4 +37,4 @@ You don't really need to do much to maintain committer status: just keep being a
In the unhappy event that a committer continues to disregard good citizenship (or actively disrupts the project), we may need to revoke that person's status. The process is the same as for nominating a new committer: someone suggests the revocation with a good reason, two people second the motion, and a vote may be called if consensus cannot be reached. I hope that's simple enough, and that we never have to test it in practice. In the unhappy event that a committer continues to disregard good citizenship (or actively disrupts the project), we may need to revoke that person's status. The process is the same as for nominating a new committer: someone suggests the revocation with a good reason, two people second the motion, and a vote may be called if consensus cannot be reached. I hope that's simple enough, and that we never have to test it in practice.
(Source: inspired by http://dev.chromium.org/getting-involved/become-a-committer ) (Source: inspired by http://dev.chromium.org/getting-involved/become-a-committer )
\ No newline at end of file
docs/runtime_functions.md
View file @ 17ab6c28
# Introduction # Runtime functions
Much of the JavaScript library is implemented in JavaScript code itself, Much of the JavaScript library is implemented in JavaScript code itself,
using a minimal set of C++ runtime functions callable from JavaScript. using a minimal set of C++ runtime functions callable from JavaScript.
Some of these are called using names that start with %, and using the flag Some of these are called using names that start with %, and using the flag
"--allow-natives-syntax". Others are only called by code generated by the "--allow-natives-syntax". Others are only called by code generated by the
code generators, and are not visible in JS, even using the % syntax. code generators, and are not visible in JS, even using the % syntax.
<a href='Hidden comment:
= Details =
Here are the V8 runtime functions, their JS names, if they are visible,
and their documentation.
<wiki:comment>
\ No newline at end of file
docs/source.md
View file @ 17ab6c28
**Quick links:** [browse](http://code.google.com/p/v8/source/browse) | [browse bleeding edge](http://code.google.com/p/v8/source/browse/branches/bleeding_edge) | [changes](https://chromium.googlesource.com/v8/v8.git). # Source
**Quick links:** [browse](https://chromium.googlesource.com/v8/v8/) | [browse bleeding edge](https://chromium.googlesource.com/v8/v8/+/master) | [changes](https://chromium.googlesource.com/v8/v8/+log/master).
## Command-Line Access ## Command-Line Access
...@@ -36,4 +38,4 @@ V8 public API (basically the files under include/ directory) may change over tim ...@@ -36,4 +38,4 @@ V8 public API (basically the files under include/ directory) may change over tim
## GUI and IDE Access ## GUI and IDE Access
This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information. This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information.
\ No newline at end of file
docs/v8_c_plus_plus_styleand_sops.md
View file @ 17ab6c28
# Introduction # V8 C++ Style Guide
In general, V8 should conform to Google's/Chrome's C++ Style Guide for new code that is written. Your V8 code should conform to them as much as possible. There will always be cases where Google/Chrome Style Guide conformity or Google/Chrome best practices are extremely cumbersome or underspecified for our use cases. We document these exceptions here. In general, V8 should conform to Google's/Chrome's C++ Style Guide for new code that is written. Your V8 code should conform to them as much as possible. There will always be cases where Google/Chrome Style Guide conformity or Google/Chrome best practices are extremely cumbersome or underspecified for our use cases. We document these exceptions here.
# Details
Coming Soon
\ No newline at end of file
docs/v8_committers_responsibility.md
View file @ 17ab6c28
# V8 committer's responsibility
## Basic commit guidelines ## Basic commit guidelines
When you're committing to the V8 repositories, ensure that you follow those guidelines: When you're committing to the V8 repositories, ensure that you follow those guidelines:
...@@ -25,17 +27,13 @@ At the same time, we want to encourage many people to participate in the review ...@@ -25,17 +27,13 @@ At the same time, we want to encourage many people to participate in the review
So, here are some guidelines to help clarify the process: So, here are some guidelines to help clarify the process:
1. When a patch author requests more than one reviewer, they should make clear in the review request email what they expect the responsibility of each reviewer to be. For example, you could write this in the email: 1. When a patch author requests more than one reviewer, they should make clear in the review request email what they expect the responsibility of each reviewer to be. For example, you could write this in the email:
``` * larry: bitmap changes
* sergey: process hacks
a. larry: bitmap changes * everybody else: FYI
b. sergey: process hacks
c. everybody else: FYI
```
1. In this case, you might be on the review list because you've asked to be in the loop for multiprocess changes, but you wouldn't be the primary reviewer and the author and other reviewers wouldn't be expecting you to review all the diffs in detail. 1. In this case, you might be on the review list because you've asked to be in the loop for multiprocess changes, but you wouldn't be the primary reviewer and the author and other reviewers wouldn't be expecting you to review all the diffs in detail.
1. If you get a review that includes many other people, and the author didn't do (1), please ask them what part you're responsible for if you don't want to review the whole thing in detail. 1. If you get a review that includes many other people, and the author didn't do (1), please ask them what part you're responsible for if you don't want to review the whole thing in detail.
1. The author should wait for approval from everybody on the reviewer list before checking in. 1. The author should wait for approval from everybody on the reviewer list before checking in.
1. People who are on a review without clear review responsibility (i.e. drive-by reviews) should be super responsive and not hold up the review. The patch author should feel free to ping them mercilessly if they are. 1. People who are on a review without clear review responsibility (i.e. drive-by reviews) should be super responsive and not hold up the review. The patch author should feel free to ping them mercilessly if they are.
1. If you're an "FYI" person on a review and you didn't actually review in detail (or at all), but don't have a problem with the patch, note this. You could say something like "rubber stamp" or "ACK" instead of "LGTM." This way the real reviewers know not to trust that you did their work for them, but the author of the patch knows they don't have to wait for further feedback from you. Hopefully we can still keep everybody in the loop but have clear ownership and detailed reviews. It might even speed up some changes since you can quickly "ACK" changes you don't care about, and the author knows they don't have to wait for feedback from you. 1. If you're an "FYI" person on a review and you didn't actually review in detail (or at all), but don't have a problem with the patch, note this. You could say something like "rubber stamp" or "ACK" instead of "LGTM." This way the real reviewers know not to trust that you did their work for them, but the author of the patch knows they don't have to wait for further feedback from you. Hopefully we can still keep everybody in the loop but have clear ownership and detailed reviews. It might even speed up some changes since you can quickly "ACK" changes you don't care about, and the author knows they don't have to wait for feedback from you.
(Adapted from: http://dev.chromium.org/developers/committers-responsibility ) (Adapted from: http://dev.chromium.org/developers/committers-responsibility )
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment