View | Details | Raw Unified | Return to bug 169771
Collapse All | Expand All

(-)en_US.ISO8859-1/books/porters-handbook/book.sgml (-61 / +47 lines)
Lines 143-149 Link Here
143
143
144
      <para>See if you can figure it out.  Do not worry about the
144
      <para>See if you can figure it out.  Do not worry about the
145
	contents of the <literal>&dollar;FreeBSD&dollar;</literal>
145
	contents of the <literal>&dollar;FreeBSD&dollar;</literal>
146
	line, it will be filled in automatically by CVS when the port
146
	line, it will be filled in automatically by SVN when the port
147
	is imported to our main ports tree.  You can find a more
147
	is imported to our main ports tree.  You can find a more
148
	detailed example in the <link
148
	detailed example in the <link
149
	  linkend="porting-samplem">sample Makefile</link>
149
	  linkend="porting-samplem">sample Makefile</link>
Lines 716-722 Link Here
716
	<filename>patch-ab</filename> etc, always mention the path and
716
	<filename>patch-ab</filename> etc, always mention the path and
717
	file name in patch names.</para>
717
	file name in patch names.</para>
718
718
719
      <para>Do not put RCS strings in patches.  CVS will mangle them
719
      <para>Do not put RCS strings in patches.  SVN will mangle them
720
	when we put the files into the ports tree, and when we check
720
	when we put the files into the ports tree, and when we check
721
	them out again, they will come out different and the patch
721
	them out again, they will come out different and the patch
722
	will fail.  RCS strings are surrounded by dollar
722
	will fail.  RCS strings are surrounded by dollar
Lines 747-753 Link Here
747
	take a working piece of functionality from one project to fix
747
	take a working piece of functionality from one project to fix
748
	similar areas in another, please be careful: the resulting
748
	similar areas in another, please be careful: the resulting
749
	line patch may be full of non-functional changes.  It not only
749
	line patch may be full of non-functional changes.  It not only
750
	increases the size of the CVS repository but makes it hard to
750
	increases the size of the SVN repository but makes it hard to
751
	find out what exactly caused the problem and what you changed
751
	find out what exactly caused the problem and what you changed
752
	at all.</para>
752
	at all.</para>
753
753
Lines 4144-4150 Link Here
4144
	  <para>These variables are designed to be set by the system
4144
	  <para>These variables are designed to be set by the system
4145
	    administrator.  There are many that are standardized in
4145
	    administrator.  There are many that are standardized in
4146
	    the <ulink
4146
	    the <ulink
4147
	      url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&amp;content-type=text/x-cvsweb-markup"><filename>ports/KNOBS</filename></ulink>
4147
	      url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>ports/KNOBS</filename></ulink>
4148
	    file.</para>
4148
	    file.</para>
4149
4149
4150
	  <para>When creating a port, do not make knob names specific
4150
	  <para>When creating a port, do not make knob names specific
Lines 4224-4230 Link Here
4224
	    for the benefit of end-users and to help keep the number
4224
	    for the benefit of end-users and to help keep the number
4225
	    of knob names down.  A list of popular knob names can be
4225
	    of knob names down.  A list of popular knob names can be
4226
	    found in the <ulink
4226
	    found in the <ulink
4227
	      url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&amp;content-type=text/x-cvsweb-markup">KNOBS</ulink>
4227
	      url="http://svn.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>KNOBS</filename></ulink>
4228
	    file.</para>
4228
	    file.</para>
4229
4229
4230
	  <para>Knob names should reflect what the knob is and does.
4230
	  <para>Knob names should reflect what the knob is and does.
Lines 6951-6958 Link Here
6951
	  section are implemented in <filename>bsd.java.mk</filename>.
6951
	  section are implemented in <filename>bsd.java.mk</filename>.
6952
	  If you ever think that your port needs more sophisticated
6952
	  If you ever think that your port needs more sophisticated
6953
	  Java support, please first have a look at the <ulink
6953
	  Java support, please first have a look at the <ulink
6954
	    url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/Mk/bsd.java.mk">
6954
	    url="http://svn.FreeBSD.org/ports/head/Mk/bsd.java.mk?view=markup">
6955
	    bsd.java.mk CVS log</ulink> as it usually takes some time
6955
	    bsd.java.mk SVN log</ulink> as it usually takes some time
6956
	  to document the latest features.  Then, if you think the
6956
	  to document the latest features.  Then, if you think the
6957
	  support you are lacking would be beneficial to many other
6957
	  support you are lacking would be beneficial to many other
6958
	  Java ports, feel free to discuss it on the &a.java;.</para>
6958
	  Java ports, feel free to discuss it on the &a.java;.</para>
Lines 9066-9072 Link Here
9066
      </table>
9066
      </table>
9067
9067
9068
      <para>More details are available in <ulink
9068
      <para>More details are available in <ulink
9069
	  url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/Mk/bsd.database.mk">
9069
	  url="http://svn.FreeBSD.org/ports/head/Mk/bsd.database.mk?view=markup">
9070
	  bsd.database.mk</ulink>.</para>
9070
	  bsd.database.mk</ulink>.</para>
9071
    </sect1>
9071
    </sect1>
9072
9072
Lines 10204-10211 Link Here
10204
      <screen>&prompt.user; <userinput>/usr/bin/diff something.orig something > something.diff</userinput></screen>
10204
      <screen>&prompt.user; <userinput>/usr/bin/diff something.orig something > something.diff</userinput></screen>
10205
    </informalexample>
10205
    </informalexample>
10206
10206
10207
    <para>Otherwise, you should either use the <command>cvs
10207
    <para>Otherwise, you should either use the <command>svn
10208
	diff</command> method (<xref linkend="cvs-diff">) or copy the
10208
	diff</command> method (<xref linkend="svn-diff">) or copy the
10209
      contents of the port to an entire different directory and use
10209
      contents of the port to an entire different directory and use
10210
      the result of the recursive &man.diff.1; output of the new and
10210
      the result of the recursive &man.diff.1; output of the new and
10211
      old ports directories (e.g., if your modified port directory is
10211
      old ports directories (e.g., if your modified port directory is
Lines 10244-10250 Link Here
10244
      <quote>Class</quote> of your PR should be
10244
      <quote>Class</quote> of your PR should be
10245
      <literal>change-request</literal>.  Please mention any added or
10245
      <literal>change-request</literal>.  Please mention any added or
10246
      deleted files in the message, as they have to be explicitly
10246
      deleted files in the message, as they have to be explicitly
10247
      specified to &man.cvs.1; when doing a commit.  If the diff is
10247
      specified to svn when doing a commit.  If the diff is
10248
      more than about 20KB, please compress and uuencode it;
10248
      more than about 20KB, please compress and uuencode it;
10249
      otherwise, just include it in the PR as is.</para>
10249
      otherwise, just include it in the PR as is.</para>
10250
10250
Lines 10273-10283 Link Here
10273
    <para>Now that you have done all that, you will want to read about
10273
    <para>Now that you have done all that, you will want to read about
10274
      how to keep up-to-date in <xref linkend="keeping-up">.</para>
10274
      how to keep up-to-date in <xref linkend="keeping-up">.</para>
10275
10275
10276
    <sect1 id="cvs-diff">
10276
    <sect1 id="svn-diff">
10277
      <title>Using <literal>CVS</literal> to Make Patches</title>
10277
      <title>Using <literal>SVN</literal> to Make Patches</title>
10278
10278
10279
      <para>If you can, please submit a &man.cvs.1; diff; they are
10279
      <para>If you can, please submit a svn diff; they are easier to
10280
	easier to handle than diffs between <quote>new and old</quote>
10280
	handle than diffs between <quote>new and old</quote>
10281
	directories.  Plus it is easier for you to see what you have
10281
	directories.  Plus it is easier for you to see what you have
10282
	changed and to update your diff if something is modified in
10282
	changed and to update your diff if something is modified in
10283
	the Ports Collection from when you started to work on it until
10283
	the Ports Collection from when you started to work on it until
Lines 10285-10291 Link Here
10285
	something.</para>
10285
	something.</para>
10286
10286
10287
      <screen>&prompt.user; <userinput>cd ~/my_wrkdir</userinput> <co id="my-wrkdir">
10287
      <screen>&prompt.user; <userinput>cd ~/my_wrkdir</userinput> <co id="my-wrkdir">
10288
&prompt.user; <userinput>cvs -d R_CVSROOT co pdnsd</userinput> <co id="R-CVSROOT"> <co id="module-name">
10288
&prompt.user; <userinput>svn co svn://svn.FreeBSD.org/ports/head/dns/pdnsd</userinput> <co id="svn-FreeBSD-org">
10289
&prompt.user; <userinput>cd ~/my_wrkdir/pdnsd</userinput></screen>
10289
&prompt.user; <userinput>cd ~/my_wrkdir/pdnsd</userinput></screen>
10290
10290
10291
      <calloutlist>
10291
      <calloutlist>
Lines 10296-10348 Link Here
10296
	      class="directory">/usr/ports/</filename>.</para>
10296
	      class="directory">/usr/ports/</filename>.</para>
10297
	</callout>
10297
	</callout>
10298
10298
10299
	<callout arearefs="R-CVSROOT">
10299
	<callout arearefs="svn-FreeBSD-org">
10300
	  <para>R_CVSROOT is any public cvs server, see how to use cvs
10300
	  <para>svn.FreeBSD.org is a public svn server.</para>
10301
	    in the <ulink
10302
	      url="&url.books.handbook;/anoncvs.html">&os;
10303
	      Handbook</ulink>.</para>
10304
	</callout>
10301
	</callout>
10305
10306
	<callout arearefs="module-name">
10307
	  <para>pdnsd is the module name for the port; it is generally
10308
	    the name of the port, although there are some exceptions,
10309
	    notably for language-specific categories (<filename
10310
	      role="package">german/selfhtml</filename> has the module
10311
	    name de-selfhtml); you can either look up the module name
10312
	    via the <ulink
10313
	      url="&url.base;/cgi/cvsweb.cgi/ports">cvsweb
10314
	      interface</ulink> or use the whole path, in our example
10315
	    <filename
10316
	      class="directory">ports/dns/pdnsd</filename>.</para>
10317
	</callout>
10318
      </calloutlist>
10302
      </calloutlist>
10319
10303
10320
      <para>While in the working directory, make any changes that you
10304
      <para>While in the working directory, make any changes that you
10321
	would usually make to the port.  If you add or remove a file,
10305
	would usually make to the port.  If you add or remove a file,
10322
	use <command>cvs</command> to track these changes:</para>
10306
	use <command>svn</command> to track these changes:</para>
10323
10307
10324
      <screen>&prompt.user; <userinput>cvs add new_file</userinput>
10308
      <screen>&prompt.user; <userinput>svn add new_file</userinput>
10325
&prompt.user; <userinput>cvs remove deleted_file</userinput></screen>
10309
&prompt.user; <userinput>svn remove deleted_file</userinput></screen>
10326
10310
10327
      <para>Make sure that you check the port using the checklist in
10311
      <para>Make sure that you check the port using the checklist in
10328
	<xref linkend="porting-testing"> and
10312
	<xref linkend="porting-testing"> and
10329
	<xref linkend="porting-portlint">.</para>
10313
	<xref linkend="porting-portlint">.</para>
10330
10314
10331
      <screen>&prompt.user; <userinput>cvs status</userinput>
10315
      <screen>&prompt.user; <userinput>svn status</userinput>
10332
&prompt.user; <userinput>cvs update</userinput> <co id="cvs-update"></screen>
10316
&prompt.user; <userinput>svn update</userinput> <co id="svn-update"></screen>
10333
10317
10334
      <calloutlist>
10318
      <calloutlist>
10335
	<callout arearefs="cvs-update">
10319
	<callout arearefs="svn-update">
10336
	  <para>This will try to merge the differences between your
10320
	  <para>This will try to merge the differences between your
10337
	    patch and current CVS; watch the output carefully.  The
10321
	    patch and current SVN; watch the output carefully.  The
10338
	    letter in front of each file name indicates what was done
10322
	    letter in front of each file name indicates what was done
10339
	    with it.  See <xref linkend="table-cvs-up"> for a complete
10323
	    with it.  See <xref linkend="table-svn-up"> for a complete
10340
	    list.</para>
10324
	    list.</para>
10341
	</callout>
10325
	</callout>
10342
      </calloutlist>
10326
      </calloutlist>
10343
10327
10344
      <table pgwide="1" frame="none" id="table-cvs-up">
10328
      <table pgwide="1" frame="none" id="table-svn-up">
10345
	<title><literal>CVS</literal> Update File Prefixes</title>
10329
	<title><literal>SVN</literal> Update File Prefixes</title>
10346
10330
10347
	<tgroup cols="2">
10331
	<tgroup cols="2">
10348
	  <tbody>
10332
	  <tbody>
Lines 10352-10358 Link Here
10352
	    </row>
10336
	    </row>
10353
10337
10354
	    <row>
10338
	    <row>
10355
	      <entry>P</entry>
10339
	      <entry>G</entry>
10356
	      <entry>The file was updated without problems (you will
10340
	      <entry>The file was updated without problems (you will
10357
		only see this when working against a remote
10341
		only see this when working against a remote
10358
		repository).</entry>
10342
		repository).</entry>
Lines 10374-10390 Link Here
10374
      </table>
10358
      </table>
10375
10359
10376
      <para>If you get <literal>C</literal> as a result of
10360
      <para>If you get <literal>C</literal> as a result of
10377
	<literal>cvs update</literal> it means something changed in
10361
	<literal>svn update</literal> it means something changed in
10378
	the CVS and &man.cvs.1; was not able to merge your local
10362
	the SVN and svn was not able to merge your local changes and
10379
	changes and those from CVS.  It is always a good idea to
10363
	those from SVN.  It is always a good idea to inspect the
10380
	inspect the changes anyway, since <command>cvs</command> does
10364
	changes anyway, since <command>svn </command> does not know
10381
	not know anything about how a port should be, so it might (and
10365
	anything about how a port should be, so it might (and
10382
	probably will) merge things that do not make sense.</para>
10366
	probably will) merge things that do not make sense.</para>
10383
10367
10384
      <para>The last step is to make a unified &man.diff.1;
10368
      <para>The last step is to make a unified &man.diff.1;
10385
	of the files against CVS:</para>
10369
	of the files against SVN:</para>
10386
10370
10387
      <screen>&prompt.user; <userinput>cvs diff -uN &gt; ../`basename ${PWD}`.diff</userinput></screen>
10371
      <screen>&prompt.user; <userinput>svn diff -N &gt; ../`basename ${PWD}`.diff</userinput></screen>
10388
10372
10389
      <note>
10373
      <note>
10390
	<para>It is important to use <option>-N</option> to ensure
10374
	<para>It is important to use <option>-N</option> to ensure
Lines 11016-11022 Link Here
11016
      <para>The preferred way to tell 4.3BSD/Reno (1990) and newer
11000
      <para>The preferred way to tell 4.3BSD/Reno (1990) and newer
11017
	versions of the BSD code apart is by using the
11001
	versions of the BSD code apart is by using the
11018
	<literal>BSD</literal> macro defined in <ulink
11002
	<literal>BSD</literal> macro defined in <ulink
11019
	  url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>.
11003
	  url="http://svnweb.freebsd.org/base/head/sys/sys/param.h?view=markup">
11004
	  sys/param.h</ulink>.
11020
	Hopefully that file is already included; if not, add the
11005
	Hopefully that file is already included; if not, add the
11021
	code:</para>
11006
	code:</para>
11022
11007
Lines 11120-11126 Link Here
11120
      <para>Here is a convenient list of
11105
      <para>Here is a convenient list of
11121
	<literal>__FreeBSD_version</literal> values as defined in
11106
	<literal>__FreeBSD_version</literal> values as defined in
11122
	<ulink
11107
	<ulink
11123
	  url="http://cvsweb.freebsd.org/src/sys/sys/param.h">sys/param.h</ulink>:</para>
11108
	  url="http://svnweb.FreeBSD.org/base/head/sys/sys/param.h?view=markup">
11109
	  sys/param.h</ulink>:</para>
11124
11110
11125
      <table frame="none">
11111
      <table frame="none">
11126
	<title><literal>__FreeBSD_version</literal> Values</title>
11112
	<title><literal>__FreeBSD_version</literal> Values</title>
Lines 15756-15762 Link Here
15756
      <title><filename>README.html</filename></title>
15742
      <title><filename>README.html</filename></title>
15757
15743
15758
      <para>Do not include the <filename>README.html</filename> file.
15744
      <para>Do not include the <filename>README.html</filename> file.
15759
	This file is not part of the cvs collection but is generated
15745
	This file is not part of the svn collection but is generated
15760
	using the <command>make readme</command> command.</para>
15746
	using the <command>make readme</command> command.</para>
15761
15747
15762
      <note>
15748
      <note>
Lines 16101-16109 Link Here
16101
# Whom:                        Satoshi Asami &lt;asami@FreeBSD.org&gt;
16087
# Whom:                        Satoshi Asami &lt;asami@FreeBSD.org&gt;
16102
#
16088
#
16103
# &dollar;FreeBSD&dollar;
16089
# &dollar;FreeBSD&dollar;
16104
[ ^^^^^^^^^ This will be automatically replaced with RCS ID string by CVS
16090
[ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN
16105
when it is committed to our repository.  If upgrading a port, do not alter
16091
when it is committed to our repository.  If upgrading a port, do not alter
16106
this line back to "&dollar;FreeBSD&dollar;".  CVS deals with it automatically.]
16092
this line back to "&dollar;FreeBSD&dollar;".  SVN deals with it automatically.]
16107
#
16093
#
16108
16094
16109
[section to describe the port itself and the master site - PORTNAME
16095
[section to describe the port itself and the master site - PORTNAME
Lines 16214-16232 Link Here
16214
	commits.</para>
16200
	commits.</para>
16215
    </sect1>
16201
    </sect1>
16216
16202
16217
    <sect1 id="cvsweb">
16203
    <sect1 id="svnweb">
16218
      <title>The Web Interface to the Source Repository</title>
16204
      <title>The Web Interface to the Source Repository</title>
16219
16205
16220
      <para>It is possible to browse the files in the source
16206
      <para>It is possible to browse the files in the source
16221
	repository by using a web interface.  Changes that affect the
16207
	repository by using a web interface.  Changes that affect the
16222
	entire port system are now documented in the <ulink
16208
	entire port system are now documented in the <ulink
16223
	  url="http://cvsweb.FreeBSD.org/ports/CHANGES">
16209
	  url="http://svnweb.FreeBSD.org/ports/head/CHANGES">
16224
	  CHANGES</ulink> file.  Changes that affect individual ports
16210
	  CHANGES</ulink> file.  Changes that affect individual ports
16225
	are now documented in the <ulink
16211
	are now documented in the <ulink
16226
	  url="http://cvsweb.FreeBSD.org/ports/UPDATING">
16212
	  url="http://svnweb.FreeBSD.org/ports/head/UPDATING">
16227
	  UPDATING</ulink> file.  However, the definitive answer to
16213
	  UPDATING</ulink> file.  However, the definitive answer to
16228
	any question is undoubtedly to read the source code of <ulink
16214
	any question is undoubtedly to read the source code of <ulink
16229
	  url="http://cvsweb.FreeBSD.org/ports/Mk/bsd.port.mk">
16215
	  url="http://svnweb.FreeBSD.org/ports/head/Mk/bsd.port.mk">
16230
	  bsd.port.mk</ulink>, and associated files.</para>
16216
	  bsd.port.mk</ulink>, and associated files.</para>
16231
    </sect1>
16217
    </sect1>

Return to bug 169771