Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

doc update: make clear that we no longer provide binary releases

  • Loading branch information...
commit 8e1cad261a0fb1694def9351021e51fd0d2b8eca 1 parent b89cbb3
@scoder scoder authored
Showing with 49 additions and 67 deletions.
  1. +31 −35 INSTALL.txt
  2. +10 −22 doc/FAQ.txt
  3. +6 −6 doc/build.txt
  4. +2 −4 doc/main.txt
View
66 INSTALL.txt
@@ -19,9 +19,9 @@ Requirements
You need Python 2.4 or later.
-Unless you are using a static binary distribution (e.g. a Windows
-binary egg from PyPI_), you need to install libxml2 and libxslt, in
-particular:
+Unless you are using a static binary distribution (e.g. from a
+Windows binary installer), you need to install libxml2 and libxslt,
+in particular:
* libxml2 2.6.21 or later. It can be found here:
http://xmlsoft.org/downloads.html
@@ -63,14 +63,12 @@ to pip::
.. _pip: http://pypi.python.org/pypi/pip
-* For **MS Windows**, we no longer provide binary distributions due
- to the lack of a maintainer with access to that non-free platform
- as well as a working build system. Also see the related
- `FAQ entry <FAQ.html#where-are-the-binary-builds>`_. If you fail
- to build lxml on your MS Windows system from the signed and tested
- sources that we release, consider using the unofficial binaries that
- `Christoph Gohlke <http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_
- generously provides.
+* For **MS Windows**, we no longer provide binary distributions. Also
+ see the related `FAQ entry <FAQ.html#where-are-the-binary-builds>`_.
+ If you fail to build lxml on your MS Windows system from the signed
+ and tested sources that we release, consider using the `unofficial
+ Windows binaries <http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_
+ that Christoph Gohlke generously provides.
* On **Linux** (and most other well-behaved operating systems),
``pip`` will manage to build the source distribution as
@@ -143,37 +141,35 @@ on a given system. In a way, you get what you've paid for and make
others pay for it.
Due to the additional lack of package management of this platform,
-it is best to link the library dependencies statically when building
-from sources. For that, use the
-`binary distribution <http://www.zlatkovic.com/libxml.en.html>`_
-of libxml2 and libxslt. You need both libxml2 and libxslt, as well
-as iconv and zlib, which you can get from the same download site.
-Further build instructions are in the
-`source build documentation <build.html>`_.
+it is best to link the library dependencies statically if you decide
+to build from sources. For that, use the `binary distribution of
+libxml2 and libxslt <http://www.zlatkovic.com/libxml.en.html>`_.
+You need both libxml2 and libxslt, as well as iconv and zlib,
+which you can get from the same download site. Further build
+instructions are in the `source build documentation <build.html>`_.
MacOS-X
-------
-A macport of lxml is available. Try ``port install py25-lxml``.
+A `macport <http://macports.org/>`_ of lxml is available. Try
+something like ``port install py25-lxml``.
If you want to use a more recent lxml release, you may have to build
-it yourself. Apple doesn't help here, as the system libraries of
-libxml2 and libxslt installed under MacOS-X are horribly outdated, and
-updating them is everything but easy. In any case, you cannot run
-lxml 2.x with the system provided libraries, so you have to use newer
-libraries.
+it yourself. Apple doesn't help here, as MacOS-X is so badly maintained
+by them that the pre-installed system libraries of libxml2 and libxslt
+tend to be horribly outdated, and updating them is everything but easy.
+In any case, you cannot run lxml with the system provided libraries,
+so you have to use newer libraries.
Luckily, lxml's ``setup.py`` script has built-in support for building
and integrating these libraries statically during the build. Please
-read the `MacOS-X build instructions`_.
-
-.. _`MacOS-X build instructions`: build.html#building-lxml-on-macos-x
-.. _fink: http://finkproject.org/
-
-A number of users also reported success with updated libraries
-(e.g. using fink_ or macports), but needed to set the runtime
-environment variable ``DYLD_LIBRARY_PATH`` to the directory where fink
-keeps the libraries. In any case, this method is easy to get wrong
-and everything but safe. Unless you know what you are doing, follow
-the static build instructions above.
+read the
+`MacOS-X build instructions <build.html#building-lxml-on-macos-x>`_.
+
+A number of users also reported success with updated libraries (e.g.
+using `fink <http://finkproject.org/>`_ or macports), but needed to set
+the runtime environment variable ``DYLD_LIBRARY_PATH`` to the directory
+where fink keeps the libraries. In any case, this method is easy to get
+wrong and everything but safe. Unless you know what you are doing,
+follow the static build instructions above.
View
32 doc/FAQ.txt
@@ -412,30 +412,18 @@ see when (or if) a specific bug has been fixed.
Where are the binary builds?
----------------------------
-Binary builds are often requested by users of Microsoft Windows. Two
-of the major design issues of this operating system make it
-non-trivial for users to build lxml: the lack of a pre-installed
+Binary builds are most often requested by users of Microsoft Windows.
+Two of the major design issues of this operating system make it
+non-trivial for its users to build lxml: the lack of a pre-installed
standard compiler and the missing package management.
-We previously provided Windows binaries for new releases, but
-currently lack a maintainer with a suitable build system. If there is
-not currently a binary distribution of the most recent lxml release
-for this platform available from the Python Package Index (PyPI),
-please look through the older versions to see if they provide a binary
-build. This is done by appending the version number to the PyPI URL,
-e.g.::
-
- http://pypi.python.org/pypi/lxml/2.2.8
-
-Christoph Gohlke also provides `unofficial lxml binary builds for
-Windows <http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_ that are
-usually very up to date.
-
-Apart from that, we generally do not provide binary builds of lxml, as
-most of the other operating systems out there can build lxml without
-problems (with `MacOS-X`_ being sometimes an exception), and the sheer
-mass of variations between platforms makes it futile to provide builds
-for everyone.
+We previously provided Windows binaries through PyPI, but no
+longer do so due to the high maintenance overhead they introduce and
+the difficulty in supporting different system configurations.
+Christoph Gohlke generously provides `unofficial lxml binary builds
+for Windows <http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_ that
+are usually very up to date. Consider using them if you prefer a
+binary build over a signed official source release.
Why do I get errors about missing UCS4 symbols when installing lxml?
View
12 doc/build.txt
@@ -22,7 +22,7 @@ Cython
------
.. _pip: http://pypi.python.org/pypi/pip
-.. _Cython: http://www.cython.org
+.. _Cython: http://cython.org
The lxml.etree and lxml.objectify modules are written in Cython_.
Since we distribute the Cython-generated .c files with lxml releases,
@@ -150,7 +150,7 @@ and::
If the tests give failures, errors, or worse, segmentation faults, we'd really
like to know. Please contact us on the `mailing list`_, and please specify
the version of lxml, libxml2, libxslt and Python you were using, as well as
-your operating system type (Linux, Windows, MacOs, ...).
+your operating system type (Linux, Windows, MacOS-X, ...).
.. _`mailing list`: http://lxml.de/mailinglist/
@@ -210,8 +210,8 @@ subdirectory ``libs`` in the lxml distribution, and call ``setup.py``
with the desired target versions like this::
python setup.py build --static-deps \
- --libxml2-version=2.7.3 \
- --libxslt-version=1.1.24 \
+ --libxml2-version=2.7.8 \
+ --libxslt-version=1.1.27 \
sudo python setup.py install
@@ -224,8 +224,8 @@ variable instead::
STATIC_DEPS=true pip install lxml
-Some machines may require an additional run with "sudo" to install the
-package into the Python package directory::
+To install the package into the system Python package directory,
+run the installation with "sudo"::
STATIC_DEPS=true sudo pip install lxml
View
6 doc/main.txt
@@ -154,10 +154,8 @@ Download
The best way to download lxml is to visit `lxml at the Python Package
Index`_ (PyPI). It has the source that compiles on various platforms.
-The source distribution is signed with `this key`_. Binary builds for
-MS Windows usually become available through PyPI a few days after a
-source release. If you can't wait, consider trying a less recent
-release version first.
+The source distribution is signed with `this key`_. Binary builds are
+not available from PyPI due to the increased maintenance overhead.
The latest version is `lxml 3.0beta1`_, released 2012-09-26
(`changes for 3.0beta1`_). `Older versions`_ are listed below.
Please sign in to comment.
Something went wrong with that request. Please try again.