Skip to content

Commit

Permalink
Rough-format collaboration
Browse files Browse the repository at this point in the history
  • Loading branch information
mih committed Nov 14, 2023
1 parent b25047d commit 1fa3e4a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/basics/101-117-sharelocal2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ Before getting another PDF, let's query git-annex where its content is stored:
Oh, another cryptic character sequence - this time however not a symlink, but an :term:`annex UUID`.
"That's hard to read -- what is it?" your room mate asks.
You can recognize a path to the dataset on your computer, prefixed with the user and hostname of your computer.
"This", you exclaim, excited about your own realization, "is my dataset's location I'm sharing it from!"
"This", you exclaim, excited about your own realization, "is my dataset's location I'm sharing it from!" You can check the :find-out-more:`on customizing this description <fom-clone-description>` and learn how to tweak this accoridng to your taste.

.. index::
pair: set description for dataset location; with DataLad
.. find-out-more:: What is this location, and what if I provided a description?
:name: fom-clone-description
:float: tb

Back in the very first section of the Basics, :ref:`createDS`, a :ref:`Find-out-more mentioned the '--description' option <createdescription>` of :dlcmd:`create`.
With this option, you can provide a description about the dataset *location*.
Expand Down
16 changes: 13 additions & 3 deletions docs/basics/101-121-siblings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,14 @@ is now known to your own dataset as "roommate".

This command will list all known siblings of the dataset. You can see it
in the resulting list with the name "roommate" you have given to it.
And just as a brief remark: siblings do not have to stay around forever.
Check the :find-out-more:`on removing a sibling <fom-remove-sibling>`.

.. index::
pair: remove dataset sibling; with DataLad
.. find-out-more:: What if I mistyped the name or want to remove the sibling?
:name: fom-remove-sibling
:float: tbp

You can remove a sibling using :dlcmd:`siblings remove -s roommate`

Expand Down Expand Up @@ -235,13 +239,16 @@ The drawer is a branch, and it is usually called ``remotes/origin/main``.
To look inside of it you can :gitcmd:`checkout BRANCHNAME`, or you can
do a ``diff`` between the branch (your drawer) and the dataset as it
is currently in front of you (your desk). We will do the latter, and leave
the former for a different lecture:
the former for a different lecture. Make sure to see the
:windows-wit:`on using 'datalad diff' <ww-datalad-diff-calls>` too.

.. index::
pair: corresponding branch; in adjusted mode
pair: show dataset modification for particular path; on Windows with DataLad
pair: diff; DataLad command
.. windows-wit:: Please use 'datalad diff --from main --to remotes/roommate/main'
.. windows-wit:: 'datalad diff' needs the corresponding branch
:name: ww-datalad-diff-calls
:float: tb

.. include:: topic/adjustedmode-diff-remote.rst

Expand All @@ -256,12 +263,15 @@ the former for a different lecture:
This shows us that there is an additional file, and it also shows us
that there is a difference in ``notes.txt``! Let's ask
:gitcmd:`diff` to show us what the differences in detail (note that it is a shortened excerpt, cut in the middle to reduce its length):
Again, check the :windows-wit:`on using 'git diff' <ww-git-diff-calls>` too.

.. index::
pair: corresponding branch; in adjusted mode
pair: show dataset modification; on Windows with Git
pair: diff; DataLad command
.. windows-wit:: Please use 'git diff main..remotes/roommate/main'
.. windows-wit:: 'git diff' needs the corresponding branch
:name: ww-git-diff-calls
:float: tb

.. include:: topic/adjustedmode-gitdiff-remote.rst

Expand Down

0 comments on commit 1fa3e4a

Please sign in to comment.