svn commit: r43153 - projects/zfsupdate-201307/en_US.ISO8859-1/books/handbook/zfs

[Benedict Reuschling]

Author: bcr
Date: Sun Nov 10 19:21:36 2013
New Revision: 43153
URL: http://svnweb.freebsd.org/changeset/doc/43153

Log:
  Update the example for custom (user-defined) properties:
  - provide a pool name as the example would not work with more than one pool
  - sprinkle <replaceable>'s over the strings the user can define
  - show how to remove these properties again

Modified:
  projects/zfsupdate-201307/en_US.ISO8859-1/books/handbook/zfs/chapter.xml

Modified: projects/zfsupdate-201307/en_US.ISO8859-1/books/handbook/zfs/chapter.xml
==============================================================================
--- projects/zfsupdate-201307/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Sun Nov 10 18:37:20 2013	(r43152)
+++ projects/zfsupdate-201307/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Sun Nov 10 19:21:36 2013	(r43153)
@@ -884,10 +884,24 @@ Filesystem           Size Used Avail Cap
 	ones supplied as part of ZFS, a colon (<literal>:</literal>)
 	is used to create a custom namespace for the property.</para>
 
-      <screen>&prompt.root; <userinput>zfs set custom:costcenter=1234</userinput>
-&prompt.root; <userinput>zfs get custom:costcenter</userinput>
+      <screen>&prompt.root; <userinput>zfs set <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable>=<replaceable>1234</replaceable> <replaceable>tank</replaceable></userinput>
+&prompt.root; <userinput>zfs get <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable> <replaceable>tank</replaceable></userinput>
 NAME PROPERTY           VALUE SOURCE
 tank custom:costcenter  1234  local</screen>
+
+      <para>To remove such a custom property again, use the
+	<command>zfs inherit</command> command with the
+	<option>-r</option> option.  If the custom property is not
+	defined in any of the parent datasets, it will be removed
+	completely (although the changes are still recorded in the
+	pool's history).</para>
+
+      <screen>&prompt.root; <userinput>zfs inherit -r <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable> <replaceable>tank</replaceable></userinput>
+&prompt.root; <userinput>zfs get <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable> <replaceable>tank</replaceable></userinput>
+NAME    PROPERTY           VALUE              SOURCE
+tank    custom:costcenter  -                  -
+&prompt.root; <userinput>zfs get all <replaceable>tank</replaceable> | grep <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable></userinput>
+&prompt.root;</screen>
     </sect2>
 
     <sect2 id="zfs-zfs-snapshot">