freebsd-nq/sys/ufs/ffs/README.softupdates

$FreeBSD$

For legal reasons the two active files for using Soft Updates are in
/usr/src/sys/contrib/softupdates. To enable the feature in your kernel,
link the files into this directory as follows:

	cd /usr/src/sys/ufs/ffs
	ln -s ../../contrib/softupdates/*.[ch] .

and add option SOFTUPDATES to your kernel configuration.  You should also
read the copyrights in the sources and the README file in
/usr/src/sys/contrib/softupdates before enabling this feature to ensure
that you are acting legally. The stub file provided here is only enough
to allow the system to function without this option being turned on.

WARNING: RE-DISTRIBUTING A KERNEL WITH SOFTUPDATES COMPILED IN WITHOUT
DISTRIBUTING THE SOURCE TO THE _ENTIRE_ KERNEL IS NOT PERMITTED.  See the
copyright on the soft update files, or ../../contrib/softupdates/README

Once you're running a kernel with soft update support, you need to enable
it for whichever filesystems you wish to run with the soft update policy.
This is done with the -n option to tunefs(8) on the UNMOUNTED filesystems,
e.g. from single-user mode you'd do something like:

	tunefs -n enable /usr

To permanently enable soft updates on the /usr filesystem (or at least
until a corresponding ``tunefs -n disable'' is done).

For more general information on soft updates, please see:
	http://www.ece.cmu.edu/~ganger/papers/CSE-TR-254-95/

--
Julian Elischer <julian@freebsd.org>
Remove the 'alpha, use at your own risk' death-statement. Reviewed by: mckusick (verbally at FreeBSDcon) 1999-12-03 00:40:31 +00:00			$FreeBSD$
Ensure that there is enough information here, so that people can use soft updates should they desire. 1998-05-19 23:18:37 +00:00
			`For legal reasons the two active files for using Soft Updates are in`
Update pathnames for new location of soft-updates sources. 1999-07-03 21:34:05 +00:00			`/usr/src/sys/contrib/softupdates. To enable the feature in your kernel,`
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00			`link the files into this directory as follows:`
Ensure that there is enough information here, so that people can use soft updates should they desire. 1998-05-19 23:18:37 +00:00
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00			`cd /usr/src/sys/ufs/ffs`
Update pathnames for new location of soft-updates sources. 1999-07-03 21:34:05 +00:00			`ln -s ../../contrib/softupdates/*.[ch] .`
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00
			`and add option SOFTUPDATES to your kernel configuration. You should also`
			`read the copyrights in the sources and the README file in`
Update pathnames for new location of soft-updates sources. 1999-07-03 21:34:05 +00:00			`/usr/src/sys/contrib/softupdates before enabling this feature to ensure`
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00			`that you are acting legally. The stub file provided here is only enough`
			`to allow the system to function without this option being turned on.`

Add a warning about the copyright restraints. 1999-01-08 16:03:12 +00:00			`WARNING: RE-DISTRIBUTING A KERNEL WITH SOFTUPDATES COMPILED IN WITHOUT`
			`DISTRIBUTING THE SOURCE TO THE _ENTIRE_ KERNEL IS NOT PERMITTED. See the`
Update pathnames for new location of soft-updates sources. 1999-07-03 21:34:05 +00:00			`copyright on the soft update files, or ../../contrib/softupdates/README`
Add a warning about the copyright restraints. 1999-01-08 16:03:12 +00:00
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00			`Once you're running a kernel with soft update support, you need to enable`
			`it for whichever filesystems you wish to run with the soft update policy.`
			`This is done with the -n option to tunefs(8) on the UNMOUNTED filesystems,`
			`e.g. from single-user mode you'd do something like:`
Ensure that there is enough information here, so that people can use soft updates should they desire. 1998-05-19 23:18:37 +00:00
Simplify the tunefs example, since tunefs uses getfsfile(). Lots of people complain about working out what device their filesystems are mounted on. 1999-04-27 21:11:19 +00:00			`tunefs -n enable /usr`
Ensure that there is enough information here, so that people can use soft updates should they desire. 1998-05-19 23:18:37 +00:00
Simplify the tunefs example, since tunefs uses getfsfile(). Lots of people complain about working out what device their filesystems are mounted on. 1999-04-27 21:11:19 +00:00			`To permanently enable soft updates on the /usr filesystem (or at least`
			until a corresponding ``tunefs -n disable'' is done).
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00
			`For more general information on soft updates, please see:`
			`http://www.ece.cmu.edu/~ganger/papers/CSE-TR-254-95/`
Ensure that there is enough information here, so that people can use soft updates should they desire. 1998-05-19 23:18:37 +00:00
Flesh this document out just a little in response to some user questions and also recommend linking over copying since, at this stage, a stale copy is a real concern. 1998-06-26 10:35:55 +00:00			`--`
			`Julian Elischer <julian@freebsd.org>`