[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r1815812 - /subversion/site/staging/quick-start.html

From: Johan Corveleyn <jcorvel_at_gmail.com>
Date: Wed, 22 Nov 2017 14:58:09 +0100

On Mon, Nov 20, 2017 at 3:58 PM, <lyalyakin_at_apache.org> wrote:
> Author: lyalyakin
> Date: Mon Nov 20 14:58:39 2017
> New Revision: 1815812
>
> URL: http://svn.apache.org/viewvc?rev=1815812&view=rev
> Log:
> * staging/quick-start.html
> Make TOC (Table of Contents) contain h2 sections only for now.
>
> Modified:
> subversion/site/staging/quick-start.html
>
> Modified: subversion/site/staging/quick-start.html
> URL: http://svn.apache.org/viewvc/subversion/site/staging/quick-start.html?rev=1815812&r1=1815811&r2=1815812&view=diff
> ==============================================================================
> --- subversion/site/staging/quick-start.html (original)
> +++ subversion/site/staging/quick-start.html Mon Nov 20 14:58:39 2017
> @@ -1,4 +1,4 @@
> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"

^^^ Oops, you added a BOM again (thanks to Stefan Hett for spotting
this ... I had totally missed it :-)).

For the rest, this and your 3 subsequent commits look fine.
However, I think you could have just performed all 4 changes in 1
commit. They are all small corrections in a single document, in
response to my review. So you could have done this in one commit with
a log message like:

[[[
* staging/quick-start.html
  (TOC): Only refer to h2 sections for now.
  (setting-up-a-local-repo): Change "file:// schema" to "file:// scheme".
  ...
]]]

If you're doing changes in totally different areas of the website, or
which are logically vastly different, I'd do them in seperate commits.
But small corrections like these, in the same file, should be grouped
together.

Also, I'm absolutely not sensitive about this, but you should probably
mention my name (or the name of whoever has contributed to your
commit) in the log message with our standard "crediting" format.
"Found by: jcorvel" or similar. See:
http://subversion.apache.org/docs/community-guide/conventions.html#crediting

-- 
Johan
Received on 2017-11-22 14:58:41 CET

This is an archived mail posted to the Subversion Dev mailing list.