[reprotest] 02/03: Documentation tweaks
Ximin Luo
infinity0 at debian.org
Tue May 9 19:20:50 UTC 2017
This is an automated email from the git hooks/post-receive script.
infinity0 pushed a commit to branch master
in repository reprotest.
commit a17efc6483828c0cfedf9b682e63e4e8c74ef88e
Author: Ximin Luo <infinity0 at debian.org>
Date: Tue May 9 21:13:06 2017 +0200
Documentation tweaks
---
README-dev.rst | 70 +++++++++++++++++++++++++++++++++++++++++++++++++
README.rst | 79 ++++++++++----------------------------------------------
debian/changelog | 7 +++++
setup.py | 2 +-
4 files changed, 91 insertions(+), 67 deletions(-)
diff --git a/README-dev.rst b/README-dev.rst
new file mode 100644
index 0000000..8189b36
--- /dev/null
+++ b/README-dev.rst
@@ -0,0 +1,70 @@
+Running the Tests
+=================
+
+Tests are run with `Tox <https://pypi.python.org/pypi/tox>`__,
+`pytest <https://pypi.python.org/pypi/pytest>`__ and
+`Coverage <https://pypi.python.org/pypi/coverage>`__. On Debian, this
+can be done with
+``apt-get install python3-coverage python3-pytest tox``.
+
+To run the tests, go to the root of the repository, where ``tox.ini`` is
+and run ``tox``. For more verbose output, run ``tox -- -s``.
+
+This runs the tests with no virtualization. To test that reprotest works
+correctly with virtualization, you'll need to setup the virtualization
+servers schroot and qemu.
+
+Some of the following instructions rely on Debian utilities. For
+schroot, run ``mk-sbuild --debootstrap-include=devscripts stable``. (If
+you aren't on ``amd64``, you'll have to include ``--arch``.) For qemu,
+first ``apt-get install autopkgtest vmdebootstrap qemu``, then run:
+
+::
+
+ $ vmdebootstrap --verbose --serial-console --distribution=sid \
+ --customize=/usr/share/autopkgtest/setup-commands/setup-testbed \
+ --user=adt/adt --size=10000000000 --grub --image=adt-sid.raw
+ $ qemu-img convert -O qcow2 adt-sid.raw adt-sid.img
+ $ rm adt-sid.raw
+
+The last two commands reduce the size of the image but aren't strictly
+necessary. Move ``adt-sid.img`` to ``linux/`` under your home directory.
+
+To log into the schroot and qemu containers, respectively, run:
+
+::
+
+ $ sudo schroot -c source:stable-amd64
+ $ qemu-system-x86_64 -enable-kvm -drive file=~/linux/adt-sid.img,if=virtio \
+ -net user -net nic,model=virtio -m 1024
+
+After replacing ``~`` with your home directory.
+
+For the host system and the two containers, run:
+
+::
+
+ $ apt-get install disorderfs
+ (Additionally for mk-sbuild stable, enable the backports repository.)
+ (Additionally for chroot, run:
+ $ mknod -m 666 /dev/fuse c 10 229)
+ $ apt-get install python3 python3-pip
+ $ apt-get install locales-all
+
+Now, finally run the tests:
+
+::
+
+ $ REPROTEST_TEST_SERVERS=null,qemu,schroot tox -- -s
+
+
+Releasing
+=========
+
+After releasing (with ``gbp buildpackage``), please upload a signed tarball:
+
+::
+
+ $ TARBALL=$(dpkg-parsechangelog -SSource)_$(dpkg-parsechangelog -SVersion).tar.xz
+ $ gpg --detach-sign --armor --output=../${TARBALL}.asc < ../${TARBALL}
+ $ scp ../${TARBALL}* alioth.debian.org:/home/groups/reproducible/htdocs/releases/reprotest
diff --git a/README.rst b/README.rst
index 953b2c5..69b0617 100644
--- a/README.rst
+++ b/README.rst
@@ -166,73 +166,20 @@ A sample config file is below.
umask
-Running the Tests
-=================
+Known bugs
+==========
-Tests are run with `Tox <https://pypi.python.org/pypi/tox>`__,
-`pytest <https://pypi.python.org/pypi/pytest>`__ and
-`Coverage <https://pypi.python.org/pypi/coverage>`__. On Debian, this
-can be done with
-``apt-get install python3-coverage python3-pytest tox``.
+The "time" variation uses **faketime** which *sometimes* causes weird and
+hard-to-diagnose problems. In the past, this has included:
-To run the tests, go to the root of the repository, where ``tox.ini`` is
-and run ``tox``. For more verbose output, run ``tox -- -s``.
+- builds taking an infinite amount of time; though this should be fixed in
+ recent versions of reprotest.
-This runs the tests with no virtualization. To test that reprotest works
-correctly with virtualization, you'll need to setup the virtualization
-servers schroot and qemu.
+- builds with implausibly huge differences caused by ./configure scripts
+ producing different results with and without faketime. This still affects
+ bash and probably certain other packages using autotools.
-Some of the following instructions rely on Debian utilities. For
-schroot, run ``mk-sbuild --debootstrap-include=devscripts stable``. (If
-you aren't on ``amd64``, you'll have to include ``--arch``.) For qemu,
-first ``apt-get install autopkgtest vmdebootstrap qemu``, then run:
-
-::
-
- $ vmdebootstrap --verbose --serial-console --distribution=sid \
- --customize=/usr/share/autopkgtest/setup-commands/setup-testbed \
- --user=adt/adt --size=10000000000 --grub --image=adt-sid.raw
- $ qemu-img convert -O qcow2 adt-sid.raw adt-sid.img
- $ rm adt-sid.raw
-
-The last two commands reduce the size of the image but aren't strictly
-necessary. Move ``adt-sid.img`` to ``linux/`` under your home directory.
-
-To log into the schroot and qemu containers, respectively, run:
-
-::
-
- $ sudo schroot -c source:stable-amd64
- $ qemu-system-x86_64 -enable-kvm -drive file=~/linux/adt-sid.img,if=virtio \
- -net user -net nic,model=virtio -m 1024
-
-After replacing ``~`` with your home directory.
-
-For the host system and the two containers, run:
-
-::
-
- $ apt-get install disorderfs
- (Additionally for mk-sbuild stable, enable the backports repository.)
- (Additionally for chroot, run:
- $ mknod -m 666 /dev/fuse c 10 229)
- $ apt-get install python3 python3-pip
- $ apt-get install locales-all
-
-Now, finally run the tests:
-
-::
-
- $ REPROTEST_TEST_SERVERS=null,qemu,schroot tox -- -s
-
-
-Releasing
-=========
-
-After releasing (with ``gbp buildpackage``), please upload a signed tarball:
-
-::
-
- $ TARBALL=$(dpkg-parsechangelog -SSource)_$(dpkg-parsechangelog -SVersion).tar.xz
- $ gpg --detach-sign --armor --output=../${TARBALL}.asc < ../${TARBALL}
- $ scp ../${TARBALL}* alioth.debian.org:/home/groups/reproducible/htdocs/releases/reprotest
+If you see a difference that you really think should not be there, try passing
+``--dont-vary time`` to reprotest, and/or check our results on
+https://tests.reproducible-builds.org/ which use a different (more reliable)
+mechanism to vary the system time.
diff --git a/debian/changelog b/debian/changelog
index be3985c..2edd806 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+reprotest (0.6.2) UNRELEASED; urgency=medium
+
+ * Add a documentation section on "Known bugs".
+ * Move developer documentation away from the man page.
+
+ -- Ximin Luo <infinity0 at debian.org> Tue, 09 May 2017 21:12:17 +0200
+
reprotest (0.6.1) unstable; urgency=medium
* Preserve directory structure when copying artifacts. Otherwise hash output
diff --git a/setup.py b/setup.py
index 9b63995..b59aeae 100644
--- a/setup.py
+++ b/setup.py
@@ -6,7 +6,7 @@
from setuptools import setup, find_packages
setup(name='reprotest',
- version='0.6.1',
+ version='0.6.2',
description='Build packages and check them for reproducibility.',
long_description=open('README.rst', encoding='utf-8').read(),
author='Ceridwen',
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/reprotest.git
More information about the Reproducible-commits
mailing list