Annotation of www/porttest.html, Revision 1.4
1.1 couderc 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2:
3: <html>
4: <head>
5: <meta http-equiv="content-type" content="text/html; charset=UTF-8">
6:
7: <title>OpenBSD Port's Testing Guide</title>
8: </head>
9:
10: <body text="#000000" bgcolor="#FFFFFF" link="#23238E">
11: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141" src=
12: "images/smalltitle.gif" border="0"></a>
13:
14: <h2><font color="#e00000">Port's Testing Guide</font></h2>
15: <hr>
16:
17: <h2><font color="#0000e0">Index</font></h2>
18:
19: <ul>
20: <li><a href="#Introduction">Introduction</a></li>
21:
22: <li><a href="#How">How</a></li>
23:
24: <li><a href="#First">First step</a></li>
25:
26: <li><a href="#Testing">Testing</a></li>
27:
28: <li><a href="#Commenting">Commenting</a></li>
29:
30: <li><a href="#More">More testing</a></li>
31: </ul>
32: <hr>
33:
34: <h2><a name="Introduction"><font color=
35: "#0000e0">Introduction</font></a></h2>
36:
37: <p>The <a href="ports.html">ports tree</a> is an huge piece of work that
1.3 couderc 38: permits to OpenBSD users to use third-party programs without losing time in
39: patching, configuring, etc. This work is done by a few volunteers who
40: spend hours making your favorite applications work fine on your
1.1 couderc 41: system. Many people think that they can't help our project because they
1.3 couderc 42: don't have enough knowledge; this is false because they can help porters
1.1 couderc 43: to work better and faster.</p>
44:
45: <h2><a name="How"><font color="#0000e0">How</font></a></h2>
46:
47: <p>Simply by testing submitted updates or new ports which are posted on
48: <a href="mailto:ports@openbsd.org">ports@openbsd.org</a>. By doing this
1.3 couderc 49: you reduce the latency of commits and also increase the number of ports to
50: be committed (many ports are not committed because of lack of testing!).</p>
1.1 couderc 51:
52: <h2><a name="First"><font color="#0000e0">First step</font></a></h2>
53:
1.3 couderc 54: <p>Before starting you must know that ports development is done by
55: following <a href="plus.html">OpenBSD-current</a>; you can find
1.1 couderc 56: instructions on following current <a href="anoncvs.html">source</a> and
57: <a href="faq/upgrade-minifaq.html">upgrade faq</a>. When it's done you
58: are ready to follow <a href=
59: "mailto:ports@openbsd.org">ports@openbsd.org</a> .</p>
60:
61: <h2><a name="Testing"><font color="#0000e0">Testing</font></a></h2>
62:
1.3 couderc 63: <p>Now that you are on the mailing-list you can find two types of
64: submissions; new ports and updates. New ports are generally posted as
65: an attachment or url to a tarball which contains the port tree. A good
66: idea is to extract it into the <tt>/usr/ports/mystuff/</tt> directory
67: and then test it. Updates are generally a diff against the current
68: ports tree, so it is suggested that you copy the port into <tt>mystuff/</tt>
69: and apply the diff to prevent breaking your tree.</p>
1.1 couderc 70:
1.3 couderc 71: <p>You will need to perform step-by-step the building of the port to
1.1 couderc 72: verify that every <a href=
1.3 couderc 73: "http://www.openbsd.org/cgi-bin/man.cgi?query=ports&sektion=7&format=html">target</a> is going correctly :</p>
1.1 couderc 74:
75: <ul>
1.3 couderc 76: <li>fetch : You just need to verify that distfile(s) are correctly
1.1 couderc 77: downloaded.</li>
78:
1.3 couderc 79: <li>extract : Generally extract is done without a problem, so you can
1.1 couderc 80: ignore this target in most cases.</li>
81:
1.3 couderc 82: <li>patch : Check if patches apply correctly and track down forgotten
83: <tt>.orig</tt> .</li>
1.1 couderc 84:
1.3 couderc 85: <li>configure : For ports which use a configure script you can verify
1.1 couderc 86: they have correct path for dependencies, use(less) features, etc
87: ...</li>
88:
1.3 couderc 89: <li>build : The build itself should not give errors but could contain
90: minor warnings about <a href=
91: "http://www.openbsd.org/cgi-bin/man.cgi?query=tmpnam&sektion=0&format=html">tmpnam</a> issues to be resolved by using <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=mkstemp&sektion=0&format=html">mkstemp</a>.</li>
1.1 couderc 92:
1.3 couderc 93: <li>fake : This target is faking installation of the package to prepare
94: for packaging. You should verify that files are installed in fake
1.1 couderc 95: directory.</li>
96:
1.3 couderc 97: <li>package : Package creation can break if pkg/PLIST* and/or
1.1 couderc 98: pkg/PFRAG* are wrong.</li>
99:
1.3 couderc 100: <li>install : Check that package installation works fine.</li>
1.1 couderc 101:
1.3 couderc 102: <li>deinstall : Don't forget to test deinstall.</li>
1.1 couderc 103: </ul>
104:
105: <p>You could also check some pkg/ stuff like DESCR, MESSAGE, INSTALL,
106: DEINSTALL</p>
107:
108: <h2><a name="Commenting"><font color="#0000e0">Commenting</font></a></h2>
109:
110: <p>At the end of the test comes the really important thing : comments.
1.3 couderc 111: Even if the port is working fine you must comment on it. If we have ten
112: posts where people say that the port runs fine under different architectures
113: then the commit is done faster. If it does not work then you must give some
114: information using tools such as <a href=
1.1 couderc 115: "http://www.openbsd.org/cgi-bin/cvsweb/ports/infrastructure/build/portslogger">
116: portslogger</a>.</p>
117:
118: <p>Example :<br>
119: </p>
120:
121: <div style="margin-left: 2em">
122: <table border="0" cellpadding="3" width="100%">
123: <tr>
124: <td nowrap bgcolor="#EEEEEE">
125: <pre>
126: # make install | /usr/ports/infrastructure/build/portslogger
127: </pre>
128: </td>
129: </tr>
130: </table>
131: </div>
132: <br>
133: <br>
134:
135:
1.3 couderc 136: <p>This will redirect the output into a log file located in the current
1.1 couderc 137: directory.</p>
138:
139: <h2><a name="More"><font color="#0000e0">More testing</font></a></h2>
140:
141: <p>For those who are more skilled they can test targets like
142: lib-depends-check, look at patches and pkg stuff. You can also provide
1.3 couderc 143: diffs to correct bugs, add flavors, or other enhancements.</p>
1.1 couderc 144: <hr>
145:
146: <address>
1.4 ! couderc 147: <p>$OpenBSD: porttest.html,v 1.3 2002/09/10 19:10:24 couderc Exp $<br>
! 148: OpenBSD Copyright © 2002 OpenBSD</p>
1.1 couderc 149: </address>
150: </body>
151: </html>