Bug 199103

Summary: 10.1 boot(8) docs loacking and/or inaccurate
Product: Documentation Reporter: heas
Component: Manual PagesAssignee: freebsd-bugs (Nobody) <bugs>
Status: Closed FIXED    
Severity: Affects Only Me CC: allanjude, doc, jhb
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   

Description heas 2015-04-01 21:21:33 UTC 
Speaking largely about 10.1-RELEASE:

boot(8) & https://www.freebsd.org/cgi/man.cgi?query=boot%288%29 missing reference material for zfsloader and zfs device information, such as for currdev.

zfsloader(8) missing; s.b. link to loader(8)

documentation for boot.config appears to be wrong, at least for zfs bootblocks. For example, '# echo "-D -S 115200 " > /boot.config' from manpage or https://www.freebsd.org/doc/handbook/serialconsole-setup.html results in a host that stops after loading the bootblocks, as in:
>> FreeBSD/i386 BOOT
Default: 0:ad(0,a)/boot/loader
boot:
then you face the zfs-related documentation issues.

/boot/zfsloader -D -S 115200 does not work either.
rpool:/boot/zfsloader -D -S 115200 also not.
zfs:rpool:/boot/zfsloader -D -S 115200 also not.
Comment 1 heas 2015-04-01 21:23:13 UTC 
Also, loader(8) says:
     During initialization, loader will probe for a console and set the
     console variable, or set it to serial console (“comconsole”) if the pre‐
     vious boot stage used that.  If multiple consoles are selected, they will
     be listed separated by spaces.

But, https://www.freebsd.org/doc/handbook/serialconsole-setup.html indicates that the arguments are separated by a comma.
Comment 2 John Baldwin freebsd_committer freebsd_triage 2015-04-06 20:54:36 UTC 
Regarding space vs comma: the loader accepts either separator so both cases work.  I always use a space myself and the i386 loader uses spaces when it sets the initial console value in sys/boot/i386/loader/main.c if multiple consoles are enabled.
Comment 3 commit-hook freebsd_committer freebsd_triage 2020-07-11 19:19:23 UTC 
A commit references this bug:

Author: allanjude
Date: Sat Jul 11 19:18:44 UTC 2020
New revision: 363107
URL: https://svnweb.freebsd.org/changeset/base/363107

Log:
  boot(8): Add additional cross references

  Provide hints to direct people towards gptzfsboot, zfsbootcfg, efibootmgr, etc

  PR:		199103
  MFC after:	2 weeks
  Sponsored by:	Klara Inc.
  Event:		July 2020 Bugathon

Changes:
  head/sbin/reboot/boot_i386.8
Comment 4 Allan Jude freebsd_committer freebsd_triage 2020-07-11 19:53:02 UTC 
currdev is documented in loader(8), it is not part of the bootstrap.

Although the documentation for it is lacking.

I have started a review to improve it: https://reviews.freebsd.org/D25629
Comment 5 commit-hook freebsd_committer freebsd_triage 2020-07-13 02:09:29 UTC 
A commit references this bug:

Author: allanjude
Date: Mon Jul 13 02:09:21 UTC 2020
New revision: 363139
URL: https://svnweb.freebsd.org/changeset/base/363139

Log:
  Loader: explain the syntax of currdev

  The origin text was: "Syntax for devices is odd."
  That is not very helpful.

  PR:		199103
  Reviewed by:	kevans, tsoome
  Sponsored by:	Klara Inc.
  Event:		July 2020 Bugathon
  Differential Revision:	https://reviews.freebsd.org/D25629

Changes:
  head/stand/man/loader.8
Comment 6 commit-hook freebsd_committer freebsd_triage 2021-10-08 16:10:31 UTC 
A commit in branch stable/12 references this bug:

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

commit 3c880137ef67e784710178d7867c400de650abd3
Author:     Allan Jude <allanjude@FreeBSD.org>
AuthorDate: 2020-07-13 02:09:21 +0000
Commit:     Kyle Evans <kevans@FreeBSD.org>
CommitDate: 2021-10-08 08:12:01 +0000

    Loader: explain the syntax of currdev

    The origin text was: "Syntax for devices is odd."
    That is not very helpful.

    PR:             199103

    (cherry picked from commit 551d20f044f3fa5e4f59d6303f1a2a70c1bf2297)

 stand/man/loader.8 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)