And here's a new diff with a correction from Alexandre Ratchov (s/sio_open(4)/sio_open(3)/) and taking into account the commits by ste...@.
On Tue, 27 Jul 2010, Daniel Dickman wrote: > Here's an update for the Porter's Handbook with the following changes: > - small html fix for ports/guide.html (duplicate <br> tags). > - reorder the text in ports/index.html -- extract comes before patch not > the other way around. > - sync ports/specialtopics.html with changes from lum@ made to > porting/config.html and changes from espie@ made > to porting/libraries.html > - Update copyrights to 2010 > - Remove all links to the following old files and update urls to point to > the newer versions (so these files should also be zapped): > > www/audio-port.html > www/checklist.html > www/porting.html > www/porttest.html > www/porting/autoconf.html > www/porting/config.html > www/porting/diffs.html > www/porting/libraries.html > www/porting/packaging.html > www/porting/update.html > > TODO: > - A large number of things still point to www/ports.html. They should be > updated before that file can also be removed. > - Some urls in ports(7) will also need to be updated. > diffstat: faq/ports/differences.html | 4 +-- faq/ports/guide.html | 4 +-- faq/ports/index.html | 10 ++++---- faq/ports/specialtopics.html | 49 +++++++++++++++++++++++-------------------- faq/ports/testing.html | 2 - ports.html | 4 +-- 6 files changed, 39 insertions(+), 34 deletions(-) Index: ports.html =================================================================== RCS file: /usr/cvs/www/ports.html,v retrieving revision 1.105 diff -u -r1.105 ports.html --- ports.html 8 Jun 2010 01:53:26 -0000 1.105 +++ ports.html 28 Jul 2010 14:59:36 -0000 @@ -274,7 +274,7 @@ <h3><font color="#0000e0"><a name="Create">Creating New Ports</a></font></h3> <p> If you are interested in helping to expand the OpenBSD ports tree -you should first read <a href="porting.html">porting.html</a>. +you should first read the <a href="faq/ports/index.html">Porter's Handbook</a>. That page references the <a href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/index.html";> FreeBSD Porter's Handbook</a> @@ -307,7 +307,7 @@ If you really need a new version of a port, you should ask the <tt>MAINTAINER</tt> of the port to update the port (see <a href="#Help">below</a> on how to find out who the maintainer is); if you can send patches for this, all the better. To create proper -patches, you should refer to the <a href="porting.html">documentation on building +patches, you should refer to the <a href="faq/ports/index.html">documentation on building ports</a>. </p> Index: faq/ports/differences.html =================================================================== RCS file: /usr/cvs/www/faq/ports/differences.html,v retrieving revision 1.2 diff -u -r1.2 differences.html --- faq/ports/differences.html 18 Jun 2009 16:40:14 -0000 1.2 +++ faq/ports/differences.html 27 Jul 2010 21:22:19 -0000 @@ -7,12 +7,12 @@ <meta name= "description" content= "Differences with other BSD porting systems."> <meta name= "keywords" content= "openbsd,ports"> <meta name= "distribution" content= "global"> -<meta name="copyright" content="This document copyright 2000 by OpenBSD."> +<meta name="copyright" content="This document copyright 2000-2010 by OpenBSD."> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> </head> <!-- -Copyright (c) 2005-2009 XXX +Copyright (c) 2005-2010 XXX Permission to use, copy, modify, and distribute this documentation for any purpose with or without fee is hereby granted, provided that the Index: faq/ports/guide.html =================================================================== RCS file: /usr/cvs/www/faq/ports/guide.html,v retrieving revision 1.10 diff -u -r1.10 guide.html --- faq/ports/guide.html 24 Feb 2010 23:34:08 -0000 1.10 +++ faq/ports/guide.html 27 Jul 2010 21:22:37 -0000 @@ -11,7 +11,7 @@ </head> <!-- -Copyright (c) 2005-2009 XXX +Copyright (c) 2005-2010 XXX Permission to use, copy, modify, and distribute this documentation for any purpose with or without fee is hereby granted, provided that the @@ -421,7 +421,7 @@ file and then running it through 'fmt -w 72'. </ul> -<br><li> +<br><br><li> If the application needs to create a user or a group, choose the lowest free id from <code>/usr/ports/infrastructure/db/user.list</code> for your port to use and make sure your port gets added to this file at commit time. Index: faq/ports/index.html =================================================================== RCS file: /usr/cvs/www/faq/ports/index.html,v retrieving revision 1.3 diff -u -r1.3 index.html --- faq/ports/index.html 15 Dec 2009 20:19:55 -0000 1.3 +++ faq/ports/index.html 27 Jul 2010 21:22:55 -0000 @@ -7,7 +7,7 @@ <meta name= "description" content= "the OpenBSD Porter's Handbook"> <meta name= "keywords" content= "openbsd, ports"> <meta name= "distribution" content= "global"> -<meta name= "copyright" content= "This document copyright 1998-2009 by OpenBSD."> +<meta name= "copyright" content= "This document copyright 1998-2010 by OpenBSD."> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> </head> @@ -142,10 +142,10 @@ <p> In order to create a binary package, developers will start out with a -<code>Makefile</code> that contains the list of instructions to fetch, patch, -extract, configure, compile, and package the raw soure code. The collection -of all the <code>Makefiles</code> for all the third-party applications is -collectively known as the ports system. +<code>Makefile</code> that contains the list of instructions to fetch, extract, +patch, configure, compile, and package the raw soure code. +The collection of all these <code>Makefiles</code> is collectively known as the +ports system. <p> In this handbook, we will explain how the ports system works and show you Index: faq/ports/specialtopics.html =================================================================== RCS file: /usr/cvs/www/faq/ports/specialtopics.html,v retrieving revision 1.4 diff -u -r1.4 specialtopics.html --- faq/ports/specialtopics.html 24 Jun 2009 09:28:47 -0000 1.4 +++ faq/ports/specialtopics.html 28 Jul 2010 14:56:18 -0000 @@ -11,7 +11,7 @@ </head> <!-- -Copyright (c) 2005-2009 XXX +Copyright (c) 2005-2010 XXX Permission to use, copy, modify, and distribute this documentation for any purpose with or without fee is hereby granted, provided that the @@ -158,7 +158,7 @@ <p> It is an error to link a program using qt1 with <code>ld -o program program.o -L/usr/local/lib -lqt</code>. -This code assumes the <code>qt.2.31</code> is not installed, which is +This code assumes that <code>qt.2.31</code> is not installed, which is a wrong assumption. <p> @@ -170,13 +170,18 @@ <h3>Writing library dependencies correctly</h3> The new dependency code does need complete library dependencies. You must -use <code>make lib-depends-check</code> to verify a port does mention all -libraries it requires. You just separate library specs with commas like -this: -<code>LIB_DEPENDS=gtk.1.2,gdk.1.2::x11/gtk+</code>. +use <code>make lib-depends-check</code> or +<code>make port-lib-depends-check</code> +to verify a port does mention all +libraries it requires. +You just write them in LIB_DEPENDS/WANTLIB like this: +<pre> + LIB_DEPENDS += ::x11/gtk+ + WANTLIB += gtk.>=1.2,gdk.>=1.2 +</pre> <p> -It is not an error to specify static libraries on a LIB_DEPENDS line as -well. LIB_DEPENDS are fully evaluated at package build time: the resulting +It is not an error to specify static libraries on a WANTLIB line as +well. WANTLIB are fully evaluated at package build time: the resulting package will have library dependency information embedded as lines for <code>ld.so</code> that hold the actual major.minor number that was used for building, and nothing for static libraries. @@ -186,16 +191,16 @@ a library proper. This will allow the port to build correctly on architectures that do not support shared libraries. <p> -In fact, providing LIB_DEPENDS lines for static libraries is a good idea: +In fact, providing LIB_DEPENDS lines even for static libraries is a good idea: this will simplify port update if a given dependency goes from a static library to a shared library. <p> -LIB_DEPENDS lines must specify the same paths that are used for -<code>ld</code>. For instance, the standard qt2 depends fragment says: -<code>LIB_DEPENDS+=lib/qt2/qt.2::x11/qt2</code>, so that the lib -depends line will be solved correctly. This allows the dependency checking -code to do the right thing when multiple versions of the same library -are encountered. +WANTLIB lines must specify the same paths that are used for +<code>ld</code>. With the same example as above, a standard qt2 depends +fragment would say +<code>WANTLIB += lib/qt2/qt.=2</code>. +This allows the dependency checking code to do the right thing when +multiple versions of the same library are encountered. <h3>Updating ports correctly</h3> @@ -206,9 +211,9 @@ <li>Verify all ports that depend on your port. Verify that they build correctly with your changes. Notify corresponding maintainers of the update, so that they can verify their ports still run correctly. - <li>You may have to adjust dependent ports LIB_DEPENDS. If you -introduce new shared libraries, watch out for BUILD_DEPENDS that need to -be turned into LIB_DEPENDS. + <li>You may have to adjust dependent ports WANTLIB and LIB_DEPENDS. +If you introduce new shared libraries, watch out for BUILD_DEPENDS +that need to be turned into LIB_DEPENDS. <li>Whenever you introduce a new port, you should verify that you are not creating a library that conflicts with an existing library: libraries from two ports with the same name are deadly, because their @@ -452,13 +457,13 @@ Its packing-list looks like this: <pre> @comment $OpenBSD: specialtopics.html,v 1.4 2009/06/24 09:28:47 ajacoutot Exp $ -bin/i-ls +...@bin bin/i-ls @info info/integrit.info @man man/man1/i-ls.1 @man man/man1/i-viewdb.1 @man man/man1/integrit.1 -sbin/i-viewdb -sbin/integrit +...@bin sbin/i-viewdb +...@bin sbin/integrit share/doc/integrit/ share/doc/integrit/README share/doc/integrit/crontab @@ -571,7 +576,7 @@ OpenBSD has its own audio layer provided by the sndio library, documented in - <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sio_open&sektion=4";>sio_open(4)</a>. + <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sio_open&sektion=3";>sio_open(3)</a>. Until it's merged into this page, you can find further information about programming for this API in the guide, <a href="http://caoua.org/alex/obsd/libsndio.html";>hints on Index: faq/ports/testing.html =================================================================== RCS file: /usr/cvs/www/faq/ports/testing.html,v retrieving revision 1.3 diff -u -r1.3 testing.html --- faq/ports/testing.html 7 May 2010 09:14:49 -0000 1.3 +++ faq/ports/testing.html 27 Jul 2010 21:23:07 -0000 @@ -11,7 +11,7 @@ </head> <!-- -Copyright (c) 2005-2009 XXX +Copyright (c) 2005-2010 XXX Permission to use, copy, modify, and distribute this documentation for any purpose with or without fee is hereby granted, provided that the
