Juju Charm Tools

Merge lp://qastaging/~clint-fewbar/charm-tools/flag-readme into lp://qastaging/~charmers/charm-tools/trunk

flag-readme
Merge into trunk

Proposed by Clint Byrum on 2012-10-12

Status:	Merged
Approved by:	Marco Ceppi on 2012-10-25
Approved revision:	165
Merged at revision:	165
Proposed branch:	lp://qastaging/~clint-fewbar/charm-tools/flag-readme
Merge into:	lp://qastaging/~charmers/charm-tools/trunk
Diff against target:	102 lines (+34/-0) 6 files modified scripts/proof (+23/-0) tests/charms/mod-spdy/README (+3/-0) tests/proof/expected/broken-maintainer (+2/-0) tests/proof/expected/missing-maintainer (+2/-0) tests/proof/expected/test (+2/-0) tests/proof/expected/unknown-metadata (+2/-0)
To merge this branch:	bzr merge lp://qastaging/~clint-fewbar/charm-tools/flag-readme
Related bugs:	Link a bug report

Reviewer	Date Requested	Status
Martin Packman (community)		Approve on 2012-10-29
Marco Ceppi (community)	2012-10-12	Approve on 2012-10-25
Review via email: mp+129345@code.qastaging.launchpad.net

Description of the change

Flag instances of the boilerplate lines of the README.ex in a README so that
if somebody just renames the file blindly we get an E:

Revision history for this message

Marco Ceppi (marcoceppi) wrote on 2012-10-25:

LGTM!

review: Approve

Revision history for this message

Martin Packman (gz) wrote on 2012-10-26:

This will throw an error if the readme contains the line "-----\n" say. Only checking non-trivial lines (20 chars or more for instance).

+ for l in [ x.strip() for x in tr]:
...
+ tr.seek(0)

Rather than iterating over the file multiple times and seeking back to the start, do it once and reuse this list. For instance:

    try:
        bad_lines = []
        with open(TEMPLATE_README) as tr:
            for line in tr:
                if len(line) > 20:
                    bad_lines.append(line.strip())
        for readme in found_readmes:
            ...
    except ...

review: Needs Fixing

lp://qastaging/~clint-fewbar/charm-tools/flag-readme updated on 2012-10-28

166. By Clint Byrum on 2012-10-28: address case where short lines in the example README are common idioms
167. By Clint Byrum on 2012-10-28: Adding short lines from README.ex to test short line heuristic