Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tdegeus committed Nov 21, 2023
1 parent 76d557a commit fa19cdc
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ There are methods to copy or move files to or between the "storage" locations.

The two key reasons to use this tool are:

1. To keep an overview of a the dataset's structure also if some storage locations may not be available part of the time.
1. To keep an overview of the dataset's structure also if some storage locations may not be available part of the time.

2. To keep a track of where multiple copies of files are and to get an overview of which copies might be outdated.
In addition, you can easily 'enforce' multiple copies.
Expand Down Expand Up @@ -538,16 +538,13 @@ The simplest you can do is:

.. code-block:: bash
shelephant cp here remote -ex .shelephant/storage/remote.yaml
shelephant send_storage remote
.. note::

- ``-e`` (``--exists``) is needed if ``.shelephant/storage/remote.yaml`` is not part of the dataset (recommended).
- ``-x`` (``--no-update``) if then needed to prevent ``.shelephant/storage/remote.yaml`` being added to the dataset (recommended).
This will copy ``.shelephant/storage/remote.yaml`` from ``here`` to ``remote``.

2. **On the storage location:**

a. Run
a. Run (just the first time)

.. code-block:: bash
Expand All @@ -563,9 +560,13 @@ The simplest you can do is:

.. code-block:: bash
shelephant cp remote here -ex .shelephant/storage/remote.yaml
shelephant get_storage remote
shelephant update
The first command will copy ``.shelephant/storage/remote.yaml`` from ``remote`` to ``here``.
The second command will update the symbolic links if needed.
Note that ``shelephant update`` without arguments will not perform any search for updates, it will just assume that the database is correct.

Updates with git
----------------

Expand Down Expand Up @@ -625,7 +626,7 @@ To propagate this to the central storage we do:
shelephant git commit -m "Update state of usb-drive"
shelephant git push
Now you can get the updates on your laptop (even if the two systems would not have any direct connection):
Now you can get the updates on your laptop (even if the two systems did not have any direct connection):

.. code-block:: bash
Expand Down

0 comments on commit fa19cdc

Please sign in to comment.