Bug 165920

Summary: [PATCH] Committer's Guide: Various fixes
Product: Documentation Reporter: Chris Rees <crees>
Component: Books & ArticlesAssignee: Glen Barber <gjb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Chris Rees 2012-03-11 09:20:09 UTC
	- Link to Subversion Primer in Committer's Guide rather than the wiki
	- Use <note> rather than "It is important to note that"
	- Spelling fixes

Fix: 

-- 
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.--N3Vk2yGmDW1giXVXqgnVeTu5TsrerchQJY7kbZXP426lTe3h
Content-Type: text/plain; name="patch.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="patch.txt"

? article.html
? docbook.css
? patch.txt
Index: article.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v
retrieving revision 1.312
diff -u -r1.312 article.sgml
--- article.sgml	11 Mar 2012 01:17:35 -0000	1.312
+++ article.sgml	11 Mar 2012 09:12:58 -0000
@@ -857,10 +857,8 @@
 	</table>
 
 	<para>The following are some Subversion examples related to the
-	  src repository.  More (in-depth) information can be found at
-	  <ulink
-	    url="http://wiki.freebsd.org/SubversionPrimer">Subversion
-	    Primer</ulink> and <ulink
+	  src repository.  More (in-depth) information can be found in the
+	  Subversion Primer at <xref linkend="subversion-primer"> and <ulink
 	    url="http://wiki.freebsd.org/SubversionMissing">List of
 	    things missing in Subversion when compared to CVS</ulink>.
 	  The notes at <ulink
@@ -1222,7 +1220,7 @@
 	<para>The local <acronym>SVK</acronym> repository will be
 	  stored in <filename
 	    class="directory">~/.svk/local/</filename>, but can be
-	  moved to whereever suits.  If it is moved,
+	  moved to wherever suits.  If it is moved,
 	  <filename>~/.svk/config</filename> should be amended
 	  manually to reflect the move.</para>
 
@@ -1246,8 +1244,7 @@
 	    already.</para>
 	</note>
 
-	<para>To use &a.peter;'s tarball mentioned in the note
-	  above:</para>
+	<para>To use the tarball referenced above:</para>
 
 	<screen>&prompt.user; <userinput>cd ~</userinput>
 &prompt.user; <userinput>scp freefall:/home/peter/dot_svk_r179646.tbz2 .</userinput>
@@ -1444,8 +1441,9 @@
 	  <literal>stable/7</literal>; it will not pull down the whole
 	  tree.</para>
 
-	<para>It is useful to note that decreasing the depth of a
-	  working copy is not possible.</para>
+	<note>
+	  <para>Decreasing the depth of a working copy is not possible.</para>
+	</note>
       </sect3>
 
       <sect3>
@@ -1494,13 +1492,13 @@
 	  <acronym>SVN</acronym> and <acronym>SVK</acronym> do not
 	  need to be told in advance about file editing.</para>
 
-	<para><command>svn commit</command>works like the equivalent
+	<para><command>svn commit</command> works like the equivalent
 	  <acronym>CVS</acronym> command.  To commit all changes in
 	  the current directory and all subdirectories:</para>
 
 	<screen>&prompt.user; <userinput>svn commit</userinput></screen>
 
-	<para>To commit all changes in, for example, the <filename
+	<para>To commit all changes in, for example, <filename
 	    class="directory"><replaceable>lib/libfetch/</replaceable></filename>
 	  and <filename
 	    class="directory"><replaceable>usr/bin/fetch/</replaceable></filename>
@@ -1606,14 +1604,14 @@
       <sect3>
 	<title>Diffs</title>
 
-	<para>The <command>svn diff</command> displays changes to the
-	  working copy of the repository.  <acronym>SVN</acronym>'s
-	  diffs are unified by default, unlike
-	  <acronym>CVS</acronym>'s, and <acronym>SVN</acronym>'s
-	  include new files by default in the diff output.</para>
+	<para><command>svn diff</command> displays changes to the
+	  working copy of the repository.  Diffs generated by
+	  <acronym>SVN</acronym> are unified by default, unlike
+	  <acronym>CVS</acronym>, and include new files by default
+	  in the diff output.</para>
 
-	<para>Like <command>cvs diff</command>, <command>svn
-	    diff</command> can show the changes between two revisions
+	<para>As with <acronym>CVS</acronym>, <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>
Comment 1 Glen Barber freebsd_committer freebsd_triage 2012-03-11 14:38:37 UTC
Responsible Changed
From-To: freebsd-doc->gjb

I'll take it.
Comment 2 dfilter service freebsd_committer freebsd_triage 2012-03-11 15:32:26 UTC
gjb         2012-03-11 15:32:12 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/articles/committers-guide article.sgml 
  Log:
  - Link to Subversion Primer in Committer's Guide rather than the wiki
  - Use <note> rather than "It is important to note that"
  - Grammar fixes
  
  PR:             165920
  Submitted by:   crees
  
  Revision  Changes    Path
  1.313     +17 -17    doc/en_US.ISO8859-1/articles/committers-guide/article.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 3 Glen Barber freebsd_committer freebsd_triage 2012-03-11 15:32:46 UTC
State Changed
From-To: open->closed

Committed with very minor tweaks.  Thanks! 

The change will be reflected after the next doc build.
Comment 4 Isabell Long 2012-03-15 14:40:34 UTC
Hey,

On 11 March 2012 09:15, Chris Rees <crees@physics.org> wrote:
>>Description:
> =A0 =A0 =A0 =A0- Link to Subversion Primer in Committer's Guide rather th=
an the wiki
> =A0 =A0 =A0 =A0- Use <note> rather than "It is important to note that"
> =A0 =A0 =A0 =A0- Spelling fixes

Just noticed these edits.  Thanks.  I apologise for making them in the
first place (converting this to SGML was one of my GCIN tasks).
Although having said that, I didn't convert the VendorImports section
of that Primer and it has now disappeared from the Wiki page.  Should
I find an old version of that page and sit down and convert it once
and for all as I have been meaning to for months?  I have time this
weekend.  :-)  Especially given this sentence: "For information about
vendor imports, see the next section in this primer."  This looks
unprofessional, so until it is done I will remove this and submit a
patch with it removed.  I'd like to do that at least.  :-)

Thanks,

Isabell.
Comment 5 Isabell Long 2012-03-15 14:45:11 UTC
On 15 March 2012 14:40, Isabell Long <isabell121@gmail.com> wrote:
> I apologise for making them in the
> first place [...]

Er, obviously this should have read "I apologise for making the errors
in the first place."