# HG changeset patch # User Franz Glasner # Date 1727024846 -7200 # Node ID b74c65ceab96801fa355c8cfb6a033280ad80c30 # Parent 54c6eecbe53f018aa819298885a4cd336955cf90 Docs: Enhanced manuals diff -r 54c6eecbe53f -r b74c65ceab96 docs/man/man8/fzfs-clone-tree.rst --- a/docs/man/man8/fzfs-clone-tree.rst Sun Sep 22 16:04:18 2024 +0200 +++ b/docs/man/man8/fzfs-clone-tree.rst Sun Sep 22 19:07:26 2024 +0200 @@ -24,8 +24,8 @@ `dest-dataset` must not exist already. -All properties that are of type ``local`` or ``received``are copied to the -destination. This is also true for ``canmount`` and ``mountpoint``. +All properties that are of type ``local`` or ``received`` are copied to the +destination. This is also true for `canmount` and `mountpoint`. The cloned datasets will are *not* mounted automatically. diff -r 54c6eecbe53f -r b74c65ceab96 docs/man/man8/fzfs-copy-tree.rst --- a/docs/man/man8/fzfs-copy-tree.rst Sun Sep 22 16:04:18 2024 +0200 +++ b/docs/man/man8/fzfs-copy-tree.rst Sun Sep 22 19:07:26 2024 +0200 @@ -18,7 +18,8 @@ Copy the ZFS filesystem or snapshot that is rooted at `source-dataset` and all descendent datasets to the destination rooted at `dest-dataset`. -The structure and content of the filesystems is copied. +The structure, content and properties of the filesystems are copied. +The properties `canmount` and `mountpoint` are handled specially. If `source-dataset` is a snapshot then all of its child datasets also must have a snapshot with the same snapshot name. @@ -28,6 +29,11 @@ By default `canmount` is also copied. But this can be modified with option :option:`-A`. +The `mountpoint` property is not copied. Normally it will be inherited +as the ZFS rules for `dest-dataset` regarding its parent are applied. +This can be changed with :option:`-M mountpoint`. Child datasets always +will inherit their mountpoint from `dest-dataset`. + Options ------- @@ -35,13 +41,17 @@ .. option:: -A Unconditionally set the ZFS property `canmount=noauto` for all - created datasets in the destination tree, unless the source dataset - has `canmount=off`. + created datasets in the destination tree, `unless` the source dataset + has `canmount=off`. If not given then `canmount` is copied from the + source to the destination. .. option:: -M - Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`. - All children will be set to inherit it. + Set the `mountpoint` property for the destination root `dest-dataset` + to `mountpoint`. All children will be set to inherit it. + + If not given then the mountpoint will we inherited by normal ZFS + inheritance from the destination's parent. .. option:: -k @@ -56,7 +66,14 @@ .. option:: -u - Do not mount the copied datasets. + Do not mount the copied datasets automatically when they are created. + + +Implementation Notes +-------------------- + +The current implementation uses :manpage:`zfs-send(8)` +and :manpage:`zfs-receive(8)` to implement the actual copying. Environment diff -r 54c6eecbe53f -r b74c65ceab96 docs/man/man8/fzfs-create-tree.rst --- a/docs/man/man8/fzfs-create-tree.rst Sun Sep 22 16:04:18 2024 +0200 +++ b/docs/man/man8/fzfs-create-tree.rst Sun Sep 22 19:07:26 2024 +0200 @@ -22,14 +22,20 @@ `dest-dataset` must not exist already. -By default some important dataset properties that are set locally in -the source tree are copied to the destination. This includes `atime`, +By default some important dataset properties are copied from +the source tree to the destination. This includes `atime`, `exec`, `setuid`, `compression`, `primarycache`, `sync` and -`readonly`. +`readonly`. But they are copied *only* if are of type ``local`` in +the source. By default `canmount` is also copied. But this can be modified with options :option:`-A` and :option:`-p`. +The `mountpoint` property is not copied. Normally it will be inherited +as the ZFS rules for `dest-dataset` regarding its parent are applied. +This can be changed with :option:`-M mountpoint`. Child datasets always +will inherit their mountpoint from `dest-dataset`. + Options ------- @@ -37,13 +43,16 @@ .. option:: -A Unconditionally set the ZFS property `canmount=noauto` for all - created datasets in the destination tree. This option overwrites + created datasets in the destination tree. This option also overwrites option :option:`-p`. .. option:: -M - Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`. - All children will be set to inherit it. + Set the `mountpoint` property for the destination root `dest-dataset` + to `mountpoint`. All children will be set to inherit it. + + If not given then the mountpoint will we inherited by normal ZFS + inheritance from the destination's parent. .. option:: -n @@ -51,13 +60,12 @@ .. option:: -p - Copy the `canmount` property only from the source to the root - destination dataset This will be overwritten by the option - :option:`-A`. + Copy the `canmount` property only from the source root to the destinaion + root dataset This will be overwritten by the option :option:`-A`. .. option:: -u - Do not mount the newly created datasets. + Do not mount the newly created datasets when they are created. Environment