view README.rst @ 48482:d2fff292c265

pytype: stop excluding statprof.py

This seems to have worked fine before (at least on Linux).  We could just add
suppression comments, but this file already imports from the mercurial package,
which seems to prevent this from running as a standalone program because of the
relative import of `pycompat`.  PyCharm isn't happy either way.

  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 501, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 1091, in main
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 501, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 431, in profile
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 522, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 1091, in main
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 522, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 431, in profile
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 523, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 1091, in main
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 523, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 431, in profile
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 524, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 1091, in main
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 524, in display:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)
  Called from (traceback):
    line 431, in profile
  File "/mnt/c/Users/Matt/hg/mercurial/statprof.py", line 796, in _write:
      Function TextIO.write was called with the wrong arguments [wrong-arg-types]
           Expected: (self, s: str)
    Actually passed: (self, s: bytes)

Differential Revision: https://phab.mercurial-scm.org/D11921

Mercurial
=========

Mercurial is a fast, easy to use, distributed revision control tool
for software developers.

Basic install::

 $ make            # see install targets
 $ make install    # do a system-wide install
 $ hg debuginstall # sanity-check setup
 $ hg              # see help

Running without installing::

 $ make local      # build for inplace usage
 $ ./hg --version  # should show the latest version

See https://mercurial-scm.org/ for detailed installation
instructions, platform-specific notes, and Mercurial user information.

Notes for packagers
===================

Mercurial ships a copy of the python-zstandard sources. This is used to
provide support for zstd compression and decompression functionality. The
module is not intended to be replaced by the plain python-zstandard nor
is it intended to use a system zstd library. Patches can result in hard
to diagnose errors and are explicitly discouraged as unsupported
configuration.