##// END OF EJS Templates
zstd: vendor python-zstandard 0.5.0...
zstd: vendor python-zstandard 0.5.0 As the commit message for the previous changeset says, we wish for zstd to be a 1st class citizen in Mercurial. To make that happen, we need to enable Python to talk to the zstd C API. And that requires bindings. This commit vendors a copy of existing Python bindings. Why do we need to vendor? As the commit message of the previous commit says, relying on systems in the wild to have the bindings or zstd present is a losing proposition. By distributing the zstd and bindings with Mercurial, we significantly increase our chances that zstd will work. Since zstd will deliver a better end-user experience by achieving better performance, this benefits our users. Another reason is that the Python bindings still aren't stable and the API is somewhat fluid. While Mercurial could be coded to target multiple versions of the Python bindings, it is safer to bundle an explicit, known working version. The added Python bindings are mostly a fully-featured interface to the zstd C API. They allow one-shot operations, streaming, reading and writing from objects implements the file object protocol, dictionary compression, control over low-level compression parameters, and more. The Python bindings work on Python 2.6, 2.7, and 3.3+ and have been tested on Linux and Windows. There are CFFI bindings, but they are lacking compared to the C extension. Upstream work will be needed before we can support zstd with PyPy. But it will be possible. The files added in this commit come from Git commit e637c1b214d5f869cf8116c550dcae23ec13b677 from https://github.com/indygreg/python-zstandard and are added without modifications. Some files from the upstream repository have been omitted, namely files related to continuous integration. In the spirit of full disclosure, I'm the maintainer of the "python-zstandard" project and have authored 100% of the code added in this commit. Unfortunately, the Python bindings have not been formally code reviewed by anyone. While I've tested much of the code thoroughly (I even have tests that fuzz APIs), there's a good chance there are bugs, memory leaks, not well thought out APIs, etc. If someone wants to review the code and send feedback to the GitHub project, it would be greatly appreciated. Despite my involvement with both projects, my opinions of code style differ from Mercurial's. The code in this commit introduces numerous code style violations in Mercurial's linters. So, the code is excluded from most lints. However, some violations I agree with. These have been added to the known violations ignore list for now.
Gregory Szorc -
r30435:b86a448a default
Show More
Name Size Modified Last Commit Author
/ contrib / win32
ReadMe.html Loading ...
buildlocal.bat Loading ...
hg.bat Loading ...
hgwebdir_wsgi.py Loading ...
mercurial.ico Loading ...
mercurial.ini Loading ...
mercurial.iss Loading ...
postinstall.txt Loading ...
win32-build.txt Loading ...


<html>
<head>
<title>Mercurial for Windows</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
<style type="text/css">

</style>
</head>

<body>

Mercurial for Windows



Welcome to Mercurial for Windows!




Mercurial is a command-line application. You must run it from
the Windows command prompt (or if you're hard core, a <a<br /> href="http://www.mingw.org/">MinGW shell).




Note: the standard http://www.mingw.org/">MinGW
msys startup script uses rxvt which has problems setting up
standard input and output. Running bash directly works
correctly.




For documentation, please visit the <a<br /> href="https://mercurial-scm.org/">Mercurial web site.
You can also download a free book, <a<br /> href="http://hgbook.red-bean.com/">Mercurial: The Definitive
Guide.




By default, Mercurial installs to C:\Program
Files\Mercurial
. The Mercurial command is called
hg.exe.



Testing Mercurial after you've installed it




The easiest way to check that Mercurial is installed properly is
to just type the following at the command prompt:




hg



This command should print a useful help message. If it does,
other Mercurial commands should work fine for you.



Configuration notes


Default editor



The default editor for commit messages is 'notepad'. You can set
the EDITOR (or HGEDITOR) environment variable
to specify your preference or set it in mercurial.ini:



[ui]
editor = whatever


Configuring a Merge program



It should be emphasized that Mercurial by itself doesn't attempt
to do a Merge at the file level, neither does it make any
attempt to Resolve the conflicts.




By default, Mercurial will use the merge program defined by the
HGMERGE environment variable, or uses the one defined
in the mercurial.ini file. (see <a<br /> href="https://mercurial-scm.org/wiki/MergeProgram">MergeProgram
on the Mercurial Wiki for more information)



Reporting problems




Before you report any problems, please consult the <a<br /> href="https://mercurial-scm.org/">Mercurial web site
and see if your question is already in our list of <a<br /> href="https://mercurial-scm.org/wiki/FAQ">Frequently
Answered Questions (the "FAQ").




If you cannot find an answer to your question, please feel free
to send mail to the Mercurial mailing list, at <a<br /> href="mailto:mercurial@mercurial-scm.org">mercurial@mercurial-scm.org.
Remember, the more useful information you include in your
report, the easier it will be for us to help you!




If you are IRC-savvy, that's usually the fastest way to get
help. Go to #mercurial on irc.freenode.net.



Author and copyright information




Mercurial was written by http://www.selenic.com">Matt
Mackall, and is maintained by Matt and a team of volunteers.




The Windows installer was written by <a<br /> href="http://www.serpentine.com/blog">Bryan O'Sullivan.




Mercurial is Copyright 2005-2016 Matt Mackall and others. See
the Contributors.txt file for a list of contributors.




Mercurial is free software; you can redistribute it and/or
modify it under the terms of the <a<br /> href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU
General Public License version 2 or any later version.




Mercurial is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty
of merchantability or fitness for a particular
purpose
. See the GNU General Public License for more
details.


</body>
</html>