Bug 234248

Summary:	rc.conf(5): Description of kld_list doesn't specify format of list
Product:	Documentation	Reporter:	David Fiander <david>
Component:	Manual Pages	Assignee:	Chris Rees <crees>
Status:	Closed FIXED
Severity:	Affects Only Me	CC:	000.fbsd, crees, doc, ml-freebsd.org, rc
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description David Fiander 2018-12-21 15:08:58 UTC

The description of the rc.conf variable "kld_list" is "(str) A list of kernel modules to load right after the local disks are mounted.  Loading modules at this point in the boot process is much faster than doing it via /boot/loader.conf for those modules not necessary for mounting local disk."

It doesn't give the format of the list. Is is space separated, comma separated, or something else? (Empirically, a space separated list works.) The descriptions of kldxref_module_path, the jail_* variables, and netwait_ip do describe the format of their respective lists.

Comment 1 Miroslav Lachman 2018-12-23 14:36:28 UTC

Space or comma isn't the only info missing here. There should be some info (example) if it should be just module name, or with "ko" extension or with full path.

A) kld_list="ipmi accf_http"
B) kld_list="ipmi.ko accf_http.ko"
C) kld_list="/boot/kernel/ipmi.ko /boot/kernel/accf_http.ko"

Comment 2 Chris Rees freebsd_committer

2018-12-23 22:35:26 UTC

I'll take it.

Comment 3 commit-hook freebsd_committer

2018-12-24 10:48:51 UTC

A commit references this bug:

Author: crees
Date: Mon Dec 24 10:47:49 UTC 2018
New revision: 342389
URL: https://svnweb.freebsd.org/changeset/base/342389

Log:
  Clarify kld_list format

  PR:		docs/234248
  Submitted by:	David Fiander
  Submitted by:	Miroslav Lachman

Changes:
  head/share/man/man5/rc.conf.5

Comment 4 Chris Rees freebsd_committer

2018-12-24 10:50:21 UTC

Fixed, thanks!

Comment 5 commit-hook freebsd_committer

2019-04-07 18:31:50 UTC

A commit references this bug:

Author: crees
Date: Sun Apr  7 18:31:47 UTC 2019
New revision: 346017
URL: https://svnweb.freebsd.org/changeset/base/346017

Log:
  Remove now unnecessary kldstat check before attempting to load modules.

  Since r233109, kldload has the -n option, which silently ignores options
  that are already loaded.

  https://lists.freebsd.org/pipermail/freebsd-rc/2018-December/003899.html

  Note that this script no longer reports if the module is already loaded,
  but it could be argued this wasn't particularly useful information.

  PR:			docs/234248
  Reviewed by:		bcr (docs), kib, rgrimes (visual)
  Approved by:		jilles
  Differential Revision:	https://reviews.freebsd.org/D18670

Changes:
  head/libexec/rc/rc.d/abi
  head/libexec/rc/rc.d/bthidd
  head/libexec/rc/rc.d/cfumass
  head/libexec/rc/rc.d/kld
  head/libexec/rc/rc.d/mdconfig
  head/libexec/rc/rc.d/mdconfig2
  head/libexec/rc/rc.d/mountcritremote
  head/libexec/rc/rc.d/syscons
  head/libexec/rc/rc.subr
  head/share/man/man5/rc.conf.5

Comment 6 Mike Lempriere 2020-04-27 22:43:57 UTC

Still a problem in 12.1-RELEASE-p2.

Comment 7 Chris Rees freebsd_committer

2020-04-28 07:50:43 UTC

Ah, I didn't merge it- the second commit ended up reverted and I've sort of left it there.

The docs fix I'll merge.

Comment 8 commit-hook freebsd_committer

2021-03-03 15:34:47 UTC

A commit in branch stable/12 references this bug:

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

commit 949eb16e3b4dff61fa99c0c0a8be49ba38bea053
Author:     Chris Rees <crees@FreeBSD.org>
AuthorDate: 2018-12-24 10:47:48 +0000
Commit:     Chris Rees <crees@FreeBSD.org>
CommitDate: 2021-03-03 15:34:09 +0000

    Clarify kld_list format

    PR:             docs/234248
    Submitted by:   David Fiander
    Submitted by:   Miroslav Lachman

    (cherry picked from commit 261e62db4c62ecab7c8d8055b1a548acb80c16dc)

 share/man/man5/rc.conf.5 | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comment 9 Chris Rees freebsd_committer

2021-03-03 15:41:48 UTC

Merged to stable/12