[Reportbug-commits] [reportbug] 23/27: update README.source to the current source layout; Closes: #827002

[Sandro Tosi]

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

morph pushed a commit to branch master
in repository reportbug.

commit 9012330b239b5348dd11671a3b29345127cde3de
Author: Sandro Tosi <morph at debian.org>
Date:   Mon May 29 15:45:48 2017 -0400

    update README.source to the current source layout; Closes: #827002
---
 debian/changelog  |  4 +++-
 doc/README.source | 53 ++++++++++++++++++++++++-----------------------------
 2 files changed, 27 insertions(+), 30 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 4bce570..a96b10b 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -36,8 +36,10 @@ reportbug (7.1.7) UNRELEASED; urgency=medium
   * bin/reportbug
     - fix error formatting when printing the error for draft directory
       non-existing; patch by Gaetano Guerriero; Closes: #816375
+  * doc/README.source
+    - update README.source to the current source layout; Closes: #827002
 
- -- Sandro Tosi <morph at debian.org>  Mon, 29 May 2017 15:13:49 -0400
+ -- Sandro Tosi <morph at debian.org>  Mon, 29 May 2017 15:45:27 -0400
 
 reportbug (7.1.6) unstable; urgency=medium
 
diff --git a/doc/README.source b/doc/README.source
index 8073d09..ace1bab 100644
--- a/doc/README.source
+++ b/doc/README.source
@@ -5,7 +5,7 @@ The source tree for ``reportbug`` is organised this way:
 
 * Top level
 
-  * Manual pages.
+  * Installation tools
 
 * Debian packaging
 
@@ -25,18 +25,16 @@ The source tree for ``reportbug`` is organised this way:
 * `Unit testing framework`_
 
   * ``test/`` contains the unit test suite. Unit test modules are
-    discovered and run using the ``nosetests`` program, and are named
+    discovered and run using the ``nosetests3`` program, and are named
     as ``test_*.py``.
 
-* Internal checking framework
+* Documentation
 
-  * ``checks/`` contains various scripts that ensure reportbug's
-    internals are up-to-date with the Debian BTS.
+  * ``doc/`` contains documentation for both users and developers.
 
-* Internationalisation and localisation
+* Manual pages
 
-  * ``po4a/`` contains configuration and data for localisation of
-    source files using the ``po4a`` tool.
+  * ``man/`` contains the manual pages for the programs.
 
 Unit testing framework
 ======================
@@ -47,14 +45,13 @@ The directory ``test/`` contains unit test modules and supporting
 files. New unit test modules should be added to this directory and
 named ``test_*.py``.
 
-The unit test suite depends on the `python-nose` package being
-installed, to make the ``nosetests`` command available. The unit tests
-themselves can be written using either the `unittest` or `doctest`
-modules in the standard Python library.
+The unit test suite depends on the `python3-nose` package being
+installed, to make the ``nosetests3`` command available. The unit tests
+themselves can be written using the `unittest` modules in the standard
+Python library.
 
-The `scaffold` module (from the ``test/scaffold.py`` file) contains
-some helper functionality for unit tests, including an extended
-`TestCase` class.
+The ``data/`` contains some additional files required by tests, such as
+control files, scripts, etc.
 
 ``make`` targets for testing and quality checks
 -----------------------------------------------
@@ -62,29 +59,24 @@ some helper functionality for unit tests, including an extended
 The following ``make`` targets are useful for testing and related
 tasks.
 
-* ``make test`` runs the unit test suite, preceded by a timestamp
+* ``make tests`` runs the unit test suite, preceded by a timestamp
   banner, and reports any test failures or "OK" if all tests pass.
 
-* ``make test-continuous`` starts a loop which clears the screen, runs
-  ``make test``, then waits for any of the tests or source code to
-  change, and starts the loop again.
-
-  This is useful to run in a separate terminal during a development
-  session, so that whenever a change is made the test suite will be
-  run automatically. You might want to keep the window hidden while
-  actually editing files, and only look at it when you've created or
-  modified a file and want to check its effect on the test run.
-
-  This uses the ``inotifywait`` command from the `inotify-tools`
-  package to wait for `create` and `modify` events.
+* ``make quicktests`` runs the unit test suite, but only for those
+  tests that dont require network access, which can be slow sometimes
+  (hence the name)
 
 * ``make coverage`` runs the test suite and collects test coverage
   information, then reports the current statement coverage of the test
   suite.
 
-  This requires the `python-coverage` package to be installed. See its
+  This requires the `python3-coverage` package to be installed. See its
   documentation for more about its operation.
 
+* ``make coverhtml`` runs  the test suite and collects test coverage
+  information, then reports the current statement coverage using an HTML
+  output format.
+
 * ``make pyflakes`` runs the `pyflakes` static code checker on all
   Python files found in the project tree.
 
@@ -97,6 +89,9 @@ tasks.
   This requires the `pylint` package to be installed. See its
   documentation for more about its operation.
 
+* ``make pep8`` runs the `pep8` static code checker.
+
+  This requires the `pep8` package to be installed.
 
 ..
     Local Variables:

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