Date: Sun, 13 Apr 2014 01:29:40 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r44543 - head/en_US.ISO8859-1/articles/committers-guide Message-ID: <201404130129.s3D1Te3O052907@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Sun Apr 13 01:29:40 2014 New Revision: 44543 URL: http://svnweb.freebsd.org/changeset/doc/44543 Log: Recover lost <replaceable> tags. Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/committers-guide/article.xml Sat Apr 12 13:20:00 2014 (r44542) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Sun Apr 13 01:29:40 2014 (r44543) @@ -122,9 +122,9 @@ project repository has its own -developers and -committers mailing lists. Archives for these lists may be found in files - <filename>/home/mail/repository-name-developers-archive</filename> + <filename>/home/mail/<replaceable>repository-name</replaceable>-developers-archive</filename> and - <filename>/home/mail/repository-name-committers-archive</filename> + <filename>/home/mail/<replaceable>repository-name</replaceable>-committers-archive</filename> on the <systemitem class="fqdomainname">FreeBSD.org</systemitem> cluster.)</entry> @@ -454,8 +454,8 @@ You need a Passphrase to protect your se The most notable change is the location of the &os; website <literal>www</literal> tree, which has been moved from - <literal>www/lang/</literal> to - <literal>head/lang/htdocs/</literal>.</para> + <literal>www/<replaceable>lang</replaceable>/</literal> to + <literal>head/<replaceable>lang</replaceable>/htdocs/</literal>.</para> </note> <para>The &os; <literal>ports</literal> repository switched @@ -554,7 +554,7 @@ You need a Passphrase to protect your se <para>The above command will check out a <literal>CURRENT</literal> source tree as - <filename>/usr/src/</filename>, which can be any target + <filename><replaceable>/usr/src/</replaceable></filename>, which can be any target directory on the local filesystem. Omitting the final argument of that command causes the working copy, in this case, to be named <quote>head</quote>, but that can be @@ -644,19 +644,19 @@ You need a Passphrase to protect your se <listitem> <para><emphasis>/stable/<replaceable>n</replaceable></emphasis> which corresponds to - <literal>RELENG_n</literal>.</para> + <literal>RELENG_<replaceable>n</replaceable></literal>.</para> </listitem> <listitem> <para><emphasis>/releng/<replaceable>n.n</replaceable></emphasis> which corresponds to - <literal>RELENG_n_n</literal>.</para> + <literal>RELENG_<replaceable>n_n</replaceable></literal>.</para> </listitem> <listitem> <para><emphasis>/release/<replaceable>n.n.n</replaceable></emphasis> which corresponds to - <literal>RELENG_n_n_n_RELEASE</literal>.</para> + <literal>RELENG_<replaceable>n_n_n</replaceable>_RELEASE</literal>.</para> </listitem> <listitem> @@ -735,7 +735,7 @@ You need a Passphrase to protect your se <listitem> <para><emphasis>/branches/RELENG_<replaceable>n_n_n</replaceable></emphasis> which corresponds to - <literal>RELENG_n_n_n</literal> + <literal>RELENG_<replaceable>n_n_n</replaceable></literal> is used to merge back security updates in preparation for a release.</para> </listitem> @@ -743,7 +743,7 @@ You need a Passphrase to protect your se <listitem> <para><emphasis>/tags/RELEASE_<replaceable>n_n_n</replaceable></emphasis> which corresponds to - <literal>RELEASE_n_n_n</literal> + <literal>RELEASE_<replaceable>n_n_n</replaceable></literal> represents a release tag of the ports tree.</para> </listitem> @@ -847,7 +847,7 @@ You need a Passphrase to protect your se to the main repository. To do this, use the following command:</para> - <screen>&prompt.user; <userinput>svn co https://svn0.us-west.FreeBSD.org/base/head /usr/src</userinput></screen> + <screen>&prompt.user; <userinput>svn co <replaceable>https://svn0.us-west.FreeBSD.org</replaceable>/base/head /usr/src</userinput></screen> <para>Select the closest mirror and verify the mirror server certificate from the list of <link @@ -862,7 +862,7 @@ You need a Passphrase to protect your se or a specific revision:</para> <screen>&prompt.user; <userinput>svn update</userinput> -&prompt.user; <userinput>svn update -r12345</userinput></screen> +&prompt.user; <userinput>svn update -<replaceable>r12345</replaceable></userinput></screen> </sect3> <sect3 xml:id="svn-daily-use-status"> @@ -892,11 +892,11 @@ You need a Passphrase to protect your se <screen>&prompt.user; <userinput>svn commit</userinput></screen> <para>To commit all changes in, for example, - <filename>lib/libfetch/</filename> and - <filename>usr/bin/fetch/</filename> in a single + <filename><replaceable>lib/libfetch/</replaceable></filename> and + <filename><replaceable>usr/bin/fetch/</replaceable></filename> in a single operation:</para> - <screen>&prompt.user; <userinput>svn commit lib/libfetch usr/bin/fetch</userinput></screen> + <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 @@ -928,7 +928,7 @@ You need a Passphrase to protect your se add</command>. To add a file named <emphasis>foo</emphasis>, edit it, then:</para> - <screen>&prompt.user; <userinput>svn add foo</userinput></screen> + <screen>&prompt.user; <userinput>svn add <replaceable>foo</replaceable></userinput></screen> <note> <para>Most new source files should include a @@ -944,7 +944,7 @@ You need a Passphrase to protect your se <para>Files can be removed with <command>svn remove</command>:</para> - <screen>&prompt.user; <userinput>svn remove foo</userinput></screen> + <screen>&prompt.user; <userinput>svn remove <replaceable>foo</replaceable></userinput></screen> <para>Subversion does not require deleting the file before using <command>svn rm</command>, and indeed complains if @@ -953,20 +953,20 @@ You need a Passphrase to protect your se <para>It is possible to add directories with <command>svn add</command>:</para> - <screen>&prompt.user; <userinput>mkdir bar</userinput> -&prompt.user; <userinput>svn add bar</userinput></screen> + <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> - <screen>&prompt.user; <userinput>svn mkdir bar</userinput></screen> + <screen>&prompt.user; <userinput>svn mkdir <replaceable>bar</replaceable></userinput></screen> <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 bar</userinput></screen> + <screen>&prompt.user; <userinput>svn rm <replaceable>bar</replaceable></userinput></screen> </sect3> <sect3 xml:id="svn-daily-use-copying-and-moving"> @@ -976,7 +976,7 @@ You need a Passphrase to protect your se <filename>foo.c</filename> named <filename>bar.c</filename>, with the new file also under version control:</para> - <screen>&prompt.user; <userinput>svn copy foo.c bar.c</userinput></screen> + <screen>&prompt.user; <userinput>svn copy <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen> <para>The example above is equivalent to:</para> @@ -985,7 +985,7 @@ You need a Passphrase to protect your se <para>To move and rename a file:</para> - <screen>&prompt.user; <userinput>svn move foo.c bar.c</userinput></screen> + <screen>&prompt.user; <userinput>svn move <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen> </sect3> <sect3 xml:id="svn-daily-use-log-and-annotate"> @@ -1042,11 +1042,11 @@ You need a Passphrase to protect your se The simple, not yet deprecated procedure is the following:</para> - <screen>&prompt.user; <userinput>svn resolved foo</userinput></screen> + <screen>&prompt.user; <userinput>svn resolved <replaceable>foo</replaceable></userinput></screen> <para>However, the preferred procedure is:</para> - <screen>&prompt.user; <userinput>svn resolve --accept=working foo</userinput></screen> + <screen>&prompt.user; <userinput>svn resolve --accept=working <replaceable>foo</replaceable></userinput></screen> <para>The two examples are equivalent. Possible values for <literal>--accept</literal> are:</para> @@ -1129,7 +1129,7 @@ You need a Passphrase to protect your se Thus, given the working copy produced by the previous example:</para> - <screen>&prompt.user; <userinput>cd ~/freebsd</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>~/freebsd</replaceable></userinput> &prompt.user; <userinput>svn update --set-depth=immediates .</userinput></screen> <para>The above command will populate the working copy in @@ -1141,7 +1141,7 @@ You need a Passphrase to protect your se <replaceable>head</replaceable> (in this case) to infinity, and fully populate it:</para> - <screen>&prompt.user; <userinput>svn update --set-depth=infinity head</userinput></screen> + <screen>&prompt.user; <userinput>svn update --set-depth=infinity <replaceable>head</replaceable></userinput></screen> </sect3> <sect3 xml:id="svn-advanced-use-direct-operation"> @@ -1388,7 +1388,7 @@ You need a Passphrase to protect your se <listitem> <para>Changes to manual pages should be merged to - <filename>share/man/manN/</filename>, for the + <filename>share/man/man<replaceable>N</replaceable>/</filename>, for the appropriate value of <literal>N</literal>.</para> </listitem> @@ -1681,7 +1681,7 @@ U stable/9/share/man/man4/netmap.4 <para>To flatten the <literal>pf</literal> tree:</para> - <screen>&prompt.user; <userinput>cd vendor/pf/dist/contrib/pf</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>vendor/pf/dist/contrib/pf</replaceable></userinput> &prompt.user; <userinput>svn mv $(svn list) ../..</userinput> &prompt.user; <userinput>cd ../..</userinput> &prompt.user; <userinput>svn rm contrib</userinput> @@ -1726,8 +1726,8 @@ U stable/9/share/man/man4/netmap.4 that corresponds to the last related change to the vendor tree, prior to importing new sources:</para> - <screen>&prompt.user; <userinput>cd head/contrib/pf</userinput> -&prompt.user; <userinput>svn merge --record-only svn+ssh://svn.freebsd.org/base/vendor/pf/dist@180876 .</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>head/contrib/pf</replaceable></userinput> +&prompt.user; <userinput>svn merge --record-only svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/dist@180876</replaceable> .</userinput> &prompt.user; <userinput>svn commit</userinput></screen> </sect5> </sect4> @@ -1757,9 +1757,9 @@ U stable/9/share/man/man4/netmap.4 about to be imported is recommended, to facilitate the process.</para> - <screen>&prompt.user; <userinput>cd vendor/pf/dist</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>vendor/pf/dist</replaceable></userinput> &prompt.user; <userinput>svn list -R | grep -v '/$' | sort >../old</userinput> -&prompt.user; <userinput>cd ../pf-4.3</userinput> +&prompt.user; <userinput>cd <replaceable>../pf-4.3</replaceable></userinput> &prompt.user; <userinput>find . -type f | cut -c 3- | sort >../new</userinput></screen> <para>With these two files, @@ -1774,14 +1774,14 @@ U stable/9/share/man/man4/netmap.4 <title>Importing into the Vendor Tree</title> <para>Now, the sources must be copied into - <filename>dist</filename> and + <filename><replaceable>dist</replaceable></filename> and the <command>svn add</command> and <command>svn rm</command> commands should be used as needed:</para> - <screen>&prompt.user; <userinput>cd vendor/pf/pf-4.3</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>vendor/pf/pf-4.3</replaceable></userinput> &prompt.user; <userinput>tar cf - . | tar xf - -C ../dist</userinput> -&prompt.user; <userinput>cd ../dist</userinput> +&prompt.user; <userinput>cd <replaceable>../dist</replaceable></userinput> &prompt.user; <userinput>comm -23 ../old ../new | xargs svn rm</userinput> &prompt.user; <userinput>comm -13 ../old ../new | xargs svn --parents add</userinput></screen> @@ -1813,11 +1813,11 @@ U stable/9/share/man/man4/netmap.4 future reference. The best and quickest way to do this is directly in the repository:</para> - <screen>&prompt.user; <userinput>svn cp svn+ssh://svn.freebsd.org/base/vendor/pf/dist svn+ssh://svn.freebsd.org/base/vendor/pf/4.3</userinput></screen> + <screen>&prompt.user; <userinput>svn cp svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/dist</replaceable> svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/4.3</replaceable></userinput></screen> <para>Once that is complete, <command>svn up</command> the working copy of - <filename>vendor/pf</filename> + <filename><replaceable>vendor/pf</replaceable></filename> to get the new tag, although this is rarely needed.</para> @@ -1825,7 +1825,7 @@ U stable/9/share/man/man4/netmap.4 <command>svn:mergeinfo</command> results must be removed:</para> - <screen>&prompt.user; <userinput>cd vendor/pf</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>vendor/pf</replaceable></userinput> &prompt.user; <userinput>svn cp dist 4.3</userinput> &prompt.user; <userinput>svn propdel svn:mergeinfo -R 4.3</userinput></screen> </sect5> @@ -1834,9 +1834,9 @@ U stable/9/share/man/man4/netmap.4 <sect4> <title>Merging to Head</title> - <screen>&prompt.user; <userinput>cd head/contrib/pf</userinput> + <screen>&prompt.user; <userinput>cd <replaceable>head/contrib/pf</replaceable></userinput> &prompt.user; <userinput>svn up</userinput> -&prompt.user; <userinput>svn merge --accept=postpone svn+ssh://svn.freebsd.org/base/vendor/pf/dist .</userinput></screen> +&prompt.user; <userinput>svn merge --accept=postpone svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/dist</replaceable> .</userinput></screen> <para>The <literal>--accept=postpone</literal> tells Subversion that it should not complain because merge @@ -1874,7 +1874,7 @@ U stable/9/share/man/man4/netmap.4 main tree. To check diffs against the vendor branch:</para> - <screen>&prompt.user; <userinput>svn diff --no-diff-deleted --old=svn+ssh://svn.freebsd.org/base/vendor/pf/dist --new=.</userinput></screen> + <screen>&prompt.user; <userinput>svn diff --no-diff-deleted --old=svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/dist</replaceable> --new=.</userinput></screen> <para>The <literal>--no-diff-deleted</literal> tells Subversion not to complain about files that are in the @@ -1919,10 +1919,10 @@ U stable/9/share/man/man4/netmap.4 <para>First, prepare the directory in <filename>vendor</filename>:</para> - <screen>&prompt.user; <userinput>svn co --depth immediates $FSVN/vendor</userinput> -&prompt.user; <userinput>cd vendor</userinput> -&prompt.user; <userinput>svn mkdir byacc</userinput> -&prompt.user; <userinput>svn mkdir byacc/dist</userinput></screen> + <screen>&prompt.user; <userinput>svn co --depth immediates <replaceable>$FSVN/vendor</replaceable></userinput> +&prompt.user; <userinput>cd <replaceable>vendor</replaceable></userinput> +&prompt.user; <userinput>svn mkdir <replaceable>byacc</replaceable></userinput> +&prompt.user; <userinput>svn mkdir <replaceable>byacc/dist</replaceable></userinput></screen> <para>Now, import the sources into the <filename>dist</filename> directory. @@ -1931,7 +1931,7 @@ U stable/9/share/man/man4/netmap.4 the imported version. To save time and bandwidth, direct remote committing and tagging is possible:</para> - <screen>&prompt.user; <userinput>svn cp -m "Tag byacc 20120115" $FSVN/vendor/byacc/dist $FSVN/vendor/byacc/20120115</userinput></screen> + <screen>&prompt.user; <userinput>svn cp -m <replaceable>"Tag byacc 20120115"</replaceable> <replaceable>$FSVN/vendor/byacc/dist</replaceable> <replaceable>$FSVN/vendor/byacc/20120115</replaceable></userinput></screen> </sect5> <sect5> @@ -1940,7 +1940,7 @@ U stable/9/share/man/man4/netmap.4 <para>Due to this being a new file, copy it for the merge:</para> - <screen>&prompt.user; <userinput>svn cp -m "Import byacc to contrib" $FSVN/vendor/byacc/dist $FSVN/head/contrib/byacc</userinput></screen> + <screen>&prompt.user; <userinput>svn cp -m <replaceable>"Import byacc to contrib"</replaceable> <replaceable>$FSVN/vendor/byacc/dist</replaceable> <replaceable>$FSVN/head/contrib/byacc</replaceable></userinput></screen> <para>Working normally on newly imported sources is still possible.</para> @@ -2102,7 +2102,7 @@ U stable/9/share/man/man4/netmap.4 work that is beneficial to the &os; community in some way but not intended to be merged directly back into HEAD then the proper location is - <filename>base/user/your-name/</filename>. <link + <filename>base/user/<replaceable>your-name</replaceable>/</filename>. <link xlink:href="http://svnweb.freebsd.org/base/projects/GUIDELINES.txt">This page</link> contains further details.</para> @@ -2262,7 +2262,7 @@ ControlPersist yes</screen> <listitem> <para>Add an entry for yourself to - <filename>src/share/misc/committers-repository.dot</filename>, + <filename>src/share/misc/committers-<replaceable>repository</replaceable>.dot</filename>, where repository is either doc, ports or src, depending on the commit privileges you obtained.</para> </listitem> @@ -2336,7 +2336,7 @@ ControlPersist yes</screen> <listitem> <para>Log into <systemitem>hub.FreeBSD.org</systemitem> and - create a <filename>/var/forward/user</filename> (where + create a <filename>/var/forward/<replaceable>user</replaceable></filename> (where <replaceable>user</replaceable> is your username) file containing the e-mail address where you want mail addressed to @@ -2676,7 +2676,7 @@ Relnotes: yes</programlisting> areas, to our shame), the same applies. If, however, you are about to modify something which is clearly being actively maintained by someone else (and it is only by watching the - <literal>repository-committers</literal> mailing list that you + <literal><replaceable>repository</replaceable>-committers</literal> mailing list that you can really get a feel for just what is and is not) then consider sending the change to them instead, just as you would have before becoming a committer. For ports, you should contact the @@ -2773,7 +2773,7 @@ Relnotes: yes</programlisting> for tracking bugs and change requests. Be sure that if you commit a fix or suggestion found in a <application>GNATS</application> PR, you use - <command>edit-pr pr-number</command> on + <command>edit-pr <replaceable>pr-number</replaceable></command> on <systemitem>freefall</systemitem> to close it. It is also considered nice if you take time to close any PRs associated with your commits, if appropriate. You can also make use of @@ -2840,11 +2840,11 @@ Relnotes: yes</programlisting> command.</para> <para>For example, to assign PR 123456 to yourself type - <command>take-pr 123456</command>. + <command>take-pr <replaceable>123456</replaceable></command>. If you want to set the PR to patched awaiting an MFC at the same time use: <command>change-pr -t -p -m "awaiting MFC" - 123456</command></para> + <replaceable>123456</replaceable></command></para> </sect2> </sect1> @@ -3020,7 +3020,7 @@ Relnotes: yes</programlisting> <filename>$HOME/.ssh/id_rsa.pub</filename>) to the person setting you up as a committer so it can be put into the - <filename>yourlogin</filename> + <filename><replaceable>yourlogin</replaceable></filename> file in <filename>/etc/ssh-keys/</filename> on <systemitem>freefall</systemitem>.</para> @@ -3824,7 +3824,7 @@ Relnotes: yes</programlisting> <screen>&prompt.root; <userinput>make install</userinput> &prompt.root; <userinput>make package</userinput> &prompt.root; <userinput>make deinstall</userinput> -&prompt.root; <userinput>pkg_add package you built above</userinput> +&prompt.root; <userinput>pkg_add <replaceable>package you built above</replaceable></userinput> &prompt.root; <userinput>make deinstall</userinput> &prompt.root; <userinput>make reinstall</userinput> &prompt.root; <userinput>make package</userinput></screen> @@ -3948,8 +3948,8 @@ Relnotes: yes</programlisting> and then copy the last living revision of the port:</para> - <screen>&prompt.user; <userinput>cd /usr/ports/category -</userinput>&prompt.user; <userinput>svn cp 'svn+ssh://svn.freebsd.org/ports/head/category/portname/@{YYYY-MM-DD}' portname</userinput></screen> + <screen>&prompt.user; <userinput>cd /usr/ports/<replaceable>category</replaceable></userinput> +&prompt.user; <userinput>svn cp 'svn+ssh://svn.freebsd.org/ports/head/<replaceable>category</replaceable>/<replaceable>portname</replaceable>/@{<replaceable>YYYY-MM-DD</replaceable>}' <replaceable>portname</replaceable></userinput></screen> <para>Pick a date that is before the removal but after the last true commit.</para> @@ -4381,9 +4381,9 @@ Relnotes: yes</programlisting> <para>To do this, use the <filename>chkorigin.sh</filename> tool, as follows: <command>env - PORTSDIR=/path/to/ports + PORTSDIR=<replaceable>/path/to/ports</replaceable> sh -e - /path/to/ports/Tools/scripts/chkorigin.sh</command>. + <replaceable>/path/to/ports</replaceable>/Tools/scripts/chkorigin.sh</command>. This will check <emphasis>every</emphasis> port in the ports tree, even those not connected to the build, so you can run it directly after the move
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201404130129.s3D1Te3O052907>