svn commit: r344570 - head/usr.sbin/sysrc

Jilles Tjoelker jilles at
Tue Feb 26 22:53:12 UTC 2019

On Tue, Feb 26, 2019 at 04:47:59AM -0800, Rodney W. Grimes wrote:
> [ Charset UTF-8 unsupported, converting... ]
> > Author: 0mp (ports committer)
> > Date: Tue Feb 26 09:28:10 2019
> > New Revision: 344570
> > URL:

> > Log:
> >   sysrc.8: Pet igor and mandoc

> This only tells the source of why you changed some,
> a good commit log entry tells me that, and what it
> is that you changed.  You normally do not need to
> name the file your changed in a commit log as the
> log is attached to the file, sometimes it does make
> since to mention a file name in a log entry when you
> are describing the changes to just that file in a
> commit that includes many files.

> A better log might of been:
>   Pet igor and mandoc.  Remove unneeded .Li, use .Fx as needed,
>   escape hard stop, and sort cross references.

Naming the affected area, file or directory can be useful to make the
commit message understandable outside of its file's context without
needing to look at the diff or list of changed files. Even better, there
is a convention of making the first line of the commit message a
summary. When following this convention, displaying just the first line
of each commit's message allows a good overview of recent changes in the
whole tree. I'm happy to see that quite a few committers follow this

An extended description can follow the summary after an empty line, but
I don't think it is necessary for this commit as the information that
would be written there is obvious from the diff.

Jilles Tjoelker

More information about the svn-src-all mailing list