[Reproducible-commits] [misc] 01/02: reports: more documentation tweaks

[Ximin Luo]

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

infinity0 pushed a commit to branch master
in repository misc.

commit ecdee4dc1e8ffa56a748aa4af09c789fe42d12ae
Author: Ximin Luo <infinity0 at debian.org>
Date:   Tue Aug 9 00:57:10 2016 +0200

    reports: more documentation tweaks
---
 reports/README | 51 +++++++++++++++++++++------------------------------
 1 file changed, 21 insertions(+), 30 deletions(-)

diff --git a/reports/README b/reports/README
index ab0f29f..9ff347a 100644
--- a/reports/README
+++ b/reports/README
@@ -26,28 +26,29 @@ Process
 
 1. Look at packages that became reproducible in that week.
 
-   There's a script that will use the history in the
-   reproducible.debian.net database to figure this out.
-
        $ bin/newly-reproducible
 
-   The output needs to be manually verified. Some packages will
-   be fixed by a change in the toolchain and be marked as fixed in
-   a given version because of a timely upload. Also the script
-   might give some false positive: packages might have been
+   This output will form the base for the stats in your report.
+   It needs to be manually verified. Some packages would've been
+   fixed by a change in the toolchain and only appear to be fixed
+   in a given version because of a timely upload. Also the script
+   might give some false positives: packages might have been
    reproducible before, broken by a toolchain upload later fixed.
 
-   Interactive mode:
+   Interactive mode, to help with manual verification:
 
        $ bin/newly-reproducible --interactive
 
-   Look at each package individually:
+   Once you get used to the workflow, this will save you a lot of time:
+
+       $ bin/newly-reproducible -ia
+
+   You can also look at specific packages:
 
-       $ bin/history ghc                # defaults to all arches
-       $ bin/history -s unstable ghc    # filter to suite unstable
-       $ bin/history -a armhf ghc       # filter to arch armhf
-       $ bin/history -x ghc             # more details
-       $ bin/history -c ghc             # also show changelogs
+       $ bin/newly-reproducible -ia ghc rustc ocamlc
+
+   The underlying script that powers interactive mode is bin/history;
+   see that for details.
 
 2. Look at all relevant bug reports that have been modified this week.
 
@@ -55,7 +56,7 @@ Process
    updated in the past 7 days, then use the `bts` tool to cache
    them, and finally display them using `mutt`.
 
-       $ bin/review-bugs
+       $ bin/review-bugs     # this will take a while, do (3) while it runs
        $ bin/review-bugs -o  # on subsequent runs, to avoid re-downloading
 
    Non-FTBFS bugs that have patches:
@@ -66,26 +67,16 @@ Process
 
        $ bin/review-uploads
 
-   If you can't use that script, the archive is available on the web:
-   https://lists.debian.org/debian-devel-changes/
-
-4. Stats for reviews:
+4. Stats for package reviews:
 
    Make sure you get a recent copy of `notes.git`. Then:
 
-   Stats about packages' issues:
-
-       $ ../misc/reports/bin/review-stats
-
-   Updates to the issues themselves:
-
-       $ ../misc/reports/bin/review-issues
+       $ ../misc/reports/bin/review-stats       # changes to packages
+       $ ../misc/reports/bin/review-issues      # changes to issues
 
 5. QA work:
 
-   For new FTBFS bugs:
-
-       $ cat latest/new-bugs-ftbfs.txt
+       $ cat latest/new-bugs-ftbfs.txt          # new FTBFS bugs
 
 6. Manually reported:
 
@@ -102,7 +93,7 @@ Process
 
    Complete with stuff in Git:
    https://lists.alioth.debian.org/pipermail/reproducible-commits/
-   https://anonscm.debian.org/cgit/reproducible/
+   https://anonscm.debian.org/cgit/reproducible/?s=idle
 
    Also take a look at jenkins.debian.net:
    https://lists.alioth.debian.org/pipermail/qa-jenkins-scm/

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