Commit Graph

25 Commits

Author SHA1 Message Date
Kyle Evans
20e8d8d554 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
2020-01-09 04:39:37 +00:00
Ian Lepore
fe9c9058e8 Correct a mistake and reword a couple sentences to clarify that "the value"
refers to the scale value, not the kmem_arena size that results from scaling.

Suggested by: alc@
2017-12-29 20:00:19 +00:00
Ian Lepore
45ab79431b Add a section describing how to tune ARM kernel options to use an MD_ROOT
filesystem larger than about 50-55 MiB.

The description of VM_KMEM_SIZE_SCALE is roughly as hand-wavy as my
understanding of the option, but at least mentioning that it's a factor
and giving an empirical datapoint that works will give folks some idea
of what to tweak if they have problems.
2017-12-26 22:05:55 +00:00
Ian Lepore
5cf10fb96a Add a new kernel config option, MD_ROOT_READONLY, which forces on the
MD_READONLY flag for the md device automatically instantiated during
kernel init for an mdroot filesystem.

Note that there is specifically and by design no tunable or sysctl
control over this feature.  Without this option, you already have control
over whether the mdroot fs is writeable using vfs.root.mountfrom.options
from loader(8), the root_rw_mount rcvar, and by using "mount -u[rw] /"
or equivelent on the fly.  This option is being added to provide a way
to make the mdroot fs truly immutable before userland code begins running.

Differential Revision:	https://reviews.freebsd.org/D13411
2017-12-20 18:23:22 +00:00
Benedict Reuschling
70cccb5ce0 Extend the synopsis section of md(4) to look more like other manpages
of this kind.  Describe how to compile the driver into the kernel
and how to load it as a module.
This is useful for people using the MINIMAL kernel configuration file.

PR:			218610
Submitted by:		Harald Schmalzbauer (bugzilla.freebsd@omnilan.de)
Reviewed by:		noone (1 month inactivity)
MFC after:		2 weeks
Differential Revision:	https://reviews.freebsd.org/D12271
2017-11-05 18:45:43 +00:00
Edward Tomasz Napierala
b8c19fd719 It's 2015, and some people are still trying to use fdisk and then
go asking what debug flags to set for GEOM to make it work.  Advice
them to use gpart(8) instead.

Something similar should probably done with disklabel,
but I need to rewrite the disklabel examples first.

Reviewed by:	wblock@
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D3315
2015-09-02 14:08:43 +00:00
Baptiste Daroussin
6c89995002 use .Mt to mark up email addresses consistently (final part)
PR:		191174
Submitted by:	Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:46:14 +00:00
Eitan Adler
50d675f7a9 Remove trailing whitespace per mdoc lint warning
Disussed with:	gavin
No objection from:	doc
Approved by:	joel
MFC after:	3 days
2012-03-29 05:02:12 +00:00
Sergey Kandaurov
603c2b9b9b Remove vestiges of disklabel(5).
Reviewed by:	uqs
MFC after:	5 days
2011-04-14 08:53:04 +00:00
Ulrich Spörlein
62486687ed mdoc: consistently spell our email addresses <foo@FreeBSD.org>
Reviewed by:	ru
2010-05-19 08:57:53 +00:00
Edward Tomasz Napierala
964bb4d3d4 Fix the example. 2009-05-17 12:21:11 +00:00
Giorgos Keramidas
cf14303baa mdoc warning fixes: Use the correct syntax for .Bl -offset indent
MFC after:	3 days
2007-10-30 16:02:49 +00:00
Pav Lucistnik
2d794a54fe Talk more about swap backing
PR:		docs/78041 (inspired by)
Submitted by:	Lars Kristiansen <lars+lister.freebsd@adventuras.no>
MFC after:	1 week
2007-05-12 15:33:18 +00:00
Warner Losh
c572890195 Add instructions for creating a ramdisk root image. These likely need
to be augmented with instructions for those platforms that have
/boot/loader.
2006-11-24 18:53:45 +00:00
Doug Barton
1b6c6f4aae Add .Xr's to mdmfs(8).
Submitted by:	Scot W. Hetzel <hetzels@westbend.net>
2003-04-27 01:46:56 +00:00
Ruslan Ermilov
8d5d039f80 Uniformly refer to a file system as "file system".
Approved by:	re
2002-12-12 17:26:04 +00:00
Jens Schweikhardt
c1f3e4bf21 Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by:	Silence from cvs diff -b
MFC after:	7 days
2001-07-14 19:41:16 +00:00
Dima Dorfman
1f5398eeff Add missing article. 2001-06-17 02:24:04 +00:00
Ruslan Ermilov
e863f7544d mdoc(7) police:
o  Update document date.
o  Remove hard sentence break.
o  Sort xrefs.
2001-03-12 09:14:22 +00:00
Poul-Henning Kamp
a30d010c86 Make md(4) more in line with reality.
NB: probably contains mdoc mistakes, feel free to fix.
2001-03-09 20:07:37 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
Sheldon Hearn
1f3ea974f3 Add an EXAMPLES section with an example of how to mount a
malloc(9)-backed md(4) device on /tmp .
2000-07-24 14:23:47 +00:00
Sheldon Hearn
f274479332 Rename MDNSECT to MD_NSECT and declare it as something that isn't
default in NOTES.

Requested by:	bde
Approved by:	phk
2000-07-17 13:13:04 +00:00
Sheldon Hearn
b36ee384e6 Actually allow ``options MDNSECT=<numsects>'' in kernel configs to
specify the default maximum size of malloc(9)-backed md(4) devices
and complete the documentation of this option.
2000-07-14 12:14:13 +00:00
Sheldon Hearn
8057969f7e Add phk's md(4) manual page, written by phk himself. 2000-07-07 11:52:03 +00:00