svn commit: r54178 - head/en_US.ISO8859-1/books/handbook/zfs

[Benedict Reuschling]

Author: bcr
Date: Sat May 23 12:31:37 2020
New Revision: 54178
URL: https://svnweb.freebsd.org/changeset/doc/54178

Log:
  Add explanation to the ZFS quota examples about /home.
  
  The ZFS quota examples started with setting quotas for a user that was not
  created in the chapter. This led to some confusion for (new) people who tried
  out the example and got an error message about the missing user.
  Add a small paragraph to explain this concept and that ideally, when creating
  a user, the /home dataset should be created first to not shadow it afterwards.
  
  PR:		    177514
  Submitted by:	    Bryan Bosworth
  Reviewed by:	    noone (5 day review timeout)
  Differential Revision:	https://reviews.freebsd.org/D24913

Modified:
  head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Sat May 23 10:48:05 2020	(r54177)
+++ head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Sat May 23 12:31:37 2020	(r54178)
@@ -2716,6 +2716,16 @@ vfs.usermount: 0 -> 1
 	used to prevent users or groups from using all of the
 	space in the pool or dataset.</para>
 
+      <para>The following examples assume that the users already
+	exist in the system.  Before adding a user to the system,
+	make sure to create their home dataset first and set the
+	<option>mountpoint</option> to
+	<literal>/home/<replaceable>bob</replaceable></literal>.
+	Then, create the user and make the home directory point to
+	the dataset's <option>mountpoint</option> location.  This will
+	properly set owner and group permissions without shadowing any
+	pre-existing home directory paths that might exist.</para>
+
       <para>To enforce a dataset quota of 10 GB for
 	<filename>storage/home/bob</filename>:</para>