============== ======================= ================ ===========================
Package Role Debian_ Gentoo_
============== ======================= ================ ===========================
-PyYAML_ serialized data storage python-yaml dev-python/pyyaml
+PyYAML_ upgrade old BE storage python-yaml dev-python/pyyaml
Jinja_ HTML templating python-jinja2 dev-python/jinja
CherryPy_ serve repos over HTTPS python-cherrypy3 dev-python/cherrypy
Sphinx_ see :doc:`doc` python-sphinx dev-python/sphinx
.. [#npd] In the science_ overlay.
+.. Debian has a stale ITP for python-numpydoc http://bugs.debian.org/631877
+ which caused BE to be dropped http://bugs.debian.org/609519
+
.. _PyYAML: http://pyyaml.org/
.. _Jinja: http://jinja.pocoo.org/
.. _CherryPy: http://cherrypy.org/
$ make DOC= install
*will* build (first ``make``) and install (second ``make``) the man
- page.
+page.
Also note that there is no need to edit the ``Makefile`` to change any
of its internal variables. You can `override them from the command
for a list of installation options.
-You will still need to install PyYAML. Jinja is only used by the
-``html`` command, so feel free to skip Jinja if you don't mind
+You only need YAML support if you will be upgrading a BE repository
+based on ``Bugs Everywhere Directory v1.4`` or earlier (see
+:file:`.be/version`). If you're installing a fresh instance of BE,
+there's no need to install PyYAML. Jinja is only used by the ``html``
+command, so there's no need to install Jinja if you don't mind
avoiding that command. Similarly, CherryPy is only used for the
-``serve-*`` commands. The other dependencies are only used for
-:doc:`building these docs <doc>`, so feel free to skip them and just
-use the docs wherever you're currently reading them.
+``html`` and ``serve-*`` commands with the ``--ssl`` option set. The
+other dependencies are only used for :doc:`building these docs <doc>`,
+so feel free to skip them and just use the docs wherever you're
+currently reading them.
.. _homepage: http://bugseverywhere.org/
.. _overriding: http://www.gnu.org/software/make/manual/html_node/Overriding.html
================
For those not interested in the cutting edge, or those who don't want
-to worry about installing Git, we'll `post release tarballs`_
-(once we actually make a release). After you've downloaded the
-release tarball, unpack it with::
+to worry about installing Git, we'll `post release tarballs`_. After
+you've downloaded the release tarball, unpack it with::
$ tar -xzvf be-<VERSION>.tar.gz