From owner-freebsd-ports@FreeBSD.ORG Wed Jun 1 05:04:14 2011 Return-Path: Delivered-To: freebsd-ports@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 5746B10661D9; Wed, 1 Jun 2011 05:04:14 +0000 (UTC) (envelope-from linimon@lonesome.com) Received: from mail.soaustin.net (pancho.soaustin.net [76.74.250.40]) by mx1.freebsd.org (Postfix) with ESMTP id 2B5008FC0C; Wed, 1 Jun 2011 05:04:13 +0000 (UTC) Received: by mail.soaustin.net (Postfix, from userid 502) id 6C18E56210; Wed, 1 Jun 2011 00:04:13 -0500 (CDT) Date: Wed, 1 Jun 2011 00:04:13 -0500 From: Mark Linimon To: freebsd-ports@FreeBSD.org Message-ID: <20110601050413.GA29907@lonesome.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.20 (2009-06-14) Cc: portmgr@FreeBSD.org Subject: RFC: some patches to the Porter's Handbook X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 01 Jun 2011 05:04:14 -0000 When going through the "Using" sections, I always get irritated by having to figure out where the makevars that they are talking about are defined. This patch adds some crossrefs to the CVSWeb pages for them. (In a few cases, the filenames were mentioned, but they weren't CVSWeb references.) Does anyone have any objection to the following? mcl Index: book.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.1106 diff -u -r1.1106 book.sgml --- book.sgml 1 Jun 2011 04:15:04 -0000 1.1106 +++ book.sgml 1 Jun 2011 04:58:40 -0000 @@ -68,7 +68,11 @@ When this document is not sufficiently detailed, you should refer to /usr/ports/Mk/bsd.port.mk, which - all port Makefiles include. Even if you do not hack Makefiles + all port Makefiles include. + (For reference, you can view the + + current contents of bsd.port.mk on the web.) + Even if you do not hack Makefiles daily, it is well commented, and you will still gain much knowledge from it. Additionally, you may send specific questions to the &a.ports;. @@ -441,7 +445,9 @@ First, this is the sequence of events which occurs when the user first types make in your port's directory. - You may find that having bsd.port.mk in another + You may find that having + bsd.port.mk + in another window while you read this really helps to understand it. But do not worry if you do not really understand what @@ -3545,7 +3551,7 @@ - The <makevar>USE_<replaceable>*</replaceable></makevar> + <title>Common <makevar>USE_<replaceable>*</replaceable></makevar> variables @@ -4019,6 +4025,10 @@ Use make showconfig to see the saved configuration. Use make rmconfig to remove the saved configuration. + + For the complete details of how OPTIONS work, see + + bsd.options.mk. @@ -4888,6 +4898,10 @@
+ More details are available in + + bsd.scons.mk. + To make third party SConstruct respect everything that is passed to SCons in SCONS_ENV (that is, most importantly, @@ -4940,6 +4954,10 @@ for cross-development work. This can also be accomplished by installing the devel/autotools port. + More details are available in + + bsd.autotools.mk. + @@ -5349,8 +5367,9 @@ xprintutil xpr oto xproxymngproto xrandr xrender xres xscrnsaver xt xtrans xtrap xtst xv xvmc xxf86dga xxf86misc xxf86vm. - Always up-to-date list can be found in - /usr/ports/Mk/bsd.xorg.mk. + The most up-to-date list can be found in + + bsd.xorg.mk. The Mesa Project is an effort to provide free OpenGL implementation. You can specify a dependency on various components @@ -5632,6 +5651,10 @@ list of these variables exists within the FreeBSD/GNOME project's homepage. + More details are available in + + bsd.gnome.mk. + @@ -5758,6 +5781,10 @@ CONFIGURE_ENV+= UIC="${UIC}" QMAKE="${QMAKE}" QMAKESPEC="${QMAKESPEC}" MAKE_ENV+= QMAKESPEC="${QMAKESPEC}" + More details are available in + + bsd.qt.mk. + @@ -5987,6 +6014,10 @@ Using KDE + More details are available in + + bsd.kde.mk. + Variable definitions (KDE 3.x only) @@ -6422,6 +6453,10 @@ ) and SUB_LIST. + More details are available in + + bsd.java.mk. + @@ -6444,7 +6479,7 @@ - Best practices + Best practices for Java ports When porting a Java library, your port should install the JAR file(s) in ${JAVAJARDIR}, and everything @@ -6664,6 +6699,11 @@ + + More details are available in + + bsd.apache.mk. + @@ -6775,8 +6815,13 @@ + + More details are available in + + bsd.php.mk. + @@ -6825,6 +6870,10 @@ + More details are available in + + bsd.pear.mk. + @@ -6949,8 +6998,9 @@ - A complete list of available variables can be found in - /usr/ports/Mk/bsd.python.mk. + More details are available in + + bsd.python.mk. @@ -7057,14 +7107,21 @@ - A complete list of available variables can be found in - /usr/ports/Mk/bsd.tcl.mk. + More details are available in + + bsd.tcl.mk. + Using Emacs This section is yet to be written. + + More details are available in + + bsd.emacs.mk. + @@ -7188,8 +7245,9 @@ - A complete list of available variables can be found in - /usr/ports/Mk/bsd.ruby.mk. + More details are available in + + bsd.ruby.mk. @@ -7289,6 +7347,10 @@ .include <bsd.port.post.mk> + More details are available in + + bsd.sdl.mk. + @@ -7298,6 +7360,10 @@ wxWidgets libraries in the ports tree and its integration with the ports system. + More details are available in + + bsd.wx.mk. + Introduction @@ -7924,6 +7990,10 @@ Lua libraries in the ports tree and its integration with the ports system. + More details are available in + + bsd.lua.mk. + Introduction @@ -8554,6 +8624,11 @@ the syntax will be: USE_XFCE= mcsmanager configenv + + More details are available in + + bsd.xfce.mk. + @@ -8634,8 +8709,11 @@ - A complete list of available variables can be found in - /usr/ports/Mk/bsd.gecko.mk. + + More details are available in + + bsd.gecko.mk. +