annotate mercurial/help/hgignore.txt @ 29196:bf7b8157c483 stable

strip: invalidate phase cache after stripping changeset (issue5235)

When we remove a changeset from the changelog, the phase cache must be
invalidated, otherwise it could refer to changesets that are no longer in the
repo.

To reproduce the failure, I created an extension querying the phase cache after
the strip transaction is over.

To do that, I stripped two commits with a bookmark on one of them to force
another transaction (we open a transaction for moving bookmarks)
after the strip transaction.

Without the fix in this patch, the test leads to a stacktrace showing the issue:
      repair.strip(ui, repo, revs, backup)
    File "/Users/lcharignon/facebook-hg-rpms/hg-crew/mercurial/repair.py", line 205, in strip
      tr.close()
    File "/Users/lcharignon/facebook-hg-rpms/hg-crew/mercurial/transaction.py", line 44, in _active
      return func(self, *args, **kwds)
    File "/Users/lcharignon/facebook-hg-rpms/hg-crew/mercurial/transaction.py", line 490, in close
      self._postclosecallback[cat](self)
    File "$TESTTMP/crashstrip2.py", line 4, in test
      [repo.changelog.node(r) for r in repo.revs("not public()")]
    File "/Users/lcharignon/facebook-hg-rpms/hg-crew/mercurial/changelog.py", line 337, in node
      return super(changelog, self).node(rev)
    File "/Users/lcharignon/facebook-hg-rpms/hg-crew/mercurial/revlog.py", line 377, in node
      return self.index[rev][7]
  IndexError: revlog index out of range

The situation was encountered in inhibit (evolve's repo) where we would crash
following the volatile set invalidation submitted by Augie in
e6f490e328635312ee214a12bc7fd3c7d46bf9ce. Before his patch the issue was masked
as we were not accessing the phasecache after stripping a revision.

This bug uncovered another but in histedit (see explanation in issue5235).
I changed the histedit test accordingly to avoid fixing two things at once.

Synopsis
========

The Mercurial system uses a file called ``.hgignore`` in the root
directory of a repository to control its behavior when it searches
for files that it is not currently tracking.

Description
===========

The working directory of a Mercurial repository will often contain
files that should not be tracked by Mercurial. These include backup
files created by editors and build products created by compilers.
These files can be ignored by listing them in a ``.hgignore`` file in
the root of the working directory. The ``.hgignore`` file must be
created manually. It is typically put under version control, so that
the settings will propagate to other repositories with push and pull.

An untracked file is ignored if its path relative to the repository
root directory, or any prefix path of that path, is matched against
any pattern in ``.hgignore``.

For example, say we have an untracked file, ``file.c``, at
``a/b/file.c`` inside our repository. Mercurial will ignore ``file.c``
if any pattern in ``.hgignore`` matches ``a/b/file.c``, ``a/b`` or ``a``.

In addition, a Mercurial configuration file can reference a set of
per-user or global ignore files. See the ``ignore`` configuration
key on the ``[ui]`` section of :hg:`help config` for details of how to
configure these files.

To control Mercurial's handling of files that it manages, many
commands support the ``-I`` and ``-X`` options; see
:hg:`help <command>` and :hg:`help patterns` for details.

Files that are already tracked are not affected by .hgignore, even
if they appear in .hgignore. An untracked file X can be explicitly
added with :hg:`add X`, even if X would be excluded by a pattern
in .hgignore.

Syntax
======

An ignore file is a plain text file consisting of a list of patterns,
with one pattern per line. Empty lines are skipped. The ``#``
character is treated as a comment character, and the ``\`` character
is treated as an escape character.

Mercurial supports several pattern syntaxes. The default syntax used
is Python/Perl-style regular expressions.

To change the syntax used, use a line of the following form::

  syntax: NAME

where ``NAME`` is one of the following:

``regexp``
  Regular expression, Python/Perl syntax.
``glob``
  Shell-style glob.

The chosen syntax stays in effect when parsing all patterns that
follow, until another syntax is selected.

Neither glob nor regexp patterns are rooted. A glob-syntax pattern of
the form ``*.c`` will match a file ending in ``.c`` in any directory,
and a regexp pattern of the form ``\.c$`` will do the same. To root a
regexp pattern, start it with ``^``.

Subdirectories can have their own .hgignore settings by adding
``subinclude:path/to/subdir/.hgignore`` to the root ``.hgignore``. See
:hg:`help patterns` for details on ``subinclude:`` and ``include:``.

.. note::

  Patterns specified in other than ``.hgignore`` are always rooted.
  Please see :hg:`help patterns` for details.

Example
=======

Here is an example ignore file. ::

  # use glob syntax.
  syntax: glob

  *.elc
  *.pyc
  *~

  # switch to regexp syntax.
  syntax: regexp
  ^\.pc/