1 | <?xml version="1.0" encoding="UTF-8"?> |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.10 2007/04/01 10:35:45 nightmorph Exp $ --> |
3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.11 2008/01/31 14:31:41 jkt Exp $ --> |
4 | |
4 | |
5 | <guide link="/doc/en/bugzilla-howto.xml"> |
5 | <guide link="/doc/en/bugzilla-howto.xml"> |
6 | <title>Gentoo Bug Reporting Guide</title> |
6 | <title>Gentoo Bug Reporting Guide</title> |
7 | |
7 | |
8 | <author title="Author"> |
8 | <author title="Author"> |
9 | <mail link="chriswhite@gentoo.org">Chris White</mail> |
9 | <mail link="chriswhite@gentoo.org">Chris White</mail> |
10 | </author> |
10 | </author> |
11 | <author title="Editor"> |
11 | <author title="Editor"> |
12 | <mail link="fox2mike@gentoo.org">Shyam Mani</mail> |
12 | <mail link="fox2mike@gentoo.org">Shyam Mani</mail> |
13 | </author> |
13 | </author> |
14 | |
14 | |
15 | <abstract> |
15 | <abstract> |
16 | This document shows the proper method of reporting bugs using Bugzilla. |
16 | This document shows the proper method of reporting bugs using Bugzilla. |
17 | </abstract> |
17 | </abstract> |
18 | |
18 | |
19 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
19 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
20 | <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
20 | <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
21 | <license/> |
21 | <license/> |
22 | |
22 | |
23 | <version>1.9</version> |
23 | <version>1.10</version> |
24 | <date>2007-04-01</date> |
24 | <date>2008-01-31</date> |
25 | |
25 | |
26 | <chapter> |
26 | <chapter> |
27 | <title>Introduction</title> |
27 | <title>Introduction</title> |
28 | <section> |
28 | <section> |
29 | <title>Preface</title> |
29 | <title>Preface</title> |
30 | <body> |
30 | <body> |
31 | |
31 | |
32 | <p> |
32 | <p> |
33 | One of the factors that delay a bug being fixed is the way it is reported. By |
33 | One of the factors that delay a bug being fixed is the way it is reported. By |
34 | creating this guide, we hope to help improve the communication between |
34 | creating this guide, we hope to help improve the communication between |
35 | developers and users in bug resolution. Getting bugs fixed is an important, if |
35 | developers and users in bug resolution. Getting bugs fixed is an important, if |
36 | not crucial part of the quality assurance for any project and hopefully this |
36 | not crucial part of the quality assurance for any project and hopefully this |
37 | guide will help make that a success. |
37 | guide will help make that a success. |
38 | </p> |
38 | </p> |
39 | |
39 | |
… | |
… | |
1331 | the difference being that when you <c>emerge sync</c>, files contained within it |
1331 | the difference being that when you <c>emerge sync</c>, files contained within it |
1332 | will not be deleted. Luckily, a special <path>/usr/local/portage</path> |
1332 | will not be deleted. Luckily, a special <path>/usr/local/portage</path> |
1333 | directory is created for that purpose. Let's go ahead and set our portage |
1333 | directory is created for that purpose. Let's go ahead and set our portage |
1334 | overlay in<path>/etc/make.conf</path>. Open make.conf up in your favorite editor |
1334 | overlay in<path>/etc/make.conf</path>. Open make.conf up in your favorite editor |
1335 | and add this towards the end. |
1335 | and add this towards the end. |
1336 | </p> |
1336 | </p> |
1337 | |
1337 | |
1338 | <pre caption="Setting Up PORTDIR_OVERLAY"> |
1338 | <pre caption="Setting Up PORTDIR_OVERLAY"> |
1339 | PORTDIR_OVERLAY="/usr/local/portage" |
1339 | PORTDIR_OVERLAY="/usr/local/portage" |
1340 | </pre> |
1340 | </pre> |
1341 | |
1341 | |
1342 | <p> |
1342 | <p> |
1343 | Now we'll want to create the appropriate directories to put our test ebuild |
1343 | Now we'll want to create the appropriate directories to put our test ebuild |
1344 | files in. In this case, we're supposed to put them in sys-apps/foobar2. You'll |
1344 | files in. In this case, we're supposed to put them in sys-apps/foobar2. You'll |
1345 | notice that the second comment asks for a files directory for the patch. The |
1345 | notice that the second comment asks for a files directory for the patch. The |
1346 | files directory holds the digests (md5sums of files for a particular version of |
1346 | files directory holds the Manifest files (md5sums of files for a particular version of |
1347 | a package) and any other required files that aren't included with the standard |
1347 | a package) and any other required files that aren't included with the standard |
1348 | source archive (patches, init.d scripts, etc). This is a subdir in the package |
1348 | source archive (patches, init.d scripts, etc). This is a subdir in the package |
1349 | directory called files. Go ahead and create these directories: |
1349 | directory called files. Go ahead and create these directories: |
1350 | </p> |
1350 | </p> |
1351 | |
1351 | |
1352 | <pre caption="Setting Up The Category And Package Directories"> |
1352 | <pre caption="Setting Up The Category And Package Directories"> |
1353 | # <i>mkdir -p /usr/local/portage/sys-apps/foobar2/files</i> |
1353 | # <i>mkdir -p /usr/local/portage/sys-apps/foobar2/files</i> |
1354 | </pre> |
1354 | </pre> |
1355 | |
1355 | |
1356 | <note> |
1356 | <note> |
1357 | The -p in mkdir creates not only the directory you want but also any missing |
1357 | The -p in mkdir creates not only the directory you want but also any missing |
1358 | parent directories as well (sys-apps and foobar2 in this case). |
1358 | parent directories as well (sys-apps and foobar2 in this case). |
1359 | </note> |
1359 | </note> |
1360 | |
1360 | |
1361 | <p> |
1361 | <p> |
1362 | Ok now, we can go ahead and download the files. First, download the ebuild |
1362 | Ok now, we can go ahead and download the files. First, download the ebuild |
1363 | into <path>/usr/local/portage/sys-apps/foobar2</path>, and then add the patch |
1363 | into <path>/usr/local/portage/sys-apps/foobar2</path>, and then add the patch |
1364 | to <path>/usr/local/portage/sys-apps/foobar2/files</path>. Now that we have the |
1364 | to <path>/usr/local/portage/sys-apps/foobar2/files</path>. Now that we have the |
1365 | files, we can begin working on testing the ebuild. |
1365 | files, we can begin working on testing the ebuild. |
1366 | </p> |
1366 | </p> |
1367 | |
1367 | |
1368 | </body> |
1368 | </body> |
1369 | </section> |
1369 | </section> |
1370 | <section> |
1370 | <section> |
1371 | <title>Testing The ebuild</title> |
1371 | <title>Testing The ebuild</title> |
1372 | <body> |
1372 | <body> |
1373 | |
1373 | |
1374 | <p> |
1374 | <p> |
1375 | The process to create an ebuild that can be used by emerge is fairly simple. You |
1375 | The process to create an ebuild that can be used by emerge is fairly simple. You |
1376 | must create a Manifest and a digest file for the ebuild. This can be done with |
1376 | must create a Manifest file for the ebuild. This can be done with |
1377 | the ebuild command. Run it as shown. |
1377 | the ebuild command. Run it as shown. |
1378 | </p> |
1378 | </p> |
1379 | |
1379 | |
1380 | <pre caption="Creating the Manifest and digest files"> |
1380 | <pre caption="Creating the Manifest file"> |
1381 | # <i>ebuild foobar2-1.0.ebuild digest</i> |
1381 | # <i>ebuild foobar2-1.0.ebuild manifest</i> |
1382 | >>> Generating digest file... |
1382 | >>> Creating Manifest for /usr/local/portage/sys-apps/foobar2 |
1383 | <<< foobar2-1.0.tar.bz2 |
|
|
1384 | >>> Generating manifest file... |
|
|
1385 | <<< foobar2-1.0.ebuild |
|
|
1386 | <<< files/digest-foobar2-1.0 |
|
|
1387 | <<< files/foobar2-1.0-Makefile.patch |
|
|
1388 | >>> Computed message digests. |
|
|
1389 | </pre> |
1383 | </pre> |
1390 | |
1384 | |
1391 | <p> |
1385 | <p> |
1392 | Now let's test to see if it works as it should. |
1386 | Now let's test to see if it works as it should. |
1393 | </p> |
1387 | </p> |
1394 | |
1388 | |
1395 | <pre caption="Testing With emerge -pv"> |
1389 | <pre caption="Testing With emerge -pv"> |
1396 | # <i>emerge -pv foobar2</i> |
1390 | # <i>emerge -pv foobar2</i> |
1397 | |
1391 | |
1398 | These are the packages that I would merge, in order: |
1392 | These are the packages that I would merge, in order: |
1399 | |
1393 | |
1400 | Calculating dependencies ...done! |
1394 | Calculating dependencies ...done! |
1401 | [ebuild N ] sys-apps/foobar2-1.0 0 kB [1] |
1395 | [ebuild N ] sys-apps/foobar2-1.0 0 kB [1] |
1402 | |
1396 | |
1403 | Total size of downloads: 0 kB |
1397 | Total size of downloads: 0 kB |