21290367 pkg(1) man page about pkg dehydrate needs clarification
authorYiteng Zhang <yiteng.zhang@oracle.com>
Tue, 30 Jun 2015 11:44:33 -0700
changeset 3231 68bc503929c6
parent 3229 3efc0511f0ba
child 3234 3a90dc0b66c9
21290367 pkg(1) man page about pkg dehydrate needs clarification
src/man/pkg.1
--- a/src/man/pkg.1	Wed Jun 24 17:56:21 2015 -0700
+++ b/src/man/pkg.1	Tue Jun 30 11:44:33 2015 -0700
@@ -1708,7 +1708,7 @@
 </varlistentry>
 
 <varlistentry><term><command>pkg <option>R</option> <replaceable>dir</replaceable> dehydrate</command> [<option>nvq</option>] [<option>p</option> <replaceable>publisher</replaceable>]...</term>
-<listitem><para>Remove all non-editable packaged files and packaged hardlinks from the image specified by the <option>R</option> option to create a fully dehydrated image. A non-editable packaged file is a file delivered by the currently installed version of a package that has no <literal>preserve</literal> or <literal>overlay</literal> attribute, or has a <literal>dehydrated</literal> value of <literal>False</literal>. A packaged hardlink is a hardlink delivered by the currently installed version of a package. </para>
+<listitem><para>Remove all non-editable packaged files and packaged hardlinks from the image specified by the <option>R</option> option to create a fully dehydrated image. Packaged files and packaged hardlinks are files and hardlinks that are delivered by the currently installed version of a package. A non-editable file cannot have any <literal>preserve</literal> or <literal>overlay</literal> attribute and cannot have a <literal>dehydrate</literal> attribute with a value of <literal>false</literal>.</para>
 <para>The <command>pkg dehydrate</command> command only operates on an alternate root. Use the <option>R</option> option to specify the alternate root. If the alternate root belongs to a boot environment, dehydration will render it unbootable.</para>
 <para>If the <command>pkg dehydrate</command> command succeeds, a property named <command>dehydrated</command> is set on the <replaceable>dir</replaceable> image specified by the <option>R</option> option. The value of the <command>dehydrated</command> property is a list of all publishers set in the <replaceable>dir</replaceable> image that have a configured package repository.</para>
 <para>Package installation operations on packages from a dehydrated publisher are automatically dehydrated. If you install a package in a dehydrated image, the package content is installed and then dehydrated. Package installation operations can include operations such as <command>update</command> and <command>change-facet</command> as well as <command>install</command>.</para>