Bug 85128

Summary: [patch] loader.conf(5) autoboot_delay incompletly described
Product: Documentation Reporter: Gary W. Swearingen <garys>
Component: Manual PagesAssignee: Warner Losh <imp>
Status: Closed FIXED    
Severity: Affects Only Me CC: bcr, doc, imp
Priority: Normal Keywords: patch
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://reviews.freebsd.org/D11887
Attachments:
Description Flags
loader.diff none

Description Gary W. Swearingen 2005-08-19 18:20:09 UTC
The description of "autoboot_delay" variable in
/boot/defaults/loader.conf does not mention it's "NO" special
value.

A variable of the same name is described in loader(8), but it is by no
means obvious whether it's the same variable or just another set at the
loader prompt.

The variable is only the one in loader.conf that has more than a brief
comment, leading me to wonder if it shouldn't be described in
loader.conf(5) manpage instead, but the first paragraph of its
"Default Settings" section  makes me wonder.

Fix: 

Decide whether full description belongs in loader(8), loader.conf(5),
or /boot/defaults/loader.conf.  I don't know about loader(8), but I'm
thinking a full description should be in loader.conf(5) and referenced
from comment in "/boot/defaults/loader.conf".

I'll write patch after change is agreed on.
Comment 1 Giorgos Keramidas 2005-08-20 02:28:50 UTC
On 2005-08-19 10:17, "Gary W. Swearingen" <garys@opusnet.com> wrote:
> The description of "autoboot_delay" variable in
> /boot/defaults/loader.conf does not mention it's "NO" special
> value.
>
> A variable of the same name is described in loader(8), but it is by no
> means obvious whether it's the same variable or just another set at the
> loader prompt.
>
> The variable is only the one in loader.conf that has more than a brief
> comment, leading me to wonder if it shouldn't be described in
> loader.conf(5) manpage instead, but the first paragraph of its
> "Default Settings" section  makes me wonder.
>
> >Fix:
>
> Decide whether full description belongs in loader(8), loader.conf(5),
> or /boot/defaults/loader.conf.  I don't know about loader(8), but I'm
> thinking a full description should be in loader.conf(5) and referenced
> from comment in "/boot/defaults/loader.conf".

That seems reasonable.  Duplicating the description is not really useful
and having the loader options described in loader.conf(5) seems a good
thing.
Comment 2 Daniel Gerzo 2005-12-30 22:18:13 UTC
Hello,

   Included diff should fix your report, it also adds some more
   information to the autoboot_delay when set to -1.

   discussed with, and help provided by: ceri@

-- 
Cheers,
   Daniel Gerzo
Comment 3 Benedict Reuschling freebsd_committer freebsd_triage 2017-08-05 22:08:25 UTC
I've opened a review for this issue here: https://reviews.freebsd.org/D11887
Comment 4 Warner Losh freebsd_committer freebsd_triage 2021-07-08 23:35:29 UTC
I'm grabbing to make sure the code review gets committed.
Comment 5 commit-hook freebsd_committer freebsd_triage 2021-07-12 21:15:08 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=71f6aea4150c66784cbad42c1e1ff908d909c2ec

commit 71f6aea4150c66784cbad42c1e1ff908d909c2ec
Author:     Daniel Gerzo <danger@FreeBSD.org>
AuthorDate: 2021-07-12 21:13:03 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2021-07-12 21:13:03 +0000

    loader: update autoboot description and move to loader.conf.5

    Document "NO" special value for the autoboot_delay and move the
    description to loader.conf.5.

    imp reworked some of the wording from danger's patch.

    Reviewed by:            imp
    PR:                     85128
    Differential Revision:  https://reviews.freebsd.org/D11887

 stand/defaults/loader.conf.5 | 43 ++++++++++++++++++++++++++++++++++++++++++-
 stand/man/loader.8           | 31 ++-----------------------------
 2 files changed, 44 insertions(+), 30 deletions(-)
Comment 6 commit-hook freebsd_committer freebsd_triage 2021-07-16 18:30:56 UTC
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=f32c4c3b00c46c52d00679dbf98d431b747ad305

commit f32c4c3b00c46c52d00679dbf98d431b747ad305
Author:     Daniel Gerzo <danger@FreeBSD.org>
AuthorDate: 2021-07-12 21:13:03 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2021-07-16 18:28:44 +0000

    loader: update autoboot description and move to loader.conf.5

    Document "NO" special value for the autoboot_delay and move the
    description to loader.conf.5.

    imp reworked some of the wording from danger's patch.

    Reviewed by:            imp
    PR:                     85128
    Differential Revision:  https://reviews.freebsd.org/D11887

    (cherry picked from commit 71f6aea4150c66784cbad42c1e1ff908d909c2ec)

 stand/defaults/loader.conf.5 | 43 ++++++++++++++++++++++++++++++++++++++++++-
 stand/man/loader.8           | 31 ++-----------------------------
 2 files changed, 44 insertions(+), 30 deletions(-)
Comment 7 commit-hook freebsd_committer freebsd_triage 2021-10-08 16:10:33 UTC
A commit in branch stable/12 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=d9735b8c10b6d56fb1c62f1e943dfe0a5bfae5af

commit d9735b8c10b6d56fb1c62f1e943dfe0a5bfae5af
Author:     Daniel Gerzo <danger@FreeBSD.org>
AuthorDate: 2021-07-12 21:13:03 +0000
Commit:     Kyle Evans <kevans@FreeBSD.org>
CommitDate: 2021-10-08 08:15:08 +0000

    loader: update autoboot description and move to loader.conf.5

    Document "NO" special value for the autoboot_delay and move the
    description to loader.conf.5.

    imp reworked some of the wording from danger's patch.

    PR:                     85128

    (cherry picked from commit 71f6aea4150c66784cbad42c1e1ff908d909c2ec)

 stand/defaults/loader.conf.5 | 41 +++++++++++++++++++++++++++++++++++++++++
 stand/man/loader.8           | 31 ++-----------------------------
 2 files changed, 43 insertions(+), 29 deletions(-)