* pr-171:
  Per-discussion updates
  Grammar: noun vs. verb
  Move README.coding to docs/code-guidelines.rst.
  Add docs/README.rst
  Clean up documentation.
  Add a few more To Do items.
  Add some developer/tester documentation.
  Clean up formatting on readme file

This adds a newline to the end of the input prompt which prevents the
destruction of text displayed within prompts when the window is resized.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

dsync-flist was broken by the upgrade to Debian 10 (buster). Also the
file contained its own (outdated) checksum which is never correct.
I am not sure if we should fix this or just drop the file.

Signed-off-by: NMichael Lustfield <michael@lustfield.net>

Signed-off-by: NMichael Lustfield <michael@lustfield.net>

This moves the code standards to a place that is consistent with other
DAK-related documentation. This document is now rst-formatted as well.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

This is just a simple "readme" that directs new readers to the
documentation that will likely be most relevant to them.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

The leading "README." on each file seems excessive, especially
considering this is a "docs/" directory. This was removed to make
identifying specific files a bit easier. Appropriate file extensions
were also added.

Formatting was also cleaned up so nearly-rst documents could be
rendered properly.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

These are some frustrations I've encountered working through the queue.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

This additional documentation describes how to get a dev/test instance
of dak up and running.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

This file was nearly RST-formatted; now it is.
Signed-off-by: NMichael Lustfield <michael@lustfield.net>

The current lintian version in backports triggers false-positives for
this tag, see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=954146

Remove this tag for now. It can come back when lintian is fixed.

improve UTF8 handling

See merge request ftp-team/dak!178

Default GPG signature verification output has a trailing validity
identifier ("[ultimate]", "[unknown]", etc) now, so the gpg signature
checking regex was no longer matching. This resulted in surprising log
lines like:

Feb 29 04:59:31 processing /kees-1582951501.dak-commands
Feb 29 04:59:31 (PGP/GnuPG signature by unknown signator)

Existing regex is:
  $output =~ /^(gpg: )?good signature from (user )?"(.*)"\.?$/im;

Current gpg sees:

$ gpg --verify --no-default-keyring --keyring /srv/keyring.debian.org/keyrings/debian-keyring.gpg kees-1582951501.dak-commands
gpg: Signature made Sat 29 Feb 2020 04:45:01 AM UTC
gpg:                using RSA key A5C3F68F229DD60F723E6E138972F4DFDC6DC026
gpg: Good signature from "Kees Cook <kees@outflux.net>" [unknown]
gpg:                 aka "Kees Cook <kees@debian.org>" [unknown]
...

Instead, launch gpg with --verify-options no-show-uid-validity to avoid
breaking the regex.

While here, I made the more robust by adding "?:" prefixes to the unused
regex match groups so the assignment on the next line can always use $1:

  ( $signator = $1 ) ||= "unknown signator";

don't crash in case a user got a lock but the userid is no longer defined

See merge request ftp-team/dak!170

Reference: https://lists.debian.org/debian-services-admin/2020/01/msg00000.html

The code base contains a few unfornuate patterns such as:

    data = open(...).read()

OR

    fh = open(...)
    data = fh.read()

This causes a file descriptor leak as the opened file is never
explicitly closed again.  While slightly mitigated by CPython using
ref-counting and immediate closure, we should still update the code
to close the files.

This commit focuses on a large number of simple clean ups.  Most of
which relies on the "with open(...) as X" pattern where feasible.

As "with" causes identation noise, this commit deliberately refains
from "fixing" other suboptimal behaviour.  Notably there are several
instances of "except:" visible in the diff that should ideally be
reduced.
Signed-off-by: NNiels Thykier <niels@thykier.net>

Slightly reduces the changes from 2to3 while remaining python2
compatible.
Signed-off-by: NNiels Thykier <niels@thykier.net>

Signed-off-by: NNiels Thykier <niels@thykier.net>

Signed-off-by: NNiels Thykier <niels@thykier.net>

Signed-off-by: NNiels Thykier <niels@thykier.net>

Signed-off-by: NNiels Thykier <niels@thykier.net>