svn commit: r356539 - head/share/man/man4

[Kyle Evans]

Author: kevans
Date: Thu Jan  9 04:39:37 2020
New Revision: 356539
URL: https://svnweb.freebsd.org/changeset/base/356539

Log:
  md(4): improve documentation of preloading
  
  It's not immediately clear by what mechanism loader(8) will be loading the
  preloaded file. Specifically name-drop loader.conf(5) with a pointer to the
  module loading section and a description of what the 'name' should look
  like, because that certainly isn't clear from the loader.conf(5) standpoint.
  
  The default loader.conf already has a pointer to md(4) where it appears and
  the reference to loader.conf in the new version of this manpage should make
  it more clear that this is where one should look for information.
  
  Reported by:	swills
  Reviewed by:	swills, manpages (bcr)
  With revision by:	imp
  MFC after:	3 days
  Differential Revision:	https://reviews.freebsd.org/D22844

Modified:
  head/share/man/man4/md.4

Modified: head/share/man/man4/md.4
==============================================================================
--- head/share/man/man4/md.4	Thu Jan  9 04:34:42 2020	(r356538)
+++ head/share/man/man4/md.4	Thu Jan  9 04:39:37 2020	(r356539)
@@ -7,7 +7,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 26, 2017
+.Dd January 8, 2020
 .Dt MD 4
 .Os
 .Sh NAME
@@ -46,7 +46,7 @@ system.
 The exact value can be determined with
 .Xr vmstat 8 .
 .It Cm preload
-A file loaded by
+A module loaded by
 .Xr loader 8
 with type
 .Sq md_image
@@ -54,6 +54,12 @@ is used for backing store.
 For backwards compatibility the type
 .Sq mfs_root
 is also recognized.
+See the description of module loading directives in
+.Xr loader.conf 5
+and note that the module name will either be an absolute path to the image file
+or the name of a file in the
+.Va module_path .
+.Pp
 If the kernel is created with option
 .Dv MD_ROOT
 the first preloaded image found will become the root file system.