ivis-mizuguchi
/
gitannex


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>datalad diff &mdash; DataLad 0.17.2+0.g22b26884e.dirty documentation</title>
      <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="canonical" href="http://docs.datalad.org/en/stable/generated/man/datalad-diff.html" />
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../../_static/doctools.js"></script>
        <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script>
    <script src="../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="datalad clone" href="datalad-clone.html" />
    <link rel="prev" title="datalad status" href="datalad-status.html" /> 

<!-- RTD Extra Head -->

<link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css" />

<script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.org", "build_date": "2022-07-16T13:12:19Z", "builder": "sphinx", "canonical_url": null, "commit": "22b26884", "docroot": "/docs/source/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-1", "language": "en", "page": "generated/man/datalad-diff", "programming_language": "py", "project": "datalad", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {"datalad-catalog": "http://docs.datalad.org/projects/catalog/en/latest/", "datalad-container": "http://docs.datalad.org/projects/container/en/latest/", "datalad-crawler": "http://docs.datalad.org/projects/crawler/en/latest/", "datalad-dataverse": "http://docs.datalad.org/projects/datalad-dataverse/en/latest/", "datalad-deprecated": "http://docs.datalad.org/projects/deprecated/en/latest/", "datalad-hirni": "http://docs.datalad.org/projects/hirni/en/latest/", "datalad-metalad": "http://docs.datalad.org/projects/metalad/en/latest/", "datalad-mihextras": "http://docs.datalad.org/projects/mihextras/en/latest/", "datalad-neuroimaging": "http://docs.datalad.org/projects/neuroimaging/en/latest/", "datalad-next": "http://docs.datalad.org/projects/next/en/latest/", "datalad-osf": "http://docs.datalad.org/projects/osf/en/latest/", "datalad-ukbiobank": "http://docs.datalad.org/projects/ukbiobank/en/latest/", "datalad-xnat": "http://docs.datalad.org/projects/datalad-xnat/en/latest/"}, "theme": "sphinx_rtd_theme", "user_analytics_code": "", "version": "stable"}</script>

<!--
Using this variable directly instead of using `JSON.parse` is deprecated.
The READTHEDOCS_DATA global variable will be removed in the future.
-->
<script type="text/javascript">
READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML);
</script>

<script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script>

<!-- end RTD <extrahead> -->
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="../../index.html" class="icon icon-home"> DataLad
            <img src="../../_static/datalad_logo.png" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                stable
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Change log</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../acknowledgements.html">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../publications.html">Publications</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../background.html">Background and motivation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../related.html">Delineation from related solutions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../basics.html">Basic principles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Credentials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../metadata.html">Metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../customization.html">Customization and extension of functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../design/index.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../cmdline.html">Command line reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../cmdline.html#main-command">Main command</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../cmdline.html#core-commands">Core commands</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../cmdline.html#local-operation">Local operation</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="datalad-create.html">datalad create: Create a new dataset</a></li>
<li class="toctree-l4"><a class="reference internal" href="datalad-save.html">datalad save: Save the state of a dataset</a></li>
<li class="toctree-l4"><a class="reference internal" href="datalad-run.html">datalad run: Run a shell command and record its impact on a dataset</a></li>
<li class="toctree-l4"><a class="reference internal" href="datalad-status.html">datalad status: Report on the state of dataset content</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">datalad diff: Report differences between two states of a dataset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../cmdline.html#distributed-operation">Distributed operation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../cmdline.html#extended-set-of-functionality">Extended set of functionality</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../modref.html">Python module reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../config.html">Configuration</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../index.html">DataLad</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="../../cmdline.html">Command line reference</a> &raquo;</li>
      <li>datalad diff</li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/datalad/datalad/blob/22b26884e04e6940cfa389afd91fd673f510c438/docs/source/generated/man/datalad-diff.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="datalad-diff">
<span id="man-datalad-diff"></span><h1>datalad diff<a class="headerlink" href="#datalad-diff" title="Permalink to this heading"></a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">datalad</span> <span class="n">diff</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">f</span> <span class="n">REVISION</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">REVISION</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span> <span class="n">DATASET</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">annex</span> <span class="p">[</span><span class="n">MODE</span><span class="p">]]</span>
    <span class="p">[</span><span class="o">--</span><span class="n">untracked</span> <span class="n">MODE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">R</span> <span class="n">LEVELS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">version</span><span class="p">]</span> <span class="p">[</span><span class="n">PATH</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Report differences between two states of a dataset (hierarchy)</p>
<p>The two to-be-compared states are given via the –from and –to options.
These state identifiers are evaluated in the context of the (specified
or detected) dataset. In the case of a recursive report on a dataset
hierarchy, corresponding state pairs for any subdataset are determined
from the subdataset record in the respective superdataset. Only changes
recorded in a subdataset between these two states are reported, and so on.</p>
<p>Any paths given as additional arguments will be used to constrain the
difference report. As with Git’s diff, it will not result in an error when
a path is specified that does not exist on the filesystem.</p>
<p>Reports are very similar to those of the STATUS command, with the
distinguished content types and states being identical.</p>
<p><em>Examples</em></p>
<p>Show unsaved changes in a dataset:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span> <span class="n">datalad</span> <span class="n">diff</span>
</pre></div>
</div>
<p>Compare a previous dataset state identified by shasum against current
worktree:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span> <span class="n">datalad</span> <span class="n">diff</span> <span class="o">--</span><span class="kn">from</span> <span class="o">&lt;</span><span class="n">SHASUM</span><span class="o">&gt;</span>
</pre></div>
</div>
<p>Compare two branches against each other:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span> <span class="n">datalad</span> <span class="n">diff</span> <span class="o">--</span><span class="kn">from</span> <span class="nn">branch1</span> <span class="o">--</span><span class="n">to</span> <span class="n">branch2</span>
</pre></div>
</div>
<p>Show unsaved changes in the dataset and potential subdatasets:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span> <span class="n">datalad</span> <span class="n">diff</span> <span class="o">-</span><span class="n">r</span>
</pre></div>
</div>
<p>Show unsaved changes made to a particular file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span> <span class="n">datalad</span> <span class="n">diff</span> <span class="o">&lt;</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">file</span><span class="o">&gt;</span>
</pre></div>
</div>
</section>
<section id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<section id="path">
<h3>PATH<a class="headerlink" href="#path" title="Permalink to this heading"></a></h3>
<p>path to contrain the report to. Constraints: value must be a string or value must be NONE</p>
</section>
<section id="h-help-help-np">
<h3><strong>-h</strong>, <strong>-\-help</strong>, <strong>-\-help-np</strong><a class="headerlink" href="#h-help-help-np" title="Permalink to this heading"></a></h3>
<p>show this help message. –help-np forcefully disables the use of a pager for displaying the help message</p>
</section>
<section id="f-revision-from-revision">
<h3><strong>-f</strong> REVISION, <strong>-\-from</strong> REVISION<a class="headerlink" href="#f-revision-from-revision" title="Permalink to this heading"></a></h3>
<p>original state to compare to, as given by any identifier that Git understands. Constraints: value must be a string [Default: ‘HEAD’]</p>
</section>
<section id="t-revision-to-revision">
<h3><strong>-t</strong> REVISION, <strong>-\-to</strong> REVISION<a class="headerlink" href="#t-revision-to-revision" title="Permalink to this heading"></a></h3>
<p>state to compare against the original state, as given by any identifier that Git understands. If none is specified, the state of the working tree will be compared. Constraints: value must be a string or value must be NONE</p>
</section>
<section id="d-dataset-dataset-dataset">
<h3><strong>-d</strong> <em>DATASET</em>, <strong>-\-dataset</strong> <em>DATASET</em><a class="headerlink" href="#d-dataset-dataset-dataset" title="Permalink to this heading"></a></h3>
<p>specify the dataset to query. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) or value must be NONE</p>
</section>
<section id="annex-mode">
<h3><strong>-\-annex</strong> [MODE]<a class="headerlink" href="#annex-mode" title="Permalink to this heading"></a></h3>
<p>Switch whether to include information on the annex content of individual files in the status report, such as recorded file size. By default no annex information is reported (faster). Three report modes are available: basic information like file size and key name (‘basic’); additionally test whether file content is present in the local annex (‘availability’; requires one or two additional file system stat calls, but does not call git-annex), this will add the result properties ‘has_content’ (boolean flag) and ‘objloc’ (absolute path to an existing annex object file); or ‘all’ which will report all available information (presently identical to ‘availability’). The ‘basic’ mode will be assumed when this option is given, but no mode is specified. Constraints: value must be one of (‘basic’, ‘availability’, ‘all’)</p>
</section>
<section id="untracked-mode">
<h3><strong>-\-untracked</strong> MODE<a class="headerlink" href="#untracked-mode" title="Permalink to this heading"></a></h3>
<p>If and how untracked content is reported when comparing a revision to the state of the working tree. ‘no’: no untracked content is reported; ‘normal’: untracked files and entire untracked directories are reported as such; ‘all’: report individual files even in fully untracked directories. Constraints: value must be one of (‘no’, ‘normal’, ‘all’) [Default: ‘normal’]</p>
</section>
<section id="r-recursive">
<h3><strong>-r</strong>, <strong>-\-recursive</strong><a class="headerlink" href="#r-recursive" title="Permalink to this heading"></a></h3>
<p>if set, recurse into potential subdatasets.</p>
</section>
<section id="r-levels-recursion-limit-levels">
<h3><strong>-R</strong> LEVELS, <strong>-\-recursion-limit</strong> LEVELS<a class="headerlink" href="#r-levels-recursion-limit-levels" title="Permalink to this heading"></a></h3>
<p>limit recursion into subdatasets to the given number of levels. Constraints: value must be convertible to type ‘int’ or value must be NONE</p>
</section>
<section id="version">
<h3><strong>-\-version</strong><a class="headerlink" href="#version" title="Permalink to this heading"></a></h3>
<p>show the module and its version which provides the command</p>
</section>
</section>
<section id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h2>
<p>datalad is developed by The DataLad Team and Contributors &lt;<a class="reference external" href="mailto:team&#37;&#52;&#48;datalad&#46;org">team<span>&#64;</span>datalad<span>&#46;</span>org</a>&gt;.</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="datalad-status.html" class="btn btn-neutral float-left" title="datalad status" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="datalad-clone.html" class="btn btn-neutral float-right" title="datalad clone" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2016-2022, DataLad team.
      <span class="commit">Revision <code>22b26884</code>.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  

  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
    <span class="rst-current-version" data-toggle="rst-current-version">
      <span class="fa fa-book"> Read the Docs</span>
      v: stable
      <span class="fa fa-caret-down"></span>
    </span>
    <div class="rst-other-versions">
      <dl>
        <dt>Versions</dt>
        
          <dd><a href="/en/latest/">latest</a></dd>
        
          <dd><a href="/en/stable/">stable</a></dd>
        
          <dd><a href="/en/maint/">maint</a></dd>
        
      </dl>
      <dl>
        <dt>Downloads</dt>
        
          <dd><a href="//docs.datalad.org/_/downloads/en/stable/pdf/">pdf</a></dd>
        
          <dd><a href="//docs.datalad.org/_/downloads/en/stable/htmlzip/">html</a></dd>
        
          <dd><a href="//docs.datalad.org/_/downloads/en/stable/epub/">epub</a></dd>
        
      </dl>
      <dl>
        
        <dt>On Read the Docs</dt>
          <dd>
            <a href="//readthedocs.org/projects/datalad/?fromdocs=datalad">Project Home</a>
          </dd>
          <dd>
            <a href="//readthedocs.org/builds/datalad/?fromdocs=datalad">Builds</a>
          </dd>
      </dl>
    </div>
  </div>
<script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>