Patch for rc.conf(8) man page
As mentioned before on misc@, some user got confused and copied the entire rc.conf file to rc.conf.local and then proceeded editing it. This patch brings the rc.conf man page closer to the text that is in the OpenBSD faq. Hopefully it will help newcomers avoiding this mistake. Index: share/man/man8/rc.conf.8 === RCS file: /cvs/src/share/man/man8/rc.conf.8,v retrieving revision 1.20 diff -u -p -u -r1.20 rc.conf.8 --- share/man/man8/rc.conf.817 Mar 2012 14:46:40 - 1.20 +++ share/man/man8/rc.conf.810 Feb 2014 19:59:00 - @@ -45,11 +45,13 @@ in the series in order to set shell variables used therein to control the behaviour of the scripts. .Pp -It is advisable to leave +We strongly suggest you do not alter .Nm rc.conf -untouched, and instead create and edit a new +itself. Instead create and edit a new .Nm rc.conf.local -file. +file and copy only the variables you wish to change from +.Nm rc.conf +and adjust them as you like. Variables set in this file will override variables previously set in .Nm rc.conf . .Pp -- Giancarlo Razzolini GPG: 4096R/77B981BC
Re: Patch for rc.conf(8) man page
Em 10-02-2014 18:28, Mark Kettenis escreveu: Date: Mon, 10 Feb 2014 18:05:38 -0200 From: Giancarlo Razzolini grazzol...@gmail.com As mentioned before on misc@, some user got confused and copied the entire rc.conf file to rc.conf.local and then proceeded editing it. This patch brings the rc.conf man page closer to the text that is in the OpenBSD faq. Hopefully it will help newcomers avoiding this mistake. I think your new text is not an improvement. Index: share/man/man8/rc.conf.8 === RCS file: /cvs/src/share/man/man8/rc.conf.8,v retrieving revision 1.20 diff -u -p -u -r1.20 rc.conf.8 --- share/man/man8/rc.conf.817 Mar 2012 14:46:40 - 1.20 +++ share/man/man8/rc.conf.810 Feb 2014 19:59:00 - @@ -45,11 +45,13 @@ in the series in order to set shell variables used therein to control the behaviour of the scripts. .Pp -It is advisable to leave +We strongly suggest you do not alter .Nm rc.conf -untouched, and instead create and edit a new +itself. Instead create and edit a new .Nm rc.conf.local -file. +file and copy only the variables you wish to change from +.Nm rc.conf +and adjust them as you like. Variables set in this file will override variables previously set in .Nm rc.conf . .Pp -- Giancarlo Razzolini GPG: 4096R/77B981BC The text on the faq should be revised then. This patch only makes the text on the man page closer to the faq. I believe that the man pages are to be considered the de facto source for documentation, not the other way around. What's your suggestion for the text? Cheers, -- Giancarlo Razzolini GPG: 4096R/77B981BC
Re: Patch for rc.conf(8) man page
On 2014/02/10 18:42, Giancarlo Razzolini wrote: Em 10-02-2014 18:28, Mark Kettenis escreveu: Date: Mon, 10 Feb 2014 18:05:38 -0200 From: Giancarlo Razzolini grazzol...@gmail.com As mentioned before on misc@, some user got confused and copied the entire rc.conf file to rc.conf.local and then proceeded editing it. This patch brings the rc.conf man page closer to the text that is in the OpenBSD faq. Hopefully it will help newcomers avoiding this mistake. I think your new text is not an improvement. Index: share/man/man8/rc.conf.8 === RCS file: /cvs/src/share/man/man8/rc.conf.8,v retrieving revision 1.20 diff -u -p -u -r1.20 rc.conf.8 --- share/man/man8/rc.conf.817 Mar 2012 14:46:40 - 1.20 +++ share/man/man8/rc.conf.810 Feb 2014 19:59:00 - @@ -45,11 +45,13 @@ in the series in order to set shell variables used therein to control the behaviour of the scripts. .Pp -It is advisable to leave +We strongly suggest you do not alter .Nm rc.conf -untouched, and instead create and edit a new +itself. Instead create and edit a new .Nm rc.conf.local -file. +file and copy only the variables you wish to change from +.Nm rc.conf +and adjust them as you like. Variables set in this file will override variables previously set in .Nm rc.conf . .Pp -- Giancarlo Razzolini GPG: 4096R/77B981BC The text on the faq should be revised then. This patch only makes the text on the man page closer to the faq. I believe that the man pages are to be considered the de facto source for documentation, not the other way around. What's your suggestion for the text? The existing text, Create and edit a _new_ rc.conf.local file seems fine to me - man pages are generally non-verbose - if copying was intended, the manual would have said so. The faq is more chatty, and I don't see a problem with the faq's text in this area either..
Re: Patch for rc.conf(8) man page
The existing text, Create and edit a _new_ rc.conf.local file seems fine to me - man pages are generally non-verbose - if copying was intended, the manual would have said so. Disagree. Create and edit... is ambiguous. I can create a new file by copying an old file and often do so. If you want the new file start out empty then say so. We strongly suggest you do not alter .Nm rc.conf . Instead, create an empty file named .Nm rc.conf.local . Edit the new file ... blah blah blah
Re: Patch for rc.conf(8) man page
Em 10-02-2014 19:34, Marco S Hyman escreveu: The existing text, Create and edit a _new_ rc.conf.local file seems fine to me - man pages are generally non-verbose - if copying was intended, the manual would have said so. Disagree. Create and edit... is ambiguous. I can create a new file by copying an old file and often do so. If you want the new file start out empty then say so. We strongly suggest you do not alter .Nm rc.conf . Instead, create an empty file named .Nm rc.conf.local . Edit the new file ... blah blah blah Follows the diff suggesting the creation of an empty file. Stuart, I don't think that in this case it's verbose. It's only changing the idea of advisable with a strong suggestion. The strong, makes all difference, specifically in the case mentioned on misc@, where the poster did not carefully read the man page. As I mentioned, our brain try to fill in the gaps and in this case, the word strong might shout: Hey, this is important, pay attention. But since I'm not a native English speaker, perhaps someone could suggest a change in the text both of the man page and the faq. Index: share/man/man8/rc.conf.8 === RCS file: /cvs/src/share/man/man8/rc.conf.8,v retrieving revision 1.20 diff -u -p -u -r1.20 rc.conf.8 --- share/man/man8/rc.conf.817 Mar 2012 14:46:40 - 1.20 +++ share/man/man8/rc.conf.810 Feb 2014 21:36:58 - @@ -45,11 +45,13 @@ in the series in order to set shell variables used therein to control the behaviour of the scripts. .Pp -It is advisable to leave +We strongly suggest you do not alter .Nm rc.conf -untouched, and instead create and edit a new +itself. Instead create an empty file named .Nm rc.conf.local -file. +file and copy only the variables you wish to change from +.Nm rc.conf +and adjust them as you like. Variables set in this file will override variables previously set in .Nm rc.conf . .Pp -- Giancarlo Razzolini GPG: 4096R/77B981BC
Re: Patch for rc.conf(8) man page
I prefer this ... --- rc.conf.8 Tue Feb 11 21:24:16 2014 +++ rc.conf.new.8 Fri Jan 3 00:44:18 2014 @@ -47,11 +47,11 @@ .Pp It is advisable to leave .Nm rc.conf -untouched, and instead create and edit a new +untouched. The +.Nm rc.conf +file includes a check for .Nm rc.conf.local -file. -Variables set in this file will override variables previously set in -.Nm rc.conf . +which can be used to override variables as required. .Pp Some variables are used to turn features on or off. For example, whether the system runs the
