Skip to content

Commit

Permalink
Fixes indentation of rST commands
Browse files Browse the repository at this point in the history
  • Loading branch information
remram44 committed Dec 2, 2014
1 parent d156bed commit 24207a5
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ What if I need to pack multiple command lines?

The easiest way, in this case, is to write a script that runs all the desired command lines, and then to trace the execution of this script with `reprozip`.

.. _pycrypto_windows:
.. _pycrypto_windows:

Why `reprounzip-vagrant` installation fails with error ``Unable to find vcvarsall.bat`` on Windows?
===================================================================================================

Python is trying to build `PyCrypto <https://www.dlitz.net/software/pycrypto/>`_, one of the dependencies of `reprounzip-vagrant`, but there is no C compiler available. You can either build PyCrypto from source, or follow the instructions on `this website <http://stackoverflow.com/questions/11405549/how-do-i-install-pycrypto-on-windows>`_ to get the non-official binaries.

.. _compiler_mac:
.. _compiler_mac:

Why `reprounzip-vagrant` installation fails with error ``unknown argument: '-mno-fused-madd'`` on Mac OS X?
===========================================================================================================
Expand Down
10 changes: 5 additions & 5 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In our `website <http://vida-nyu.github.io/reprozip/>`_, you can find links to o

In the following, you will find installation instructions for :ref:`linux`, :ref:`mac`, and :ref:`windows`.

.. _linux:
.. _linux:

Linux
=====
Expand Down Expand Up @@ -74,7 +74,7 @@ Alternatively, you can install *reprounzip* with all the available plugins using

$ pip install reprounzip[all]

.. _mac:
.. _mac:

Mac OS X
========
Expand Down Expand Up @@ -110,7 +110,7 @@ Besides Python and pip, each component or plugin to be used may have additional
.. [#macn] This is usually provided by installing Xcode (in the Mac App Store) and the Command Line Developer Tools; instructions on installing the latter may depend on your Mac OS X version (some information on StackOverflow `here <http://stackoverflow.com/questions/9329243/xcode-4-4-and-later-install-command-line-tools?answertab=active#tab-top>`_).
.. [#pycrypton2] Required to build `PyCrypto <https://www.dlitz.net/software/pycrypto/>`_.
.. seealso:: :ref:`compiler_mac`
.. seealso:: :ref:`compiler_mac`

Installing *reprounzip*
-----------------------
Expand All @@ -136,7 +136,7 @@ Alternatively, you can install *reprounzip* with all the available plugins using

$ pip install reprounzip[all]

.. _windows:
.. _windows:

Windows
=======
Expand Down Expand Up @@ -170,7 +170,7 @@ Besides Python and pip, each component or plugin to be used may have additional
.. [#bug3] Due to `Python bug 13676 <http://bugs.python.org/issue13676>`_ related to sqlite3.
.. [#pycrypton3] A working C compiler is required to build PyCrypto. For installation without building from source, please see `this page <http://stackoverflow.com/questions/11405549/how-do-i-install-pycrypto-on-windows>`_.
.. seealso:: :ref:`pycrypto_windows`
.. seealso:: :ref:`pycrypto_windows`

Installing *reprounzip*
-----------------------
Expand Down
20 changes: 10 additions & 10 deletions docs/source/unpacking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ The *directory* unpacker (``reprounzip directory``) allows users to unpack the e

Please note that, although this unpacker is easy to use and does not require any privilege on the reproducing machine, it is **unreliable** since the directory is not isolated in any way from the remainder of the system. In particular, should the experiment use absolute paths, they will hit the host system instead. However, if the system has all the required packages (see :ref:`unpack-installpkgs`), and the experiment's files are addressed with relative paths, the use of this unpacker should not cause any problems.

.. warning:: ``reprounzip directory`` provides no isolation of the filesystem, as mentioned before. If the experiment uses absolute paths, either provided by you or hardcoded in the experiment, **they will point outside the unpacked directory**. Please be careful to use relative paths in the configuration and command line if you want this unpacker to work with your experiment. Other unpackers are more reliable in this regard.
.. warning:: ``reprounzip directory`` provides no isolation of the filesystem, as mentioned before. If the experiment uses absolute paths, either provided by you or hardcoded in the experiment, **they will point outside the unpacked directory**. Please be careful to use relative paths in the configuration and command line if you want this unpacker to work with your experiment. Other unpackers are more reliable in this regard.

.. note:: ``reprounzip directory`` is automatically distributed with `reprounzip`.
.. note:: ``reprounzip directory`` is automatically distributed with `reprounzip`.

.. _unpack-chroot:

Expand All @@ -113,11 +113,11 @@ The `chroot` Unpacker: Providing Isolation with the *chroot* Mechanism

In the *chroot* unpacker (``reprounzip chroot``), similar to ``reprounzip directory``, a directory is created from the experiment package; however, a full system environment is also built, which can then be run with ``chroot(2)``, a Linux mechanism that changes the root directory ``/`` for the experiment to the experiment directory. Therefore, this unpacker addresses the limitation of the *directory* unpacker and does not fail in the presence of hardcoded absolute paths. Note as well that it **does not interfere with the current environment** since the experiment is isolated in that single directory.

.. warning:: do **not** try to delete the experiment directory manually; **always** use ``reprounzip chroot destroy``. If ``/dev`` is mounted inside, you will also delete your system's device pseudo-files (these can be restored by rebooting or running the ``MAKEDEV`` script).
.. warning:: do **not** try to delete the experiment directory manually; **always** use ``reprounzip chroot destroy``. If ``/dev`` is mounted inside, you will also delete your system's device pseudo-files (these can be restored by rebooting or running the ``MAKEDEV`` script).

.. note:: although *chroot* offers pretty good isolation, it is not considered completely safe: it is possible for processes owned by root to "escape" to the outer system. We recommend not running untrusted programs with this plugin.
.. note:: although *chroot* offers pretty good isolation, it is not considered completely safe: it is possible for processes owned by root to "escape" to the outer system. We recommend not running untrusted programs with this plugin.

.. note:: ``reprounzip chroot`` is automatically distributed with `reprounzip`.
.. note:: ``reprounzip chroot`` is automatically distributed with `reprounzip`.

.. _unpack-installpkgs:

Expand All @@ -134,9 +134,9 @@ To install the required dependencies, the following command should be used::

Users may use flag *y* or *assume-yes* to automatically confirm all the questions from the package manager; flag *missing* to install only the software packages that were not originally included in the experiment package (i.e.: software packages excluded in the configuration file); and flag *summary* to simply provide a summary of which software packages are installed or not in the current environment **without installing any dependency**.

.. note:: this unpacker is only used to install software packages. Users still need to use either ``reprounzip directory`` or ``reprounzip chroot`` to extract the experiment and execute it.
.. note:: this unpacker is only used to install software packages. Users still need to use either ``reprounzip directory`` or ``reprounzip chroot`` to extract the experiment and execute it.

.. note:: ``reprounzip installpkgs`` is automatically distributed with `reprounzip`.
.. note:: ``reprounzip installpkgs`` is automatically distributed with `reprounzip`.

.. _unpackers:

Expand All @@ -152,7 +152,7 @@ In addition to the commands listed in :ref:`unpacker-commands`, you can use ``su
$ reprounzip vagrant suspend <path>
$ reprounzip vagrant setup/start <path>
.. note:: this unpacker is **not** distributed with `reprounzip`; it is a separate package that should be installed before using (see `reprounzip-vagrant plugin <https://pypi.python.org/pypi/reprounzip-vagrant/>`_).
.. note:: this unpacker is **not** distributed with `reprounzip`; it is a separate package that should be installed before using (see `reprounzip-vagrant plugin <https://pypi.python.org/pypi/reprounzip-vagrant/>`_).

.. _docker-plugin:

Expand All @@ -161,7 +161,7 @@ The `docker` Unpacker: Building a Docker Container

ReproZip can also extract and reproduce experiments as `Docker <https://www.docker.com/>`_ containers. The *docker* unpacker (``reprounzip docker``) is responsible for such integration and it assumes that Docker is already installed in the current environment.

.. note:: this unpacker is **not** distributed with `reprounzip`; it is a separate package that should be installed before using (see `reprounzip-docker plugin <https://pypi.python.org/pypi/reprounzip-docker/>`_).
.. note:: this unpacker is **not** distributed with `reprounzip`; it is a separate package that should be installed before using (see `reprounzip-docker plugin <https://pypi.python.org/pypi/reprounzip-docker/>`_).

.. _unpacker-commands:

Expand All @@ -185,7 +185,7 @@ Note that, once this is done, you should only remove `<path>` with the `destroy`

The other unpacker commands take the `<path>` argument; they do not need the original package for the reproduction.

.. note:: most unpackers assume an Internet connection for the ``setup`` command and will be downloading required software from the Internet. Make sure that you have an Internet connection, and that there is no firewall blocking the access.
.. note:: most unpackers assume an Internet connection for the ``setup`` command and will be downloading required software from the Internet. Make sure that you have an Internet connection, and that there is no firewall blocking the access.

Reproducing the Experiment
++++++++++++++++++++++++++
Expand Down

0 comments on commit 24207a5

Please sign in to comment.