Debian Codegraph @

docs/source/glossary.rst

raw
1 .. -*- mode: rst; fill-column: 78; indent-tabs-mode: nil -*-
2 .. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79:
3 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
4 #
5 # See COPYING file distributed along with the datalad package for the
6 # copyright and license terms.
7 #
8 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
9
10 .. _chap_glossary:
11
12 ********
13 Glossary
14 ********
15
16 DataLad purposefully uses a terminology that is different from the one used by
17 its technological foundations Git_ and git-annex_. This glossary provides
18 definitions for terms used in the datalad documentation and API, and relates
19 them to the corresponding Git_/git-annex_ concepts.
20
21 .. glossary::
22 :sorted:
23
24 dataset
25 A regular Git_ repository with an (optional) :term:`annex`.
26
27 subdataset
28 A :term:`dataset` that is part of another dataset, by means of being
29 tracked as a Git_ submodule. As such, a subdataset is also a complete
30 dataset and not different from a standalone dataset.
31
32 superdataset
33 A :term:`dataset` that contains at least one :term:`subdataset`.
34
35 sibling
36 A :term:`dataset` (location) that is related to a particular dataset,
37 by sharing content and history. In Git_ terminology, this is a *clone*
38 of a dataset that is configured as a *remote*.
39
40 annex
41 Extension to a Git_ repository, provided and managed by git-annex_ as
42 means to track and distribute large (and small) files without having to
43 inject them directly into a Git_ repository (which would slow Git
44 operations significantly and impair handling of such repositories in
45 general).
46
47 CLI
48 A `Command Line Interface`_. Could be used interactively by executing
49 commands in a `shell`_, or as a programmable API for shell scripts.
50
51 DataLad extension
52 A Python package, developed outside of the core DataLad codebase, which
53 (when installed) typically either provides additional top level `datalad`
54 commands and/or additional metadata extractors. Visit
55 `Handbook, Ch.2. DataLad’s extensions <https://handbook.datalad.org/en/latest/beyond_basics/basics-extensions.html>`_
56 for general information about extensions, a non-exhaustive list of extensions and instructions on how to install them, and walk-throughs of selected extensions.
57
58 .. _Git: https://git-scm.com
59 .. _Git-annex: http://git-annex.branchable.com
60 .. _`Command Line Interface`: https://en.wikipedia.org/wiki/Command-line_interface
61 .. _shell: https://en.wikipedia.org/wiki/Shell_(computing)