[reprotest] 01/01: Add documentation on how to run virtual servers and explore their options

[Ximin Luo]

This is an automated email from the git hooks/post-receive script.

infinity0 pushed a commit to branch master
in repository reprotest.

commit 508f38d2c014752a58b9c76dae8b410a2a5c6cdc
Author: Ximin Luo <infinity0 at debian.org>
Date:   Fri Nov 18 14:53:25 2016 +0100

    Add documentation on how to run virtual servers and explore their options
---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 473afbe..6687e12 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,6 @@ build. Here are some sample invocations for running reprotest on
 itself:
 
     reprotest 'python3 setup.py bdist' 'dist/*.tar.gz'
-    reprotest 'python3 setup.py bdist_wheel' 'dist/*.whl' qemu /path/to/qemu.img
-    reprotest 'debuild -b -uc -us' '../*.deb' schroot unstable-amd64
     reprotest 'debuild -b -uc -us' '../*.deb' -- null -d
 
 When using reprotest from a shell:
@@ -27,6 +25,35 @@ To get more help for the CLI, including documentation on optional
 arguments and what they do, run `reprotest --help`.
 
 
+Running in a virtual server
+===========================
+
+You can also run the build inside what is called a "virtual server". This could
+be a container, a chroot, etc. There are different ones available, look under
+reprotest/virt (or $PYTHONPATH/reprotest/virt) for a full list. You run them
+like this:
+
+    reprotest 'python3 setup.py bdist_wheel' 'dist/*.whl' qemu /path/to/qemu.img
+    reprotest 'debuild -b -uc -us' '../*.deb' schroot unstable-amd64
+
+You can run `reprotest/virt/$SERVER --help` for a full list of options.
+TODO: add these to reprotest's `--help`.
+
+Unfortunately we currently don't set up build dependencies inside the virtual
+server so you will have to either do that yourself before running reprotest,
+or by giving the set-up command to reprotest manually. For example:
+
+    reprotest --dont-vary=fileordering,kernel \
+        'PATH=/sbin:/usr/sbin:$PATH apt-get install --no-install-recommends -y devscripts equivs;\
+         PATH=/sbin:/usr/sbin:$PATH mk-build-deps -t "apt-get --no-install-recommends -y" -ir;\
+         debuild -b -uc -us' '../*.deb' \
+         schroot unstable-amd64-sbuild
+
+TODO: fix this, e.g. by copying what sbuild does / running sbuild. In
+particular, the above example command installs devscripts and other unnecessary
+dependencies which might pollute the build, so it is not the ideal method.
+
+
 Config File
 ===========
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/reprotest.git