Gentoo Archives: gentoo-doc-cvs

From: Josh Saddler <nightmorph@××××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: ebuild-submit.xml
Date: Mon, 16 Jul 2007 03:04:39
Message-Id: E1IAGsv-0004lP-V9@stork.gentoo.org
1 nightmorph 07/07/16 03:04:29
2
3 Modified: ebuild-submit.xml
4 Log:
5 guidexml coding style fixes, no content change
6
7 Revision Changes Path
8 1.13 xml/htdocs/doc/en/ebuild-submit.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/ebuild-submit.xml?rev=1.13&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/ebuild-submit.xml?rev=1.13&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/ebuild-submit.xml?r1=1.12&r2=1.13
13
14 Index: ebuild-submit.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/ebuild-submit.xml,v
17 retrieving revision 1.12
18 retrieving revision 1.13
19 diff -u -r1.12 -r1.13
20 --- ebuild-submit.xml 24 Oct 2005 13:29:47 -0000 1.12
21 +++ ebuild-submit.xml 16 Jul 2007 03:04:29 -0000 1.13
22 @@ -1,9 +1,10 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/ebuild-submit.xml,v 1.12 2005/10/24 13:29:47 flammie Exp $ -->
25 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/ebuild-submit.xml,v 1.13 2007/07/16 03:04:29 nightmorph Exp $ -->
26 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
27
28 <guide link = "/doc/en/ebuild-submit.xml">
29 <title>Contributing Ebuilds</title>
30 +
31 <author title="Author">
32 <mail link="mbutcher@××××.com">Matt Butcher</mail>
33 </author>
34 @@ -23,11 +24,10 @@
35 <body>
36
37 <p>
38 -Point your web browser to <uri>http://bugs.gentoo.org</uri>. This
39 -is the URL for the Bugzilla bug tracking database. In the list
40 -of links, one of the items reads "Open a new Bugzilla account".
41 -If you have not done so already (e.g. for submitting a bug),
42 -click on this link and create a new account.
43 +Point your web browser to <uri>http://bugs.gentoo.org</uri>. This is the URL for
44 +the Bugzilla bug tracking database. In the list of links, one of the items reads
45 +"Open a new Bugzilla account". If you have not done so already (e.g. for
46 +submitting a bug), click on this link and create a new account.
47 </p>
48
49 </body>
50 @@ -59,29 +59,27 @@
51 <body>
52
53 <p>
54 -At the bottom of the main page or login page, there is a
55 -yellow box. Choose the <c>New - Expert</c> link. Or, you can just go
56 -to the URL <uri>http://bugs.gentoo.org/enter_bug.cgi</uri>.
57 -Either will bring you to the <c>Enter Bug</c> page.
58 +At the bottom of the main page or login page, there is a yellow box. Choose the
59 +<c>New - Expert</c> link. Or, you can just go to the URL
60 +<uri>http://bugs.gentoo.org/enter_bug.cgi</uri>. Either will bring you to the
61 +<c>Enter Bug</c> page.
62 </p>
63
64 <note>
65 -In the Bugzilla system, all entries are bugs. That includes
66 -newly submitted ebuilds. Each bug is assigned a tracking id.
67 -Take note of the ID, especially if you have other ebuilds that
68 -depend on this package.
69 +In the Bugzilla system, all entries are bugs. That includes newly submitted
70 +ebuilds. Each bug is assigned a tracking id. Take note of the ID, especially if
71 +you have other ebuilds that depend on this package.
72 </note>
73
74 <p>
75 -Bugzilla can track multiple products. For example, in Gentoo,
76 -other products may include documentation or tools used to
77 -administrate the website. From the list of products, Ebuilds
78 -should always be submitted to <c>Gentoo Linux</c>.
79 +Bugzilla can track multiple products. For example, in Gentoo, other products may
80 +include documentation or tools used to administrate the website. From the list
81 +of products, Ebuilds should always be submitted to <c>Gentoo Linux</c>.
82 </p>
83
84 <p>
85 -Clicking on the <c>Gentoo Linux</c> product should bring up
86 -a new bug entry form.
87 +Clicking on the <c>Gentoo Linux</c> product should bring up a new bug entry
88 +form.
89 </p>
90
91 </body>
92 @@ -91,23 +89,21 @@
93 <body>
94
95 <p>
96 -The first field on the form is <c>version</c>. If you know
97 -which version your package belongs in, set it here. Otherwise,
98 -select <c>unspecified</c>. Next, set the component. All ebuild
99 -scripts are of the component type <c>Ebuilds</c>.
100 +The first field on the form is <c>version</c>. If you know which version your
101 +package belongs in, set it here. Otherwise, select <c>unspecified</c>. Next, set
102 +the component. All ebuild scripts are of the component type <c>Ebuilds</c>.
103 </p>
104
105 <impo>
106 -Ebuilds should <e>always</e> be of component type
107 -<c>Ebuild</c>. Categories such as <c>GNOME</c>,
108 -<c>Libraries</c>, and <c>Server</c> may look like they apply to
109 -your ebuild, but they are used for filing bugs against packages,
110 -not submitting ebuilds.
111 +Ebuilds should <e>always</e> be of component type <c>Ebuild</c>. Categories such
112 +as <c>GNOME</c>, <c>Libraries</c>, and <c>Server</c> may look like they apply to
113 +your ebuild, but they are used for filing bugs against packages, not submitting
114 +ebuilds.
115 </impo>
116
117 <p>
118 -The categories <c>Platform</c>, <c>OS</c>, and
119 -<c>Priority</c> do not need to be set for ebuilds.
120 +The categories <c>Platform</c>, <c>OS</c>, and <c>Priority</c> do not need to be
121 +set for ebuilds.
122 </p>
123
124 <p>
125 @@ -115,21 +111,20 @@
126 </p>
127
128 <p>
129 -Leave the <c>Assigned To</c> field blank. If you haven't changed
130 -Bugzilla's mail settings, you, as a reporter, will automatically
131 -receive email on bug updates.
132 +Leave the <c>Assigned To</c> field blank. If you haven't changed Bugzilla's mail
133 +settings, you, as a reporter, will automatically receive email on bug updates.
134 </p>
135
136 <p>
137 -Fill in the <c>Summary</c> field with a brief note of what
138 -package you are submitting and whether it's an update or a new
139 -submission. Something like the following is great: <c>foo-bar-x.y.z.ebuild
140 -(New Package)</c> or <c>foo-x.y.z.ebuild (Update)</c>.
141 +Fill in the <c>Summary</c> field with a brief note of what package you are
142 +submitting and whether it's an update or a new submission. Something like the
143 +following is great: <c>foo-bar-x.y.z.ebuild (New Package)</c> or
144 +<c>foo-x.y.z.ebuild (Update)</c>.
145 </p>
146
147 <p>
148 -The <c>Description</c> field should be filled in as completely
149 -as possible. Here's an example from Bug Number 7:
150 +The <c>Description</c> field should be filled in as completely as possible.
151 +Here's an example from Bug Number 7:
152 </p>
153
154 <pre caption="Example description">
155 @@ -161,29 +156,29 @@
156 <body>
157
158 <p>
159 -After clicking <c>submit</c> on the <c>Enter Bug</c> page, you
160 -will go to the <c>Posting Bug</c> page. Take note of the bug number.
161 +After clicking <c>submit</c> on the <c>Enter Bug</c> page, you will go to the
162 +<c>Posting Bug</c> page. Take note of the bug number.
163 </p>
164
165 <p>
166 -Toward the bottom of this page, there is a link to <c>Create a new
167 +Toward the bottom of this page, there is a link to <c>Create a new
168 attachment</c>. Click on this link.
169 </p>
170
171 <p>
172 -Select the file using the text entry box or the <c>Browse</c> dialog.
173 -In the <c>Description</c> field, type the name of the ebuild file, much
174 -the same as you did in the <c>Summary</c> section of the last page.
175 +Select the file using the text entry box or the <c>Browse</c> dialog. In the
176 +<c>Description</c> field, type the name of the ebuild file, much the same as you
177 +did in the <c>Summary</c> section of the last page.
178 </p>
179
180 <p>
181 -Make sure that the content type is set to "text/plain", and that the
182 -radiobutton for <c>select from list</c> is marked.
183 +Make sure that the content type is set to "text/plain", and that the radiobutton
184 +for <c>select from list</c> is marked.
185 </p>
186
187 <p>
188 -There are no other required fields on this form. Click <c>Submit</c>
189 -and you are done!
190 +There are no other required fields on this form. Click <c>Submit</c> and you are
191 +done!
192 </p>
193
194 </body>
195 @@ -197,10 +192,10 @@
196 <body>
197
198 <p>
199 -In cases where you might submit multiple ebuilds, and some of them
200 -depend on others, it is very helpful if these dependencies are noted.
201 -Viewing the bug again should allow you to enter another note. Please add
202 -dependancy information here.
203 +In cases where you might submit multiple ebuilds, and some of them depend on
204 +others, it is very helpful if these dependencies are noted. Viewing the bug
205 +again should allow you to enter another note. Please add dependancy information
206 +here.
207 </p>
208
209 </body>
210
211
212
213 --
214 gentoo-doc-cvs@g.o mailing list