Skip to content

Commit b5d8538

Browse files
authored
docs: rename properties to send_properties & add note on nfs/smb props (#859)
1 parent 3755c97 commit b5d8538

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

‎docs/configuration/sendrecvoptions.rst‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Send Options
1212
:ref:`Source<job-source>` and :ref:`push<job-push>` jobs have an optional ``send`` configuration section.
1313

1414
::
15-
15+
1616
jobs:
1717
- type: push
1818
filesystems: ...
@@ -84,8 +84,8 @@ If ``encrypted=false``, zrepl expects that filesystems matching ``filesystems``
8484

8585
.. _job-send-options-properties:
8686

87-
``properties``
88-
--------------
87+
``send_properties``
88+
-------------------
8989
Sends the dataset properties along with snapshots.
9090
Please be careful with this option and read the :ref:`note on property replication below <job-note-property-replication>`.
9191

@@ -171,7 +171,7 @@ You can send the original properties from the first receiver to another receiver
171171
A Note on Property Replication
172172
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173173

174-
If a send stream contains properties, as per ``send.properties`` or ``send.backup_properties``,
174+
If a send stream contains properties, as per ``send.send_properties`` or ``send.backup_properties``,
175175
the default ZFS behavior is to use those properties on the receiving side, verbatim.
176176

177177
In many use cases for zrepl, this can have devastating consequences.
@@ -221,6 +221,14 @@ and property replication is enabled, the receiver must :ref:`inherit the followi
221221
* ``keyformat``
222222
* ``encryption``
223223

224+
Sharing
225+
-------
226+
227+
You may not want the replicated filesystem shared in the same way as the source is.
228+
229+
* ``sharenfs``
230+
* ``sharesmb``
231+
224232
.. _job-recv-options--placeholder:
225233

226234
Placeholders

0 commit comments

Comments
 (0)