@@ -32,11 +32,12 @@ <h1 class="title">HotSpot Coding Style</h1>
32
32
< ul >
33
33
< li > < a href ="#introduction " id ="toc-introduction "> Introduction</ a >
34
34
< ul >
35
+ < li > < a href ="#changing-this-document "
36
+ id ="toc-changing-this-document "> Changing this Document</ a > </ li >
35
37
< li > < a href ="#why-care-about-style " id ="toc-why-care-about-style "> Why
36
38
Care About Style?</ a > </ li >
37
- < li > < a href ="#counterexamples-and-updates "
38
- id ="toc-counterexamples-and-updates "> Counterexamples and
39
- Updates</ a > </ li >
39
+ < li > < a href ="#counterexamples "
40
+ id ="toc-counterexamples "> Counterexamples</ a > </ li >
40
41
</ ul > </ li >
41
42
< li > < a href ="#structure-and-formatting "
42
43
id ="toc-structure-and-formatting "> Structure and Formatting</ a >
@@ -99,6 +100,21 @@ <h2 id="introduction">Introduction</h2>
99
100
existing HotSpot code, making it easier to read and maintain. Failure to
100
101
follow these guidelines may lead to discussion during code reviews, if
101
102
not outright rejection of a change.</ p >
103
+ < h3 id ="changing-this-document "> Changing this Document</ h3 >
104
+ < p > Proposed changes should be discussed on the < a
105
+ href ="
mailto:[email protected] "
> HotSpot Developers
</ a > mailing
106
+ list. Changes are likely to be cautious and incremental, since HotSpot
107
+ coders have been using these guidelines for years.</ p >
108
+ < p > Substantive changes are approved by < a
109
+ href ="https://www.rfc-editor.org/rfc/rfc7282.html "> rough consensus</ a >
110
+ of the < a href ="https://openjdk.org/census#hotspot "> HotSpot Group</ a >
111
+ Members. The Group Lead determines whether consensus has been
112
+ reached.</ p >
113
+ < p > Editorial changes (changes that only affect the description of
114
+ HotSpot style, not its substance) do not require the full consensus
115
+ gathering process. The normal HotSpot pull request process may be used
116
+ for editorial changes, with the additional requirement that the
117
+ requisite reviewers are also HotSpot Group Members.</ p >
102
118
< h3 id ="why-care-about-style "> Why Care About Style?</ h3 >
103
119
< p > Some programmers seem to have lexers and even C preprocessors
104
120
installed directly behind their eyeballs. The rest of us require code
@@ -124,7 +140,7 @@ <h3 id="why-care-about-style">Why Care About Style?</h3>
124
140
reformatting the whole thing. Also consider separating changes that make
125
141
extensive stylistic updates from those which make functional
126
142
changes.</ p >
127
- < h3 id ="counterexamples-and-updates "> Counterexamples and Updates </ h3 >
143
+ < h3 id ="counterexamples "> Counterexamples</ h3 >
128
144
< p > Many of the guidelines mentioned here have (sometimes widespread)
129
145
counterexamples in the HotSpot code base. Finding a counterexample is
130
146
not sufficient justification for new code to follow the counterexample
@@ -137,20 +153,6 @@ <h3 id="counterexamples-and-updates">Counterexamples and Updates</h3>
137
153
of course, is "When in Rome do as the Romans". Sometimes in the suburbs
138
154
of Rome the rules are a little different; these differences can be
139
155
pointed out here.</ p >
140
- < p > Proposed changes should be discussed on the < a
141
- href ="
mailto:[email protected] "
> HotSpot Developers
</ a > mailing
142
- list. Changes are likely to be cautious and incremental, since HotSpot
143
- coders have been using these guidelines for years.</ p >
144
- < p > Substantive changes are approved by < a
145
- href ="https://www.rfc-editor.org/rfc/rfc7282.html "> rough consensus</ a >
146
- of the < a href ="https://openjdk.org/census#hotspot "> HotSpot Group</ a >
147
- Members. The Group Lead determines whether consensus has been
148
- reached.</ p >
149
- < p > Editorial changes (changes that only affect the description of
150
- HotSpot style, not its substance) do not require the full consensus
151
- gathering process. The normal HotSpot pull request process may be used
152
- for editorial changes, with the additional requirement that the
153
- requisite reviewers are also HotSpot Group Members.</ p >
154
156
< h2 id ="structure-and-formatting "> Structure and Formatting</ h2 >
155
157
< h3 id ="factoring-and-class-design "> Factoring and Class Design</ h3 >
156
158
< ul >
0 commit comments