1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<HTML
><HEAD
><TITLE
>Hacking Bugzilla</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.61
"><LINK
REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="Useful Patches and Utilities for Bugzilla"
HREF="patches.html"><LINK
REL="PREVIOUS"
TITLE="The Quicksearch Utility"
HREF="quicksearch.html"><LINK
REL="NEXT"
TITLE="GNU Free Documentation License"
HREF="gfdl.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="quicksearch.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Appendix D. Useful Patches and Utilities for Bugzilla</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="gfdl.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="BZHACKING"
>D.5. Hacking Bugzilla</A
></H1
><P
> What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet.
</P
><P
CLASS="LITERALLAYOUT"
><br>
The following is a guide for reviewers when checking code into Bugzilla's<br>
CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,<br>
you should follow the rules and style conventions below. Any code that<br>
does not adhere to these basic rules will not be added to Bugzilla's<br>
codebase.<br>
<br>
1. Usage of variables in Regular Expressions<br>
<br>
It is very important that you don't use a variable in a regular<br>
expression unless that variable is supposed to contain an expression.<br>
This especially applies when using grep. You should use:<br>
<br>
grep ($_ eq $value, @array);<br>
<br>
- NOT -<br>
<br>
grep (/$value/, @array);<br>
<br>
If you need to use a non-expression variable inside of an expression, be<br>
sure to quote it properly (using \Q..\E).<br>
<br>
Coding Style for Bugzilla<br>
-------------------------<br>
<br>
While it's true that not all of the code currently in Bugzilla adheres to<br>
this styleguide, it is something that is being worked toward. Therefore,<br>
we ask that all new code (submitted patches and new files) follow this guide<br>
as closely as possible (if you're only changing 1 or 2 lines, you don't have<br>
to reformat the entire file :).<br>
<br>
1. Whitespace<br>
<br>
Bugzilla's prefered indentation is 4 spaces (no tabs, please).<br>
<br>
2. Curly braces.<br>
<br>
The opening brace of a block should be on the same line as the statement<br>
that is causing the block and the closing brace should be at the same<br>
indentation level as that statement, for example:<br>
<br>
if ($var) {<br>
print "The variable is true";<br>
} else {<br>
print "Try again";<br>
}<br>
<br>
- NOT -<br>
<br>
if ($var)<br>
{<br>
print "The variable is true";<br>
}<br>
else<br>
{<br>
print "Try again";<br>
}<br>
<br>
3. File Names<br>
<br>
File names for bugzilla code and support documention should be legal across<br>
multiple platforms. \ / : * ? " < > and | are all illegal characters for<br>
filenames on various platforms. Also, file names should not have spaces in<br>
them as they can cause confusion in CVS and other mozilla.org utilities.<br>
<br>
4. Variable Names<br>
<br>
If a variable is scoped globally ($::variable) its name should be descriptive<br>
of what it contains. Local variables can be named a bit looser, provided the<br>
context makes their content obvious. For example, $ret could be used as a<br>
staging variable for a routine's return value as the line |return $ret;| will<br>
make it blatently obvious what the variable holds and most likely be shown<br>
on the same screen as |my $ret = "";|.<br>
<br>
5. Cross Database Compatability<br>
<br>
Bugzilla was originally written to work with MySQL and therefore took advantage<br>
of some of its features that aren't contained in other RDBMS software. These<br>
should be avoided in all new code. Examples of these features are enums and<br>
encrypt().<br>
<br>
6. Cross Platform Compatability<br>
<br>
While Bugzilla was written to be used on Unix based systems (and Unix/Linux is<br>
still the only officially supported platform) there are many who desire/need to<br>
run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive<br>
not to make the lives of these people any more complicated and avoid doing things<br>
that break Bugzilla's ability to run on multiple operating systems.<br>
<br>
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="quicksearch.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="gfdl.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>The Quicksearch Utility</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="patches.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>GNU Free Documentation License</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>