This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [WWW] PR doc/34120 bugs/reghunt.html should be updated to mention svn


On Wed, 27 Aug 2008, Manuel LÃpez-IbÃÃez wrote:
> svn.html and rsync.html are also modified to fix some inconsistencies
> and prevent duplication.

Nice.  Let's have a look at svn.html first; the others asap.

Index: htdocs/svn.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/svn.html,v
retrieving revision 1.97
diff -u -r1.97 svn.html
--- htdocs/svn.html	20 Aug 2008 05:08:24 -0000	1.97
+++ htdocs/svn.html	27 Aug 2008 13:45:29 -0000
@@ -38,14 +38,9 @@
 check out the GCC sources using the following command:</p>
 
 <blockquote><p>
-<code>svn -q checkout svn://gcc.gnu.org/svn/gcc/trunk gcc</code>
+<code>svn co svn://gcc.gnu.org/svn/gcc/trunk gcc</code>
 </p></blockquote>
 
-<p>(The option <code>-q</code> above is optional and instructs SVN to
-print as little as possible.  You can abbreviate <code>checkout</code>
-as <code>co</code>.  Instead of <code>gcc</code> you can specify any
-other local directory name to receive the GCC sources.)</p>

Omitting -q is fine.  I believe we should be using the full name, i.e.,
"svn checkout" instead of "svn co", though, since that is also what svn
primarily shows for "svn help".  The comment

   "Instead of <code>gcc</code> you can specify any other local directory 
   name to receive the GCC sources."

may be useful for some, so I'd keep it or change the directory name to
something like "SomeLocalDir".


-<h2 id="tags">SVN tags, branches and checkouts</h2>
+<h2 id="tags"><a name="svnbranches">Branches and Tags</a></h2>

The page already is svn.html, so this would lead to svn.html#svnbranches. 
svn.html#branches seems preferrable, but I don't think we should add an <a 
name...> on top of an id.  Can't we just use the id for cross-references?

+ The following list therefore provides only some representative
+examples.</p>

Extra " " at the beginning, and how about the simpler "...list provides
some representative examples"?

+<p>To get a list of available branches, use the command:

Nice!

+<blockquote><p>
+<code>svn ls svn://gcc.gnu.org/svn/gcc/branches</code>
+</p></blockquote>
+</p>

I believe the validator will complain about the outer </p> not 
ending before <blockquote>.


Thanks for doing this!  Please consider the comments above and apply.

Gerald

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]