From owner-freebsd-doc@FreeBSD.ORG Tue Jul 10 19:50:12 2012 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 9A84D106567A for ; Tue, 10 Jul 2012 19:50:12 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 80C618FC20 for ; Tue, 10 Jul 2012 19:50:08 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.5/8.14.5) with ESMTP id q6AJo8Lf062165 for ; Tue, 10 Jul 2012 19:50:08 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.5/8.14.5/Submit) id q6AJo84s062164; Tue, 10 Jul 2012 19:50:08 GMT (envelope-from gnats) Resent-Date: Tue, 10 Jul 2012 19:50:08 GMT Resent-Message-Id: <201207101950.q6AJo84s062164@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Beat Gätzi Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id ED103106566B for ; Tue, 10 Jul 2012 19:46:54 +0000 (UTC) (envelope-from beat@tinderbox.chruetertee.ch) Received: from tinderbox.chruetertee.ch (cl-104.gva-01.ch.sixxs.net [IPv6:2a02:2528:ff00:67::2]) by mx1.freebsd.org (Postfix) with ESMTP id 250E18FC14 for ; Tue, 10 Jul 2012 19:46:53 +0000 (UTC) Received: from tinderbox.chruetertee.ch (localhost [127.0.0.1]) by tinderbox.chruetertee.ch (8.14.5/8.14.5) with ESMTP id q6AJkq7I048639 for ; Tue, 10 Jul 2012 21:46:52 +0200 (CEST) (envelope-from beat@tinderbox.chruetertee.ch) Received: (from beat@localhost) by tinderbox.chruetertee.ch (8.14.5/8.14.5/Submit) id q6AJkl3B048335; Tue, 10 Jul 2012 21:46:47 +0200 (CEST) (envelope-from beat) Message-Id: <201207101946.q6AJkl3B048335@tinderbox.chruetertee.ch> Date: Tue, 10 Jul 2012 21:46:47 +0200 (CEST) From: Beat Gätzi To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Cc: Subject: docs/169771: [PATCH] [handbook] Add ports svn information X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Beat Gätzi List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 10 Jul 2012 19:50:12 -0000 >Number: 169771 >Category: docs >Synopsis: [PATCH] [handbook] Add ports svn information >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: update >Submitter-Id: current-users >Arrival-Date: Tue Jul 10 19:50:08 UTC 2012 >Closed-Date: >Last-Modified: >Originator: Beat Gätzi >Release: FreeBSD 10.0-CURRENT i386 >Organization: >Environment: System: FreeBSD tinderbox.chruetertee.ch 10.0-CURRENT FreeBSD 10.0-CURRENT #1 r237414M: Fri Jun 22 10:55:48 CEST 2012 root@tinderbox.chruetertee.ch:/usr/obj/usr/home/beat/dev/src/head/sys/BEASTIE i386 >Description: The ports tree will migrate to SVN soon and attached patch updates the porters handbook with the needed information. Would it be possible if someone can review and approve the patch so that I can update the handbook after the switch to SVN? >How-To-Repeat: >Fix: --- porters-hanbook-svn.patch begins here --- Index: en_US.ISO8859-1/books/porters-handbook/book.sgml =================================================================== --- en_US.ISO8859-1/books/porters-handbook/book.sgml (Revision 39185) +++ en_US.ISO8859-1/books/porters-handbook/book.sgml (Arbeitskopie) @@ -143,7 +143,7 @@ See if you can figure it out. Do not worry about the contents of the $FreeBSD$ - line, it will be filled in automatically by CVS when the port + line, it will be filled in automatically by SVN when the port is imported to our main ports tree. You can find a more detailed example in the sample Makefile @@ -716,7 +716,7 @@ patch-ab etc, always mention the path and file name in patch names. - Do not put RCS strings in patches. CVS will mangle them + Do not put RCS strings in patches. SVN will mangle them when we put the files into the ports tree, and when we check them out again, they will come out different and the patch will fail. RCS strings are surrounded by dollar @@ -747,7 +747,7 @@ take a working piece of functionality from one project to fix similar areas in another, please be careful: the resulting line patch may be full of non-functional changes. It not only - increases the size of the CVS repository but makes it hard to + increases the size of the SVN repository but makes it hard to find out what exactly caused the problem and what you changed at all. @@ -4144,7 +4144,7 @@ These variables are designed to be set by the system administrator. There are many that are standardized in the ports/KNOBS + url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup">ports/KNOBS file. When creating a port, do not make knob names specific @@ -4224,7 +4224,7 @@ for the benefit of end-users and to help keep the number of knob names down. A list of popular knob names can be found in the KNOBS + url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup">KNOBS file. Knob names should reflect what the knob is and does. @@ -6951,8 +6951,8 @@ section are implemented in bsd.java.mk. If you ever think that your port needs more sophisticated Java support, please first have a look at the - bsd.java.mk CVS log as it usually takes some time + url="http://svn.FreeBSD.org/ports/head/Mk/bsd.java.mk?view=markup"> + bsd.java.mk SVN log as it usually takes some time to document the latest features. Then, if you think the support you are lacking would be beneficial to many other Java ports, feel free to discuss it on the &a.java;. @@ -9066,7 +9066,7 @@ More details are available in + url="http://svn.FreeBSD.org/ports/head/Mk/bsd.database.mk?view=markup"> bsd.database.mk. @@ -10204,8 +10204,8 @@ &prompt.user; /usr/bin/diff something.orig something > something.diff - Otherwise, you should either use the cvs - diff method () or copy the + Otherwise, you should either use the svn + diff method () or copy the contents of the port to an entire different directory and use the result of the recursive &man.diff.1; output of the new and old ports directories (e.g., if your modified port directory is @@ -10244,7 +10244,7 @@ Class of your PR should be change-request. Please mention any added or deleted files in the message, as they have to be explicitly - specified to &man.cvs.1; when doing a commit. If the diff is + specified to svn when doing a commit. If the diff is more than about 20KB, please compress and uuencode it; otherwise, just include it in the PR as is. @@ -10273,11 +10273,11 @@ Now that you have done all that, you will want to read about how to keep up-to-date in . - - Using <literal>CVS</literal> to Make Patches + + Using <literal>SVN</literal> to Make Patches - If you can, please submit a &man.cvs.1; diff; they are - easier to handle than diffs between new and old + If you can, please submit a svn diff; they are easier to + handle than diffs between new and old directories. Plus it is easier for you to see what you have changed and to update your diff if something is modified in the Ports Collection from when you started to work on it until @@ -10285,7 +10285,7 @@ something. &prompt.user; cd ~/my_wrkdir -&prompt.user; cvs -d R_CVSROOT co pdnsd +&prompt.user; svn co svn://svn.FreeBSD.org/ports/head/dns/pdnsd &prompt.user; cd ~/my_wrkdir/pdnsd @@ -10296,53 +10296,37 @@ class="directory">/usr/ports/. - - R_CVSROOT is any public cvs server, see how to use cvs - in the &os; - Handbook. + + svn.FreeBSD.org is a public svn server. - - - pdnsd is the module name for the port; it is generally - the name of the port, although there are some exceptions, - notably for language-specific categories (german/selfhtml has the module - name de-selfhtml); you can either look up the module name - via the cvsweb - interface or use the whole path, in our example - ports/dns/pdnsd. - While in the working directory, make any changes that you would usually make to the port. If you add or remove a file, - use cvs to track these changes: + use svn to track these changes: - &prompt.user; cvs add new_file -&prompt.user; cvs remove deleted_file + &prompt.user; svn add new_file +&prompt.user; svn remove deleted_file Make sure that you check the port using the checklist in and . - &prompt.user; cvs status -&prompt.user; cvs update + &prompt.user; svn status +&prompt.user; svn update - + This will try to merge the differences between your - patch and current CVS; watch the output carefully. The + patch and current SVN; watch the output carefully. The letter in front of each file name indicates what was done - with it. See for a complete + with it. See for a complete list. - - <literal>CVS</literal> Update File Prefixes +
+ <literal>SVN</literal> Update File Prefixes @@ -10352,7 +10336,7 @@ - P + G The file was updated without problems (you will only see this when working against a remote repository). @@ -10374,17 +10358,17 @@
If you get C as a result of - cvs update it means something changed in - the CVS and &man.cvs.1; was not able to merge your local - changes and those from CVS. It is always a good idea to - inspect the changes anyway, since cvs does - not know anything about how a port should be, so it might (and + svn update it means something changed in + the SVN and svn was not able to merge your local changes and + those from SVN. It is always a good idea to inspect the + changes anyway, since svn does not know + anything about how a port should be, so it might (and probably will) merge things that do not make sense. The last step is to make a unified &man.diff.1; - of the files against CVS: + of the files against SVN: - &prompt.user; cvs diff -uN > ../`basename ${PWD}`.diff + &prompt.user; svn diff -N > ../`basename ${PWD}`.diff It is important to use to ensure @@ -11016,7 +11000,8 @@ The preferred way to tell 4.3BSD/Reno (1990) and newer versions of the BSD code apart is by using the BSD macro defined in sys/param.h. + url="http://svnweb.freebsd.org/base/head/sys/sys/param.h?view=markup"> + sys/param.h. Hopefully that file is already included; if not, add the code: @@ -11120,7 +11105,8 @@ Here is a convenient list of __FreeBSD_version values as defined in sys/param.h: + url="http://svnweb.FreeBSD.org/base/head/sys/sys/param.h?view=markup"> + sys/param.h: <literal>__FreeBSD_version</literal> Values @@ -15756,7 +15742,7 @@ <filename>README.html</filename>Do not include the README.html file. - This file is not part of the cvs collection but is generated + This file is not part of the svn collection but is generated using the make readme command. @@ -16101,9 +16087,9 @@ # Whom: Satoshi Asami <asami@FreeBSD.org> # # $FreeBSD$ -[ ^^^^^^^^^ This will be automatically replaced with RCS ID string by CVS +[ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN when it is committed to our repository. If upgrading a port, do not alter -this line back to "$FreeBSD$". CVS deals with it automatically.] +this line back to "$FreeBSD$". SVN deals with it automatically.] # [section to describe the port itself and the master site - PORTNAME @@ -16214,19 +16200,19 @@ commits. - + The Web Interface to the Source Repository It is possible to browse the files in the source repository by using a web interface. Changes that affect the entire port system are now documented in the + url="http://svnweb.FreeBSD.org/ports/head/CHANGES"> CHANGES file. Changes that affect individual ports are now documented in the + url="http://svnweb.FreeBSD.org/ports/head/UPDATING"> UPDATING file. However, the definitive answer to any question is undoubtedly to read the source code of + url="http://svnweb.FreeBSD.org/ports/head/Mk/bsd.port.mk"> bsd.port.mk, and associated files. --- porters-hanbook-svn.patch ends here --- >Release-Note: >Audit-Trail: >Unformatted: