Re: svn commit: r344570 - head/usr.sbin/sysrc
On Tue, 26 Feb 2019 at 23:53, Jilles Tjoelker wrote: > 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: https://svnweb.freebsd.org/changeset/base/344570 > > > > 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. > Alright! Thank you for a review ;) I'll be more precise next time. 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 like it as well. ___ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
Re: svn commit: r344570 - head/usr.sbin/sysrc
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: https://svnweb.freebsd.org/changeset/base/344570 > > 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 convention. 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 ___ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
Re: svn commit: r344570 - head/usr.sbin/sysrc
[ Charset UTF-8 unsupported, converting... ] > Author: 0mp (ports committer) > Date: Tue Feb 26 09:28:10 2019 > New Revision: 344570 > URL: https://svnweb.freebsd.org/changeset/base/344570 > > 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. I thank you for the cleanup. > Reviewed by:bcr > Approved by:bcr (doc) > Approved by:krion (mentor, implicit), mat (mentor, implicit) > Differential Revision: https://reviews.freebsd.org/D19348 > > Modified: > head/usr.sbin/sysrc/sysrc.8 > > Modified: head/usr.sbin/sysrc/sysrc.8 > == > --- head/usr.sbin/sysrc/sysrc.8 Tue Feb 26 08:18:34 2019 > (r344569) > +++ head/usr.sbin/sysrc/sysrc.8 Tue Feb 26 09:28:10 2019 > (r344570) > @@ -24,7 +24,7 @@ > .\" > .\" $FreeBSD$ > .\" > -.Dd February 2, 2016 > +.Dd February 26, 2019 > .Dt SYSRC 8 > .Os > .Sh NAME > @@ -144,7 +144,7 @@ Disable verbose and hide certain errors. > When combined with > .Sq Fl L > and one or more > -.Li Ar name > +.Ar name > arguments, provide only exit status and no output. > .It Fl R Ar dir > Operate within the root directory > @@ -216,7 +216,8 @@ The list of system configuration files is configured i > within the variable > .Ql rc_conf_files , > which by-default contains a space-separated list of pathnames. > -On all FreeBSD > +On all > +.Fx > systems, this defaults to the value "/etc/rc.conf /etc/rc.conf.local". > Each > pathname is sourced in-order upon startup. > @@ -276,7 +277,7 @@ it is added > For convenience, if the first character is alpha-numeric > .Pq letters A-Z, a-z, or numbers 0-9 , > dot > -.Pq Li . , > +.Pq Li \&. , > or slash > .Pq Li / , > .Nm > @@ -334,7 +335,7 @@ it is removed > For convenience, if the first character is alpha-numeric > .Pq letters A-Z, a-z, or numbers 0-9 , > dot > -.Pq Li . , > +.Pq Li \&. , > or slash > .Pq Li / , > .Nm > @@ -466,11 +467,11 @@ cloned_interfaces+"alternate" > .Dl returns "alternate" if $cloned_interfaces is set . > .Sh SEE ALSO > .Xr rc.conf 5 , > -.Xr rc.subr 8 , > .Xr jail 8 , > .Xr jexec 8 , > .Xr jls 8 , > .Xr rc 8 , > +.Xr rc.subr 8 , > .Xr sysctl 8 > .Sh HISTORY > A > > -- Rod Grimes rgri...@freebsd.org ___ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
svn commit: r344570 - head/usr.sbin/sysrc
Author: 0mp (ports committer) Date: Tue Feb 26 09:28:10 2019 New Revision: 344570 URL: https://svnweb.freebsd.org/changeset/base/344570 Log: sysrc.8: Pet igor and mandoc Reviewed by: bcr Approved by: bcr (doc) Approved by: krion (mentor, implicit), mat (mentor, implicit) Differential Revision:https://reviews.freebsd.org/D19348 Modified: head/usr.sbin/sysrc/sysrc.8 Modified: head/usr.sbin/sysrc/sysrc.8 == --- head/usr.sbin/sysrc/sysrc.8 Tue Feb 26 08:18:34 2019(r344569) +++ head/usr.sbin/sysrc/sysrc.8 Tue Feb 26 09:28:10 2019(r344570) @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd February 2, 2016 +.Dd February 26, 2019 .Dt SYSRC 8 .Os .Sh NAME @@ -144,7 +144,7 @@ Disable verbose and hide certain errors. When combined with .Sq Fl L and one or more -.Li Ar name +.Ar name arguments, provide only exit status and no output. .It Fl R Ar dir Operate within the root directory @@ -216,7 +216,8 @@ The list of system configuration files is configured i within the variable .Ql rc_conf_files , which by-default contains a space-separated list of pathnames. -On all FreeBSD +On all +.Fx systems, this defaults to the value "/etc/rc.conf /etc/rc.conf.local". Each pathname is sourced in-order upon startup. @@ -276,7 +277,7 @@ it is added For convenience, if the first character is alpha-numeric .Pq letters A-Z, a-z, or numbers 0-9 , dot -.Pq Li . , +.Pq Li \&. , or slash .Pq Li / , .Nm @@ -334,7 +335,7 @@ it is removed For convenience, if the first character is alpha-numeric .Pq letters A-Z, a-z, or numbers 0-9 , dot -.Pq Li . , +.Pq Li \&. , or slash .Pq Li / , .Nm @@ -466,11 +467,11 @@ cloned_interfaces+"alternate" .Dl returns "alternate" if $cloned_interfaces is set . .Sh SEE ALSO .Xr rc.conf 5 , -.Xr rc.subr 8 , .Xr jail 8 , .Xr jexec 8 , .Xr jls 8 , .Xr rc 8 , +.Xr rc.subr 8 , .Xr sysctl 8 .Sh HISTORY A ___ svn-src-head@freebsd.org mailing list https://lists.freebsd.org/mailman/listinfo/svn-src-head To unsubscribe, send any mail to "svn-src-head-unsubscr...@freebsd.org"
