Bug 199103 - 10.1 boot(8) docs loacking and/or inaccurate
Summary: 10.1 boot(8) docs loacking and/or inaccurate
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-04-01 21:21 UTC by heas
Modified: 2020-07-11 19:53 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
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 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 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