docs/169771: [PATCH] [handbook] Add ports svn information
Beat Gätzi
beat at FreeBSD.org
Tue Jul 10 19:50:12 UTC 2012
>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 at 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 @@
<para>See if you can figure it out. Do not worry about the
contents of the <literal>$FreeBSD$</literal>
- 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 <link
linkend="porting-samplem">sample Makefile</link>
@@ -716,7 +716,7 @@
<filename>patch-ab</filename> etc, always mention the path and
file name in patch names.</para>
- <para>Do not put RCS strings in patches. CVS will mangle them
+ <para>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.</para>
@@ -4144,7 +4144,7 @@
<para>These variables are designed to be set by the system
administrator. There are many that are standardized in
the <ulink
- url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&content-type=text/x-cvsweb-markup"><filename>ports/KNOBS</filename></ulink>
+ url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>ports/KNOBS</filename></ulink>
file.</para>
<para>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 <ulink
- url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&content-type=text/x-cvsweb-markup">KNOBS</ulink>
+ url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>KNOBS</filename></ulink>
file.</para>
<para>Knob names should reflect what the knob is and does.
@@ -6951,8 +6951,8 @@
section are implemented in <filename>bsd.java.mk</filename>.
If you ever think that your port needs more sophisticated
Java support, please first have a look at the <ulink
- url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/Mk/bsd.java.mk">
- bsd.java.mk CVS log</ulink> as it usually takes some time
+ url="http://svn.FreeBSD.org/ports/head/Mk/bsd.java.mk?view=markup">
+ bsd.java.mk SVN log</ulink> 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;.</para>
@@ -9066,7 +9066,7 @@
</table>
<para>More details are available in <ulink
- url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/Mk/bsd.database.mk">
+ url="http://svn.FreeBSD.org/ports/head/Mk/bsd.database.mk?view=markup">
bsd.database.mk</ulink>.</para>
</sect1>
@@ -10204,8 +10204,8 @@
<screen>&prompt.user; <userinput>/usr/bin/diff something.orig something > something.diff</userinput></screen>
</informalexample>
- <para>Otherwise, you should either use the <command>cvs
- diff</command> method (<xref linkend="cvs-diff">) or copy the
+ <para>Otherwise, you should either use the <command>svn
+ diff</command> method (<xref linkend="svn-diff">) 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 @@
<quote>Class</quote> of your PR should be
<literal>change-request</literal>. 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.</para>
@@ -10273,11 +10273,11 @@
<para>Now that you have done all that, you will want to read about
how to keep up-to-date in <xref linkend="keeping-up">.</para>
- <sect1 id="cvs-diff">
- <title>Using <literal>CVS</literal> to Make Patches</title>
+ <sect1 id="svn-diff">
+ <title>Using <literal>SVN</literal> to Make Patches</title>
- <para>If you can, please submit a &man.cvs.1; diff; they are
- easier to handle than diffs between <quote>new and old</quote>
+ <para>If you can, please submit a svn diff; they are easier to
+ handle than diffs between <quote>new and old</quote>
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.</para>
<screen>&prompt.user; <userinput>cd ~/my_wrkdir</userinput> <co id="my-wrkdir">
-&prompt.user; <userinput>cvs -d R_CVSROOT co pdnsd</userinput> <co id="R-CVSROOT"> <co id="module-name">
+&prompt.user; <userinput>svn co svn://svn.FreeBSD.org/ports/head/dns/pdnsd</userinput> <co id="svn-FreeBSD-org">
&prompt.user; <userinput>cd ~/my_wrkdir/pdnsd</userinput></screen>
<calloutlist>
@@ -10296,53 +10296,37 @@
class="directory">/usr/ports/</filename>.</para>
</callout>
- <callout arearefs="R-CVSROOT">
- <para>R_CVSROOT is any public cvs server, see how to use cvs
- in the <ulink
- url="&url.books.handbook;/anoncvs.html">&os;
- Handbook</ulink>.</para>
+ <callout arearefs="svn-FreeBSD-org">
+ <para>svn.FreeBSD.org is a public svn server.</para>
</callout>
-
- <callout arearefs="module-name">
- <para>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 (<filename
- role="package">german/selfhtml</filename> has the module
- name de-selfhtml); you can either look up the module name
- via the <ulink
- url="&url.base;/cgi/cvsweb.cgi/ports">cvsweb
- interface</ulink> or use the whole path, in our example
- <filename
- class="directory">ports/dns/pdnsd</filename>.</para>
- </callout>
</calloutlist>
<para>While in the working directory, make any changes that you
would usually make to the port. If you add or remove a file,
- use <command>cvs</command> to track these changes:</para>
+ use <command>svn</command> to track these changes:</para>
- <screen>&prompt.user; <userinput>cvs add new_file</userinput>
-&prompt.user; <userinput>cvs remove deleted_file</userinput></screen>
+ <screen>&prompt.user; <userinput>svn add new_file</userinput>
+&prompt.user; <userinput>svn remove deleted_file</userinput></screen>
<para>Make sure that you check the port using the checklist in
<xref linkend="porting-testing"> and
<xref linkend="porting-portlint">.</para>
- <screen>&prompt.user; <userinput>cvs status</userinput>
-&prompt.user; <userinput>cvs update</userinput> <co id="cvs-update"></screen>
+ <screen>&prompt.user; <userinput>svn status</userinput>
+&prompt.user; <userinput>svn update</userinput> <co id="svn-update"></screen>
<calloutlist>
- <callout arearefs="cvs-update">
+ <callout arearefs="svn-update">
<para>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 <xref linkend="table-cvs-up"> for a complete
+ with it. See <xref linkend="table-svn-up"> for a complete
list.</para>
</callout>
</calloutlist>
- <table pgwide="1" frame="none" id="table-cvs-up">
- <title><literal>CVS</literal> Update File Prefixes</title>
+ <table pgwide="1" frame="none" id="table-svn-up">
+ <title><literal>SVN</literal> Update File Prefixes</title>
<tgroup cols="2">
<tbody>
@@ -10352,7 +10336,7 @@
</row>
<row>
- <entry>P</entry>
+ <entry>G</entry>
<entry>The file was updated without problems (you will
only see this when working against a remote
repository).</entry>
@@ -10374,17 +10358,17 @@
</table>
<para>If you get <literal>C</literal> as a result of
- <literal>cvs update</literal> 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 <command>cvs</command> does
- not know anything about how a port should be, so it might (and
+ <literal>svn update</literal> 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 <command>svn </command> does not know
+ anything about how a port should be, so it might (and
probably will) merge things that do not make sense.</para>
<para>The last step is to make a unified &man.diff.1;
- of the files against CVS:</para>
+ of the files against SVN:</para>
- <screen>&prompt.user; <userinput>cvs diff -uN > ../`basename ${PWD}`.diff</userinput></screen>
+ <screen>&prompt.user; <userinput>svn diff -N > ../`basename ${PWD}`.diff</userinput></screen>
<note>
<para>It is important to use <option>-N</option> to ensure
@@ -11016,7 +11000,8 @@
<para>The preferred way to tell 4.3BSD/Reno (1990) and newer
versions of the BSD code apart is by using the
<literal>BSD</literal> macro defined in <ulink
- url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>.
+ url="http://svnweb.freebsd.org/base/head/sys/sys/param.h?view=markup">
+ sys/param.h</ulink>.
Hopefully that file is already included; if not, add the
code:</para>
@@ -11120,7 +11105,8 @@
<para>Here is a convenient list of
<literal>__FreeBSD_version</literal> values as defined in
<ulink
- url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>:</para>
+ url="http://svnweb.FreeBSD.org/base/head/sys/sys/param.h?view=markup">
+ sys/param.h</ulink>:</para>
<table frame="none">
<title><literal>__FreeBSD_version</literal> Values</title>
@@ -15756,7 +15742,7 @@
<title><filename>README.html</filename></title>
<para>Do not include the <filename>README.html</filename> 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 <command>make readme</command> command.</para>
<note>
@@ -16101,9 +16087,9 @@
# Whom: Satoshi Asami <asami at 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.</para>
</sect1>
- <sect1 id="cvsweb">
+ <sect1 id="svnweb">
<title>The Web Interface to the Source Repository</title>
<para>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 <ulink
- url="http://cvsweb.FreeBSD.org/ports/CHANGES">
+ url="http://svnweb.FreeBSD.org/ports/head/CHANGES">
CHANGES</ulink> file. Changes that affect individual ports
are now documented in the <ulink
- url="http://cvsweb.FreeBSD.org/ports/UPDATING">
+ url="http://svnweb.FreeBSD.org/ports/head/UPDATING">
UPDATING</ulink> file. However, the definitive answer to
any question is undoubtedly to read the source code of <ulink
- url="http://cvsweb.FreeBSD.org/ports/Mk/bsd.port.mk">
+ url="http://svnweb.FreeBSD.org/ports/head/Mk/bsd.port.mk">
bsd.port.mk</ulink>, and associated files.</para>
</sect1>
--- porters-hanbook-svn.patch ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list