| 1 |
.. -*- mode: rst -*- |
| 2 |
.. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79: |
| 3 |
|
| 4 |
.. _chap_standard_parameters: |
| 5 |
|
| 6 |
******************* |
| 7 |
Standard parameters |
| 8 |
******************* |
| 9 |
|
| 10 |
.. topic:: Specification scope and status |
| 11 |
|
| 12 |
This specification partially describes the current implementation, and partially is a proposal, subject to review and further discussion. |
| 13 |
|
| 14 |
Several "standard parameters" are used in various DataLad commands. |
| 15 |
Those standard parameters have an identical meaning across the commands they are used in. |
| 16 |
Commands should ensure that they use those "standard parameters" where applicable and do not deviate from the common names nor the common meaning. |
| 17 |
|
| 18 |
Currently used standard parameters are listed below, as well as suggestions on how to harmonize currently deviating standard parameters. |
| 19 |
Deviations from the agreed upon list should be harmonized. |
| 20 |
The parameters are listed in their command-line form, but similar names and descriptions apply to their Python form. |
| 21 |
|
| 22 |
``-d``/``--dataset`` |
| 23 |
A pointer to the dataset that a given command should operate on |
| 24 |
|
| 25 |
``--dry-run`` |
| 26 |
Display details about the command execution without actually running the command. |
| 27 |
|
| 28 |
``-f``/``--force`` |
| 29 |
Enforce the execution of a command, even when certain security checks would normally prevent this |
| 30 |
|
| 31 |
``-J``/``--jobs`` |
| 32 |
Number of parallel jobs to use. |
| 33 |
|
| 34 |
``-m``/``--message`` |
| 35 |
A commit message to attach to the saved change of a command execution. |
| 36 |
|
| 37 |
``-r``/``--recursive`` |
| 38 |
Perform an operation recursively across subdatasets |
| 39 |
|
| 40 |
``-R``/``--recursion-limit`` |
| 41 |
Limit recursion to a given amount of subdataset levels |
| 42 |
|
| 43 |
``-s``/``--sibling-name`` [SUGGESTION] |
| 44 |
The identifier for a dataset sibling (remote) |
| 45 |
|
| 46 |
|
| 47 |
Certain standard parameters will have their own design document. |
| 48 |
Please refer to those documents for more in-depth information. |