Date: Sun, 8 Sep 2013 00:16:30 +0000 (UTC) From: Glen Barber <gjb@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-translations@freebsd.org Subject: svn commit: r42627 - in translations/en_US.ISO8859-1: articles/committers-guide articles/console-server articles/contributing articles/contributors articles/cvs-freebsd articles/freebsd-update-serv... Message-ID: <201309080016.r880GU0x000659@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: gjb Date: Sun Sep 8 00:16:29 2013 New Revision: 42627 URL: http://svnweb.freebsd.org/changeset/doc/42627 Log: MFH: Merged /projects/print2013/en_US.ISO8859-1:r40693-40726 Merged /projects/entities/en_US.ISO8859-1:r40180-42225 Merged /projects/ISBN_1-57176-407-0/en_US.ISO8859-1:r40727-41455, 41457-41469,41472-41477,41479-41513,41515-41521,41523-41577, 41579-41581,41583-42013 Merged /head/en_US.ISO8859-1:r41736-42626 Approved by: doceng (implicit) Added: translations/en_US.ISO8859-1/books/fdp-primer/docbook-markup/ - copied from r42626, head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/ translations/en_US.ISO8859-1/books/fdp-primer/editor-config/ - copied from r42626, head/en_US.ISO8859-1/books/fdp-primer/editor-config/ translations/en_US.ISO8859-1/books/fdp-primer/working-copy/ - copied from r42626, head/en_US.ISO8859-1/books/fdp-primer/working-copy/ translations/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/ - copied from r42626, head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/ translations/en_US.ISO8859-1/books/fdp-primer/xml-primer/ - copied from r42626, head/en_US.ISO8859-1/books/fdp-primer/xml-primer/ translations/en_US.ISO8859-1/htdocs/java/links.xml - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/java/links.xml translations/en_US.ISO8859-1/htdocs/news/status/report-2013-04-2013-06.xml - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/news/status/report-2013-04-2013-06.xml translations/en_US.ISO8859-1/htdocs/news/status/report-2013-05-devsummit.xml - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/news/status/report-2013-05-devsummit.xml translations/en_US.ISO8859-1/htdocs/releases/10.0R/ - copied from r42626, head/en_US.ISO8859-1/htdocs/releases/10.0R/ translations/en_US.ISO8859-1/htdocs/releases/8.4R/announce.xml - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/announce.xml translations/en_US.ISO8859-1/htdocs/releases/8.4R/errata.html - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/errata.html translations/en_US.ISO8859-1/htdocs/releases/8.4R/hardware.html - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/hardware.html translations/en_US.ISO8859-1/htdocs/releases/8.4R/installation.html - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/installation.html translations/en_US.ISO8859-1/htdocs/releases/8.4R/readme.html - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/readme.html translations/en_US.ISO8859-1/htdocs/releases/8.4R/relnotes-detailed.html - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/relnotes-detailed.html translations/en_US.ISO8859-1/htdocs/releases/8.4R/relnotes.xml - copied unchanged from r42626, head/en_US.ISO8859-1/htdocs/releases/8.4R/relnotes.xml translations/en_US.ISO8859-1/htdocs/releases/9.2R/ - copied from r42626, head/en_US.ISO8859-1/htdocs/releases/9.2R/ Deleted: translations/en_US.ISO8859-1/books/fdp-primer/psgml-mode/ translations/en_US.ISO8859-1/books/fdp-primer/sgml-markup/ translations/en_US.ISO8859-1/books/fdp-primer/sgml-primer/ translations/en_US.ISO8859-1/books/handbook/vinum/ translations/en_US.ISO8859-1/htdocs/docproj/todo.xml translations/en_US.ISO8859-1/htdocs/java/advocacy.xml translations/en_US.ISO8859-1/htdocs/java/dists/15.xml translations/en_US.ISO8859-1/htdocs/java/docs/ translations/en_US.ISO8859-1/htdocs/java/links/ translations/en_US.ISO8859-1/htdocs/projects/bigdisk/ translations/en_US.ISO8859-1/htdocs/search/opensearch/cvsweb.xml Modified: translations/en_US.ISO8859-1/articles/committers-guide/article.xml translations/en_US.ISO8859-1/articles/console-server/article.xml translations/en_US.ISO8859-1/articles/contributing/article.xml translations/en_US.ISO8859-1/articles/contributors/article.xml translations/en_US.ISO8859-1/articles/contributors/contrib.additional.xml translations/en_US.ISO8859-1/articles/contributors/contrib.committers.xml translations/en_US.ISO8859-1/articles/contributors/contrib.corealumni.xml translations/en_US.ISO8859-1/articles/contributors/contrib.develalumni.xml translations/en_US.ISO8859-1/articles/contributors/contrib.develinmemoriam.xml translations/en_US.ISO8859-1/articles/contributors/contrib.portmgralumni.xml translations/en_US.ISO8859-1/articles/cvs-freebsd/article.xml translations/en_US.ISO8859-1/articles/freebsd-update-server/article.xml translations/en_US.ISO8859-1/articles/gjournal-desktop/article.xml translations/en_US.ISO8859-1/articles/hubs/article.xml translations/en_US.ISO8859-1/articles/linux-emulation/article.xml translations/en_US.ISO8859-1/articles/mailing-list-faq/article.xml translations/en_US.ISO8859-1/articles/nanobsd/article.xml translations/en_US.ISO8859-1/articles/pam/article.xml translations/en_US.ISO8859-1/articles/releng-packages/article.xml translations/en_US.ISO8859-1/articles/releng/article.xml translations/en_US.ISO8859-1/articles/remote-install/article.xml translations/en_US.ISO8859-1/articles/serial-uart/article.xml translations/en_US.ISO8859-1/articles/vm-design/article.xml translations/en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml translations/en_US.ISO8859-1/books/arch-handbook/sound/chapter.xml translations/en_US.ISO8859-1/books/dev-model/book.xml translations/en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml translations/en_US.ISO8859-1/books/developers-handbook/testing/chapter.xml translations/en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml translations/en_US.ISO8859-1/books/faq/book.xml translations/en_US.ISO8859-1/books/fdp-primer/Makefile translations/en_US.ISO8859-1/books/fdp-primer/book.xml translations/en_US.ISO8859-1/books/fdp-primer/chapters.ent translations/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml translations/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml translations/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml translations/en_US.ISO8859-1/books/handbook/Makefile translations/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml translations/en_US.ISO8859-1/books/handbook/audit/chapter.xml translations/en_US.ISO8859-1/books/handbook/basics/chapter.xml translations/en_US.ISO8859-1/books/handbook/book.xml translations/en_US.ISO8859-1/books/handbook/boot/chapter.xml translations/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.xml translations/en_US.ISO8859-1/books/handbook/chapters.ent translations/en_US.ISO8859-1/books/handbook/config/chapter.xml translations/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.xml translations/en_US.ISO8859-1/books/handbook/desktop/chapter.xml translations/en_US.ISO8859-1/books/handbook/disks/chapter.xml translations/en_US.ISO8859-1/books/handbook/dtrace/chapter.xml translations/en_US.ISO8859-1/books/handbook/eresources/chapter.xml translations/en_US.ISO8859-1/books/handbook/filesystems/chapter.xml translations/en_US.ISO8859-1/books/handbook/firewalls/chapter.xml translations/en_US.ISO8859-1/books/handbook/geom/chapter.xml translations/en_US.ISO8859-1/books/handbook/install/chapter.xml translations/en_US.ISO8859-1/books/handbook/introduction/chapter.xml translations/en_US.ISO8859-1/books/handbook/jails/chapter.xml translations/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.xml translations/en_US.ISO8859-1/books/handbook/l10n/chapter.xml translations/en_US.ISO8859-1/books/handbook/linuxemu/chapter.xml translations/en_US.ISO8859-1/books/handbook/mac/chapter.xml translations/en_US.ISO8859-1/books/handbook/mail/chapter.xml translations/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml translations/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml translations/en_US.ISO8859-1/books/handbook/network-servers/chapter.xml translations/en_US.ISO8859-1/books/handbook/ports/chapter.xml translations/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml translations/en_US.ISO8859-1/books/handbook/preface/preface.xml translations/en_US.ISO8859-1/books/handbook/printing/chapter.xml translations/en_US.ISO8859-1/books/handbook/security/chapter.xml translations/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml translations/en_US.ISO8859-1/books/handbook/users/chapter.xml translations/en_US.ISO8859-1/books/handbook/x11/chapter.xml translations/en_US.ISO8859-1/books/pmake/gods/chapter.xml translations/en_US.ISO8859-1/books/porters-handbook/book.xml translations/en_US.ISO8859-1/books/porters-handbook/uses.xml translations/en_US.ISO8859-1/htdocs/administration.xml translations/en_US.ISO8859-1/htdocs/advocacy/myths.xml translations/en_US.ISO8859-1/htdocs/cgi/cgi-style.pl translations/en_US.ISO8859-1/htdocs/cgi/man.cgi translations/en_US.ISO8859-1/htdocs/cgi/monthly.cgi translations/en_US.ISO8859-1/htdocs/community/mailinglists.xml translations/en_US.ISO8859-1/htdocs/docproj/Makefile translations/en_US.ISO8859-1/htdocs/docproj/current.xml translations/en_US.ISO8859-1/htdocs/docs/books.xml translations/en_US.ISO8859-1/htdocs/donations/donors.xml translations/en_US.ISO8859-1/htdocs/internal/doceng.xml translations/en_US.ISO8859-1/htdocs/internal/machines.xml translations/en_US.ISO8859-1/htdocs/java/Makefile translations/en_US.ISO8859-1/htdocs/java/dists/Makefile translations/en_US.ISO8859-1/htdocs/java/dists/index.xml translations/en_US.ISO8859-1/htdocs/java/howhelp.xml translations/en_US.ISO8859-1/htdocs/java/index.xml translations/en_US.ISO8859-1/htdocs/java/install.xml translations/en_US.ISO8859-1/htdocs/layout/js/google.js translations/en_US.ISO8859-1/htdocs/news/status/Makefile translations/en_US.ISO8859-1/htdocs/news/status/README translations/en_US.ISO8859-1/htdocs/news/status/status.xml translations/en_US.ISO8859-1/htdocs/platforms/alpha.xml translations/en_US.ISO8859-1/htdocs/platforms/arm.xml translations/en_US.ISO8859-1/htdocs/platforms/sparc.xml translations/en_US.ISO8859-1/htdocs/platforms/xbox.xml translations/en_US.ISO8859-1/htdocs/portmgr/index.xml translations/en_US.ISO8859-1/htdocs/ports/installing.xml translations/en_US.ISO8859-1/htdocs/ports/references.xml translations/en_US.ISO8859-1/htdocs/ports/updating.xml translations/en_US.ISO8859-1/htdocs/projects/Makefile translations/en_US.ISO8859-1/htdocs/projects/c99/index.xml translations/en_US.ISO8859-1/htdocs/projects/cvsweb.xml translations/en_US.ISO8859-1/htdocs/projects/projects.xml translations/en_US.ISO8859-1/htdocs/projects/summerofcode-2005.xml translations/en_US.ISO8859-1/htdocs/projects/summerofcode-2006.xml translations/en_US.ISO8859-1/htdocs/releases/8.4R/Makefile translations/en_US.ISO8859-1/htdocs/releases/8.4R/schedule.xml translations/en_US.ISO8859-1/htdocs/releases/Makefile translations/en_US.ISO8859-1/htdocs/releases/index.xml translations/en_US.ISO8859-1/htdocs/releng/index.xml translations/en_US.ISO8859-1/htdocs/relnotes.xml translations/en_US.ISO8859-1/htdocs/relnotes/Makefile translations/en_US.ISO8859-1/htdocs/robots.txt translations/en_US.ISO8859-1/htdocs/search/opensearch/Makefile translations/en_US.ISO8859-1/htdocs/search/opensearch/opensearch.xml translations/en_US.ISO8859-1/htdocs/security/reporting.xml translations/en_US.ISO8859-1/htdocs/security/security.xml translations/en_US.ISO8859-1/htdocs/send-pr.xml translations/en_US.ISO8859-1/htdocs/where.xml translations/en_US.ISO8859-1/share/xml/mailing-lists.ent translations/en_US.ISO8859-1/share/xml/release.l10n.ent translations/en_US.ISO8859-1/share/xml/teams.ent Directory Properties: translations/en_US.ISO8859-1/ (props changed) Modified: translations/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- translations/en_US.ISO8859-1/articles/committers-guide/article.xml Sat Sep 7 23:27:36 2013 (r42626) +++ translations/en_US.ISO8859-1/articles/committers-guide/article.xml Sun Sep 8 00:16:29 2013 (r42627) @@ -26,7 +26,7 @@ <year>2011</year> <year>2012</year> <year>2013</year> - <holder>The FreeBSD Documentation Project</holder> + <holder>The &os; Documentation Project</holder> </copyright> <legalnotice id="trademarks" role="trademarks"> @@ -43,12 +43,12 @@ <releaseinfo>$FreeBSD$</releaseinfo> <abstract> - <para>This document provides information for the FreeBSD + <para>This document provides information for the &os; committer community. All new committers should read this document before they start, and existing committers are strongly encouraged to review it from time to time.</para> - <para>Almost all FreeBSD developers have commit rights to one or + <para>Almost all &os; developers have commit rights to one or more repositories. However, a few developers do not, and some of the information here applies to them as well. (For instance, some people only have rights to work with the @@ -56,7 +56,7 @@ linkend="non-committers"/> for more information.</para> <para>This document may also be of interest to members of the - FreeBSD community who want to learn more about how the project + &os; community who want to learn more about how the project works.</para> </abstract> </articleinfo> @@ -83,32 +83,32 @@ <row> <entry><emphasis><literal>src/</literal> Subversion Root</emphasis></entry> - <entry> - <literal>svn+ssh://</literal><hostid + <entry><literal>svn+ssh://</literal><hostid role="fqdn">svn.FreeBSD.org</hostid><filename>/base</filename> - (see also <xref linkend="subversion-primer"/>).</entry> + (see also <xref + linkend="svn-getting-started-base-layout"/>).</entry> </row> + <row> <entry><emphasis><literal>doc/</literal> Subversion Root</emphasis></entry> - <entry> - <literal>svn+ssh://</literal><hostid + <entry><literal>svn+ssh://</literal><hostid role="fqdn">svn.FreeBSD.org</hostid><filename>/doc</filename> - (see also <xref linkend="subversion-primer"/>).</entry> + (see also <xref + linkend="svn-getting-started-doc-layout"/>).</entry> </row> <row> <entry><emphasis><literal>ports/</literal> Subversion Root</emphasis></entry> - <entry> - <literal>svn+ssh://</literal><hostid + <entry><literal>svn+ssh://</literal><hostid role="fqdn">svn.FreeBSD.org</hostid><filename>/ports</filename> - (see also <xref linkend="subversion-primer"/>).</entry> + (see also <xref + linkend="svn-getting-started-ports-layout"/>).</entry> </row> <row> <entry><emphasis>Internal Mailing Lists</emphasis></entry> - <entry>developers (technically called all-developers), doc-developers, doc-committers, ports-developers, ports-committers, src-developers, src-committers. (Each @@ -128,8 +128,7 @@ reports</emphasis></entry> <entry><filename>/home/core/public/monthly-reports</filename> on the <hostid role="domainname">FreeBSD.org</hostid> - cluster. - </entry> + cluster.</entry> </row> <row> @@ -143,46 +142,47 @@ <row> <entry><emphasis>Noteworthy <literal>src/</literal> SVN Branches</emphasis></entry> - <entry> <literal>stable/8</literal> (8.X-STABLE), <literal>stable/9</literal> (9.X-STABLE), - <literal>head</literal> (-CURRENT) - </entry> + <literal>head</literal> (-CURRENT)</entry> </row> </tbody> </tgroup> </informaltable> - <para>It is required that you use &man.ssh.1; - to connect to the project hosts. - If you do - not know anything about &man.ssh.1;, please see - <xref linkend="ssh.guide"/>.</para> + <para>&man.ssh.1; is required to connect to the project hosts. + For more information, see <xref linkend="ssh.guide"/>.</para> <para>Useful links:</para> <itemizedlist> - <listitem><para><ulink url="&url.base;/internal/">FreeBSD - Project Internal Pages</ulink></para></listitem> + <listitem> + <para><ulink url="&url.base;/internal/">&os; + Project Internal Pages</ulink></para> + </listitem> - <listitem><para><ulink - url="&url.base;/internal/machines.html">FreeBSD Project - Hosts</ulink></para></listitem> - - <listitem><para><ulink - url="&url.base;/administration.html">FreeBSD Project - Administrative Groups</ulink></para></listitem> + <listitem> + <para><ulink + url="&url.base;/internal/machines.html">&os; Project + Hosts</ulink></para> + </listitem> + + <listitem> + <para><ulink + url="&url.base;/administration.html">&os; Project + Administrative Groups</ulink></para> + </listitem> </itemizedlist> </sect1> <sect1 id="committer.types"> <title>Commit Bit Types</title> - <para>The FreeBSD repository has a number of components which, + <para>The &os; repository has a number of components which, when combined, support the basic operating system source, documentation, third party application ports infrastructure, and - various maintained utilities. When FreeBSD commit bits are + various maintained utilities. When &os; commit bits are allocated, the areas of the tree where the bit may be used are specified. Generally, the areas associated with a bit reflect who authorized the allocation of the commit bit. Additional @@ -237,34 +237,40 @@ of the tree where the work is occurring.</para> <sect2> - <title>Policy for <filename>doc/</filename> committer activity - in <filename>src/</filename></title> + <title>Policy for <filename>doc/</filename> Committer Activity + in <filename>src/</filename></title> <itemizedlist> - <listitem><para>doc committers may commit documentation - changes to src files, such as man pages, READMEs, fortune - databases, calendar files, and comment fixes without - approval from a src committer, subject to the normal care - and tending of commits.</para></listitem> - - <listitem><para>doc committers may commit minor src changes - and fixes, such as build fixes, small features, etc, with an - "Approved by" from a src committer.</para></listitem> - - <listitem><para>doc committers may seek an upgrade to a src - commit bit by acquiring a mentor, who will propose the doc - committer to core. When approved, they will be added to - 'access' and the normal mentoring period will ensue, which - will involve a continuing of <quote>Approved by</quote> for - some period.</para></listitem> - - <listitem><para>"Approved by" is only acceptable from - non-mentored src committers -- mentored committers can - provide a "Reviewed by" but not an "Approved - by".</para></listitem> + <listitem> + <para>doc committers may commit documentation changes to src + files, such as man pages, READMEs, fortune databases, + calendar files, and comment fixes without approval from a + src committer, subject to the normal care and tending of + commits.</para> + </listitem> + + <listitem> + <para>doc committers may commit minor src changes and fixes, + such as build fixes, small features, etc, with an + "Approved by" from a src committer.</para> + </listitem> + + <listitem> + <para>doc committers may seek an upgrade to a src commit bit + by acquiring a mentor, who will propose the doc committer + to core. When approved, they will be added to 'access' + and the normal mentoring period will ensue, which will + involve a continuing of <quote>Approved by</quote> for + some period.</para> + </listitem> + + <listitem> + <para>"Approved by" is only acceptable from non-mentored src + committers -- mentored committers can provide a "Reviewed + by" but not an "Approved by".</para> + </listitem> </itemizedlist> </sect2> - </sect1> <sect1 id="subversion-primer"> @@ -274,13 +280,13 @@ operation of the version control systems in use. Traditionally this was CVS. Subversion is used for the <literal>src</literal> tree as of May 2008, the <literal>doc/www</literal> tree as of - May 2012 and the <literal>ports</literal> tree as of July 2012. - </para> + May 2012 and the <literal>ports</literal> tree as of July + 2012.</para> <para><ulink url="http://wiki.freebsd.org/SubversionMissing">There - is a list of things missing in Subversion when compared to CVS - </ulink>. The notes at <ulink - url="http://people.freebsd.org/~peter/svn_notes.txt"></ulink>; + is a list of things missing in Subversion when compared to + CVS</ulink>. The notes at <ulink + url="http://people.freebsd.org/~peter/svn_notes.txt"></ulink>; might also be useful.</para> <sect2 id="svn-intro"> @@ -336,37 +342,44 @@ <listitem> <para>Commits are atomic.</para> </listitem> + <listitem> <para>Revision numbers apply across the repository—all files that were modified in the same commit have the same revision number.</para> </listitem> + <listitem> <para>Branching and tagging are namespace operations.</para> </listitem> + <listitem> <para>Directories are versioned.</para> </listitem> + <listitem> <para>Files and directories can have arbitrary, versioned metadata attached to them.</para> </listitem> + <listitem> <para>Files and directories can be copied, with full history tracking.</para> </listitem> + <listitem> <para>No more contortions due to <acronym>CVS</acronym> weakness such as applying &man.patch.1; files at compile time in order to avoid touching vendor branch code.</para> </listitem> + <listitem> <para>No more repo-copies.</para> </listitem> </itemizedlist> <para>Subversion can be installed from the &os; Ports - Collection, by issuing the following commands:</para> + Collection by issuing these commands:</para> <screen>&prompt.root; <userinput>cd /usr/ports/devel/subversion</userinput> &prompt.root; <userinput>make clean install</userinput></screen> @@ -378,7 +391,7 @@ <para>There are a few ways to obtain a working copy of the tree from Subversion. This section will explain them.</para> - <sect3> + <sect3 id="svn-getting-started-direct-checkout"> <title>Direct Checkout</title> <para>The first is to check out directly from the main @@ -445,7 +458,7 @@ </note> </sect3> - <sect3> + <sect3 id="svn-getting-started-checkout-from-a-mirror"> <title>Checkout from a Mirror</title> <para>Check out a working copy from a mirror by @@ -455,13 +468,14 @@ using <command>svnsync</command>.</para> <para>There is a serious disadvantage to this method: every - time something is to be committed, a <command>svn switch - --relocate</command> to the master repository has to be - done, remembering to <command>svn switch</command> back to - the mirror after the commit. Also, since <command>svn - switch</command> only works between repositories that have - the same UUID, some hacking of the local repository's UUID - has to occur before it is possible to start using it.</para> + time something is to be committed, a + <command>svn relocate</command> to the master repository has + to be done, remembering to <command>svn relocate</command> + back to the mirror after the commit. Also, since + <command>svn relocate</command> only works between + repositories that have the same UUID, some hacking of the + local repository's UUID has to occur before it is possible + to start using it.</para> <para>Unlike with <acronym>CVS</acronym>, the hassle of a local @@ -471,7 +485,7 @@ information on how to set one up.</para> </sect3> - <sect3 id="subversion-primer-base-layout"> + <sect3 id="svn-getting-started-base-layout"> <title><literal>RELENG_*</literal> Branches and General Layout</title> @@ -489,26 +503,29 @@ <itemizedlist> <listitem> - <para><emphasis>/head/</emphasis> - which corresponds to <literal>HEAD</literal>, also known as - <literal>-CURRENT</literal>. - </para> + <para><emphasis>/head/</emphasis> which corresponds to + <literal>HEAD</literal>, also known as + <literal>-CURRENT</literal>.</para> </listitem> + <listitem> <para><emphasis>/stable/<replaceable>n</replaceable></emphasis> which corresponds to <literal>RELENG_<replaceable>n</replaceable></literal>.</para> </listitem> + <listitem> <para><emphasis>/releng/<replaceable>n.n</replaceable></emphasis> which corresponds to <literal>RELENG_<replaceable>n_n</replaceable></literal>.</para> </listitem> + <listitem> <para><emphasis>/release/<replaceable>n.n.n</replaceable></emphasis> which corresponds to <literal>RELENG_<replaceable>n_n_n</replaceable>_RELEASE</literal>.</para> </listitem> + <listitem> <para><emphasis>/vendor*</emphasis> is the vendor branch import work area. This directory itself does not @@ -517,6 +534,7 @@ <emphasis>releng</emphasis> and <emphasis>release</emphasis> directories.</para> </listitem> + <listitem> <para><emphasis>/projects</emphasis> and <emphasis>/user</emphasis> feature a branch work area, @@ -527,21 +545,21 @@ </itemizedlist> </sect3> - <sect3> + <sect3 id="svn-getting-started-doc-layout"> <title>&os; Documentation Project Branches and Layout</title> <para>In <literal>svn+ssh://svn.freebsd.org/doc</literal>, - <emphasis>doc</emphasis> refers repository root of the - source tree.</para> + <emphasis>doc</emphasis> refers to the repository root of + the source tree.</para> <para>In general, most &os; Documentation Project work will be done within the <filename>head/</filename> branch of the - source tree.</para> + documentation source tree.</para> <para>&os; documentation is written and/or translated to - various languages, each of which within a separate - directory within the <filename>head/</filename> + various languages, each in a separate + directory in the <filename>head/</filename> branch.</para> <para>Each translation set contains several subdirectories for @@ -554,11 +572,13 @@ code for articles written by various &os; contributors.</para> </listitem> + <listitem> <para><emphasis>/books/</emphasis> contains the source code for the different books, such as the &os; Handbook.</para> </listitem> + <listitem> <para><emphasis>/htdocs/</emphasis> contains the source code for the &os; website.</para> @@ -566,11 +586,11 @@ </itemizedlist> </sect3> - <sect3> + <sect3 id="svn-getting-started-ports-layout"> <title>&os; Ports Tree Branches and Layout</title> <para>In <literal>svn+ssh://svn.freebsd.org/ports</literal>, - <emphasis>ports</emphasis> refers repository root of the + <emphasis>ports</emphasis> refers to the repository root of the ports tree.</para> <para>In general, most &os; port work will be done within @@ -580,17 +600,20 @@ <itemizedlist> <listitem> - <para><emphasis>/branches/RELENG_<replaceable>n_n_n - </replaceable></emphasis> which corresponds to - <literal>RELENG_<replaceable>n_n_n</replaceable></literal> + <para><emphasis>/branches/RELENG_<replaceable>n_n_n</replaceable></emphasis> + which corresponds to + <literal>RELENG_<replaceable>n_n_n</replaceable></literal> is used to merge back security updates in preparation for a release.</para> </listitem> + <listitem> <para><emphasis>/tags/RELEASE_<replaceable>n_n_n</replaceable></emphasis> - which corresponds to <literal>RELEASE_<replaceable>n_n_n</replaceable></literal> + which corresponds to + <literal>RELEASE_<replaceable>n_n_n</replaceable></literal> represents a release tag of the ports tree.</para> </listitem> + <listitem> <para><emphasis>/tags/RELEASE_<replaceable>n</replaceable>_EOL</emphasis> represents the end of life tag of a specific &os; @@ -604,22 +627,22 @@ <title>Daily Use</title> <para>This section will explain how to perform common day-to-day - operations with Subversion. There should be no difference - between <acronym>SVN</acronym> and <acronym>SVK</acronym> in - daily use, except for the revision renumbering mentioned - earlier.</para> + operations with Subversion.</para> - <sect3> + <sect3 id="svn-daily-use-help"> <title>Help</title> - <para>Both <acronym>SVN</acronym> and <acronym>SVK</acronym> - have built in help documentation. It can be accessed by - typing the following command:</para> + <para><acronym>SVN</acronym> has built in help documentation. + It can be accessed by typing the following command:</para> <screen>&prompt.user; <userinput>svn help</userinput></screen> + + <para>Additional information can be found in the + <ulink url="http://svnbook.red-bean.com/">Subversion + Book</ulink>.</para> </sect3> - <sect3> + <sect3 id="svn-daily-use-checkout"> <title>Checkout</title> <para>As seen earlier, to check out the &os; head @@ -682,13 +705,13 @@ </note> </sect3> - <sect3> + <sect3 id="svn-daily-use-anonymous-checkout"> <title>Anonymous Checkout</title> <para>It is possible to anonymously check out the &os; repository with Subversion. This will give access to a - read-only tree that can be updated, but not committed - to. To do this, use the following command:</para> + read-only tree that can be updated, but not committed back + to the main repository. To do this, use the following command:</para> <screen>&prompt.user; <userinput>svn co <replaceable>https://svn0.us-west.FreeBSD.org</replaceable>/base/head /usr/src</userinput></screen> @@ -698,7 +721,7 @@ mirror sites</ulink>.</para> </sect3> - <sect3> + <sect3 id="svn-daily-use-updating-the-tree"> <title>Updating the Tree</title> <para>To update a working copy to either the latest revision, @@ -708,7 +731,7 @@ &prompt.user; <userinput>svn update -<replaceable>r12345</replaceable></userinput></screen> </sect3> - <sect3> + <sect3 id="svn-daily-use-status"> <title>Status</title> <para>To view the local changes that have been made to the @@ -716,17 +739,17 @@ <screen>&prompt.user; <userinput>svn status</userinput></screen> - <para>To show local changes and files that are out-of-date do:</para> + <para>To show local changes and files that are out-of-date + do:</para> <screen>&prompt.user; <userinput>svn status --show-updates</userinput></screen> </sect3> - <sect3> + <sect3 id="svn-daily-use-editing-and-committing"> <title>Editing and Committing</title> - <para>Unlike Perforce, - <acronym>SVN</acronym> and <acronym>SVK</acronym> do not - need to be told in advance about file editing.</para> + <para>Unlike Perforce, <acronym>SVN</acronym> does not need to + be told in advance about file editing.</para> <para><command>svn commit</command> works like the equivalent <acronym>CVS</acronym> command. To commit all changes in @@ -742,15 +765,15 @@ <screen>&prompt.user; <userinput>svn commit <replaceable>lib/libfetch</replaceable> <replaceable>usr/bin/fetch</replaceable></userinput></screen> - <para>There is also a commit wrapper for the ports tree - to handle the properties and sanity checking your + <para>There is also a commit wrapper for the ports tree to + handle the properties and sanity checking your changes:</para> <screen>&prompt.user; <userinput>/usr/ports/Tools/scripts/psvn commit </userinput></screen> </sect3> - <sect3 id="subversion-primer-add-remove"> + <sect3 id="svn-daily-use-adding-and-removing"> <title>Adding and Removing Files</title> <note> @@ -761,13 +784,12 @@ ports tree specific version</ulink>) and add it to <filename>~/.subversion/config</filename> according to the instructions in the file. If you added - something before you've read this, you may use + something before reading this, use <command>svn rm --keep-local</command> for just added files, fix your config file and re-add them again. The initial config file is created when you first run a svn - command, even something as simple as <command>svn - help</command>. - </para> + command, even something as simple as + <command>svn help</command>.</para> </note> <para>Files are added to a @@ -777,85 +799,88 @@ <screen>&prompt.user; <userinput>svn add <replaceable>foo</replaceable></userinput></screen> + <note> + <para>Most new source files should include a + <literal>$&os;$</literal> string near the start of the + file. On commit, <command>svn</command> will expand + the <literal>$&os;$</literal> string, + adding the file path, revision number, date and time of + commit, and the username of the committer. Files which + cannot be modified may be committed without the + <literal>$&os;$</literal> string.</para> + </note> + <para>Files can be removed with <command>svn remove</command>:</para> <screen>&prompt.user; <userinput>svn remove <replaceable>foo</replaceable></userinput></screen> - <para>Subversion does not require <command>rm</command>ing the - file before <command>svn rm</command>ing it, and indeed - complains if that happens.</para> + <para>Subversion does not require deleting the file before + using <command>svn rm</command>, and indeed complains if + that happens.</para> - <para>It is possible to add directories with <command>svn - add</command>:</para> + <para>It is possible to add directories with + <command>svn add</command>:</para> <screen>&prompt.user; <userinput>mkdir <replaceable>bar</replaceable></userinput> &prompt.user; <userinput>svn add <replaceable>bar</replaceable></userinput></screen> - <para>Although <command>svn mkdir</command> makes this - easier by combining the creation of the directory and the - adding of it:</para> + <para>Although <command>svn mkdir</command> makes this easier + by combining the creation of the directory and the adding of + it:</para> <screen>&prompt.user; <userinput>svn mkdir <replaceable>bar</replaceable></userinput></screen> - <para>The directory is not immediately - created in the repository when you use <command>svn - mkdir</command>. Subversion - allows directories to be removed using <command>svn - rm</command>, however there is no <command>svn - rmdir</command>:</para> + <para>Like files, directories are removed with + <command>svn rm</command>. There is no separate command + specifically for removing directories.</para> <screen>&prompt.user; <userinput>svn rm <replaceable>bar</replaceable></userinput></screen> </sect3> - <sect3> + <sect3 id="svn-daily-use-copying-and-moving"> <title>Copying and Moving Files</title> - <para>The following (obviously) creates a copy of - <filename>foo.c</filename>, named - <filename>bar.c</filename>:</para> + <para>This command creates a copy of + <filename>foo.c</filename> named <filename>bar.c</filename>, + with the new file also under version control:</para> <screen>&prompt.user; <userinput>svn copy <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen> - <para>To move and rename a file:</para> + <para>The example above is equivalent to:</para> - <screen>&prompt.user; <userinput>svn move <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>cp foo.c bar.c</userinput> +&prompt.user; <userinput>svn add bar.c</userinput></screen> - <para>The above command is the exact equivalent of:</para> + <para>To move and rename a file:</para> - <screen>&prompt.user; <userinput>svn copy <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput> -&prompt.user; <userinput>svn remove <replaceable>foo.c</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>svn move <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen> </sect3> - <sect3> + <sect3 id="svn-daily-use-log-and-annotate"> <title>Log and Annotate</title> - <para><command>svn log</command> will show all the - revisions that affect a directory and files within that - directory in reverse chronological order, if run on a - directory. This contrasts with <command>cvs log</command> - in that <acronym>CVS</acronym> shows the complete log for - each file in the directory, including duplicate entries for - revisions that affect multiple files.</para> + <para><command>svn log</command> shows revisions and commit + messages, most recent first, for files or directories. When + used on a directory, all revisions that affected the + directory and files within that directory are shown.</para> <para><command>svn annotate</command>, or equally <command>svn - praise</command> or <command>svn blame</command>, is - equivalent to <command>cvs annotate</command> in everything - but output format.</para> + praise</command> or <command>svn blame</command>, shows + the most recent revision number and who committed that + revision for each line of a file.</para> </sect3> - <sect3> + <sect3 id="svn-daily-use-diffs"> <title>Diffs</title> <para><command>svn diff</command> displays changes to the - working copy of the repository. Diffs generated by - <acronym>SVN</acronym> are unified - and include new files by default - in the diff output.</para> - - <para><command>svn - diff</command> can show the changes between two revisions - of the same file:</para> + working copy. Diffs generated by <acronym>SVN</acronym> are + unified and include new files by default in the diff + output.</para> + + <para><command>svn diff</command> can show the changes between + two revisions of the same file:</para> <screen>&prompt.user; <userinput>svn diff -r179453:179454 ROADMAP.txt</userinput></screen> @@ -867,20 +892,19 @@ <screen>&prompt.user; <userinput>svn diff -c179454 .</userinput></screen> </sect3> - <sect3> + <sect3 id="svn-daily-use-reverting"> <title>Reverting</title> <para>Local changes (including additions and deletions) can be - reverted using <command>svn revert</command>. - It does not update out-of-date - files—it just replaces them with pristine copies of - the original version.</para> + reverted using <command>svn revert</command>. It does not + update out-of-date files, but just replaces them with + pristine copies of the original version.</para> </sect3> - <sect3> + <sect3 id="svn-daily-use-conflicts"> <title>Conflicts</title> - <para>If a <command>svn update</command> resulted in a merge + <para>If an <command>svn update</command> resulted in a merge conflict, Subversion will remember which files have conflicts and refuse to commit any changes to those files until explicitly told that the conflicts have been resolved. @@ -902,22 +926,26 @@ working directory (which one presumes has been edited to resolve the conflicts).</para> </listitem> + <listitem> <para><literal>base</literal>: use a pristine copy of the version you had before <command>svn update</command>, discarding your own changes, the conflicting changes, and possibly other intervening changes as well.</para> </listitem> + <listitem> <para><literal>mine-full</literal>: use what you had before <command>svn update</command>, including your own changes, but discarding the conflicting changes, and possibly other intervening changes as well.</para> </listitem> + <listitem> <para><literal>theirs-full</literal>: use the version that - was retrieved when you did <command>svn - update</command>, discarding your own changes.</para> + was retrieved when you did + <command>svn update</command>, discarding your own + changes.</para> </listitem> </itemizedlist> </sect3> @@ -926,27 +954,15 @@ <sect2> <title>Advanced Use</title> - <sect3> + <sect3 id="svn-advanced-use-sparse-checkouts"> <title>Sparse Checkouts</title> - <para>The equivalent to <command>cvs checkout -l</command>, - which checks out a directory without its subdirectories, is - <command>svn checkout -N</command>. Unlike - <acronym>CVS</acronym>, <acronym>SVN</acronym> remembers the - <literal>-N</literal> so that a <command>svn - update</command> does not end up pulling down the - subdirectories. In Subversion 1.5 and newer, - <literal>-N</literal> has been deprecated in favour of the - <literal>--depth</literal> option which allows for precise - control. Therefore:</para> - - <screen>&prompt.user; <userinput>svn checkout -N svn+ssh://svn.freebsd.org/base ~/freebsd</userinput></screen> - - <para>is equivalent to:</para> + <para><acronym>SVN</acronym> allows + <emphasis>sparse</emphasis>, or partial checkouts of a + directory by adding <option>--depth</option> to a + <command>svn checkout</command>.</para> - <screen>&prompt.user; <userinput>svn checkout --depth=empty svn+ssh://svn.freebsd.org/base ~/freebsd</userinput></screen> - - <para>Valid arguments to <literal>--depth</literal> + <para>Valid arguments to <option>--depth</option> are:</para> <itemizedlist> @@ -954,15 +970,18 @@ <para><literal>empty</literal>: the directory itself without any of its contents.</para> </listitem> + <listitem> <para><literal>files</literal>: the directory and any files it contains.</para> </listitem> + <listitem> <para><literal>immediates</literal>: the directory and any files and directories it contains, but none of the subdirectories' contents.</para> </listitem> + <listitem> <para><literal>infinity</literal>: anything.</para> </listitem> @@ -987,39 +1006,44 @@ <filename>ROADMAP.txt</filename> and empty subdirectories, and nothing will happen when <command>svn update</command> is executed on the subdirectories. However, the following - command will set the depth for head (in this case) to - infinity, and fully populate it:</para> + command will set the depth for + <replaceable>head</replaceable> (in this case) to infinity, + and fully populate it:</para> <screen>&prompt.user; <userinput>svn update --set-depth=infinity <replaceable>head</replaceable></userinput></screen> </sect3> - <sect3> + <sect3 id="svn-advanced-use-direct-operation"> <title>Direct Operation</title> <para>Certain operations can be performed directly on the - repository, without touching the working copy. - Specifically, this applies to any operation that does not - require editing a file, including:</para> + repository without touching the working copy. Specifically, + this applies to any operation that does not require editing + a file, including:</para> <itemizedlist> <listitem> <para><literal>log</literal>, - <literal>diff</literal>.</para> + <literal>diff</literal></para> </listitem> + <listitem> - <para><literal>mkdir</literal>.</para> + <para><literal>mkdir</literal></para> </listitem> + <listitem> <para><literal>remove</literal>, <literal>copy</literal>, - <literal>rename</literal>.</para> + <literal>rename</literal></para> </listitem> + <listitem> <para><literal>propset</literal>, <literal>propedit</literal>, - <literal>propdel</literal>.</para> + <literal>propdel</literal></para> </listitem> + <listitem> - <para><literal>merge</literal>.</para> + <para><literal>merge</literal></para> </listitem> </itemizedlist> @@ -1028,8 +1052,8 @@ <screen>&prompt.user; <userinput>svn copy svn+ssh://svn.freebsd.org/base/head svn+ssh://svn.freebsd.org/base/stable/8</userinput></screen> - <para>This is equivalent to the following set of - commands which take minutes and hours as opposed to seconds, + <para>This is equivalent to the following set of commands + which take minutes and hours as opposed to seconds, depending on your network connection:</para> <screen>&prompt.user; <userinput>svn checkout --depth=immediates svn+ssh://svn.freebsd.org/base</userinput> @@ -1039,7 +1063,7 @@ &prompt.user; <userinput>svn commit stable/8</userinput></screen> </sect3> - <sect3 id="subversion-primer-merge"> + <sect3 id="svn-advanced-use-merging"> <title>Merging with <acronym>SVN</acronym></title> <para>This section deals with merging code from one branch to @@ -1066,37 +1090,39 @@ <para>It is <emphasis>not</emphasis> inherited. For instance, <filename - class="directory">stable/6/contrib/openpam/</filename> - does not implicitly inherit mergeinfo from <filename - class="directory">stable/6/</filename>, or <filename - class="directory">stable/6/contrib/</filename>. Doing - so would make partial checkouts very hard to manage. + class="directory">stable/6/contrib/openpam/</filename> + does not implicitly inherit mergeinfo from + <filename class="directory">stable/6/</filename>, or + <filename class="directory">stable/6/contrib/</filename>. + Doing so would make partial checkouts very hard to manage. Instead, mergeinfo is explicitly propagated down the tree. - For merging something into <filename - class="directory">branch/foo/bar/</filename>, the - following rules apply:</para> + For merging something into + <filename class="directory">branch/foo/bar/</filename>, + the following rules apply:</para> <orderedlist> <listitem> - <para>If <filename - class="directory">branch/foo/bar/</filename> doesn't - already have a mergeinfo record, but a direct ancestor - (for instance, <filename - class="directory">branch/foo/</filename>) does, - then that record will be propagated down to + <para>If + <filename class="directory">branch/foo/bar/</filename> + does not already have a mergeinfo record, but a direct + ancestor (for instance, + <filename class="directory">branch/foo/</filename>) + does, then that record will be propagated down to <filename class="directory">branch/foo/bar/</filename> - before information - about the current merge is recorded.</para> + before information about the current merge is + recorded.</para> </listitem> + <listitem> <para>Information about the current merge will <emphasis>not</emphasis> be propagated back up that ancestor.</para> </listitem> + <listitem> - <para>If a direct descendant of <filename - class="directory">branch/foo/bar/</filename> (for - instance, <filename + <para>If a direct descendant of + <filename class="directory">branch/foo/bar/</filename> + (for instance, <filename class="directory">branch/foo/bar/baz/</filename>) already has a mergeinfo record, information about the current merge will be propagated down to it.</para> @@ -1131,43 +1157,51 @@ <listitem> <para>Never merge directly to a file.</para> </listitem> + <listitem> <para>Never, ever merge directly to a file.</para> </listitem> + <listitem> <para><emphasis>Never, ever, ever</emphasis> merge directly to a file.</para> </listitem> + <listitem> <para>Changes to kernel code should be merged to <filename class="directory">sys/</filename>. For instance, a change to the &man.ichwd.4; driver should - be merged to <filename - class="directory">sys/</filename>, not <filename - class="directory">sys/dev/ichwd/</filename>. + be merged to + + <filename class="directory">sys/</filename>, not + <filename class="directory">sys/dev/ichwd/</filename>. Likewise, a change to the TCP/IP stack should be merged to <filename class="directory">sys/</filename>, not <filename class="directory">sys/netinet/</filename>.</para> </listitem> + <listitem> - <para>Changes to code under <filename - class="directory">etc/</filename> should be merged - at <filename class="directory">etc/</filename>, not - below it.</para> + <para>Changes to code under + <filename class="directory">etc/</filename> should be + merged at <filename class="directory">etc/</filename>, + not below it.</para> </listitem> *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201309080016.r880GU0x000659>