Skip to content

Commit 6673c2e

Browse files
committed
MNT: add updates with regard to create-sibling-ria's storage sibling options
Thanks to Kyle, this change introduces the successor of --no-storage-sibling and informs about its deprecation. At the moment, both flags remain mentioned, but have a version identifier attached. In the same vein, because it fits, I added a quick note about the storage-sibling=only option recently introduced.
1 parent fdcffba commit 6673c2e

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/beyond_basics/101-147-riastores.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,12 @@ pushed into RIA stores if they have a git-annex ora-remote.
202202

203203
Certain applications will not require special remote features. The usecase
204204
:ref:`usecase_HCP_dataset`
205-
shows an example where git-annex key storage is explicitly not wanted. For most
206-
storage or back-up scenarios, special remote capabilities are useful, though,
207-
and thus the default [#f5]_.
208-
The :command:`datalad create-sibling-ria` command will automatically create a
205+
shows an example where git-annex key storage is explicitly not wanted.
206+
Other applications may require *only* the special remote, such as cases where Git isn't installed on the RIA store hosting infrastructure.
207+
For most storage or back-up scenarios, special remote capabilities are useful, though,
208+
and thus the default.
209+
210+
By default, the :command:`datalad create-sibling-ria` command will automatically create a
209211
dataset representation in a RIA store (and set up the RIA store, if it does not
210212
exist), and configure a sibling to allow publishing to the RIA store and updating
211213
from it.
@@ -216,6 +218,10 @@ With the sibling and special remote set up, upon an invocation of
216218
annexed contents, will be published to the RIA store, with no further setup or
217219
configuration required [#f6]_.
218220

221+
To disable the storage sibling completely, invoke :command:`datalad create-sibling-ria` with the argument ``--storage-sibling=off``.
222+
Note that DataLad versions ``<0.14`` need to use the flag ``--no-storage-sibling``, which is deprecated starting with DataLad ``0.14.0``.
223+
To create a RIA store with *only* special remote storage, starting from DataLad version ``0.14.0`` you can invoke :command:`datalad create-sibling-ria` with the argument ``--storage-sibling=only``.
224+
219225
Advantages of RIA stores
220226
""""""""""""""""""""""""
221227
Storing datasets in RIA stores has a number of advantages that align well with
@@ -348,9 +354,9 @@ Afterwards, the dataset has two additional siblings: ``ria-backup``, and
348354

349355
$ datalad siblings
350356

351-
The storage sibling is the git-annex ora-remote and is set up automatically
352-
unless :command:`create-sibling-ria` is run with the ``--storage-sibling=off``
353-
flag. By default, it has the name of the RIA sibling, suffixed with ``-storage``,
357+
The storage sibling is the git-annex ora-remote and is set up automatically --
358+
unless :command:`create-sibling-ria` is run with ``--storage-sibling=off`` (in DataLad versions ``>0.14.``) or ``--no-storage-sibling`` (in versions ``<0.14``).
359+
By default, it has the name of the RIA sibling, suffixed with ``-storage``,
354360
but alternative names can be supplied with the ``--storage-name`` option.
355361

356362

@@ -699,10 +705,6 @@ procedures.
699705
700706
shows how this feature can come in handy.
701707
702-
.. [#f5] Special remote capabilities of a RIA store can be disabled at the time of RIA
703-
store creation by passing the option ``--storage-sibling=off`` to the
704-
:command:`datalad create-sibling-ria` command.
705-
706708
.. [#f6] To re-read about publication dependencies and why this is relevant to
707709
annexed contents in the dataset, checkout section :ref:`sharethirdparty`.
708710

0 commit comments

Comments
 (0)