add basic rst sanity checker

does the spec file end in .rst and does it wrap at 80 columns for
readability.

Change-Id: I48352a1d79f38df936f424bf9290430c0258d79d
This commit is contained in:
Sean Dague
2014-03-18 15:41:43 -04:00
parent c3b03c325d
commit 2819d12d08
2 changed files with 72 additions and 0 deletions

4
run_tests.sh Executable file
View File

@@ -0,0 +1,4 @@
#!/bin/bash
# check basic sanity
./tools/rstcheck.py -d specs

68
tools/rstcheck.py Executable file
View File

@@ -0,0 +1,68 @@
#!/usr/bin/python
# Copyright 2014 Samsung Electronics
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import argparse
import fileinput
import os
import re
import sys
ERRORS = 0
def error(msg):
global ERRORS
ERRORS += 1
print(msg)
def get_options():
parser = argparse.ArgumentParser(
description='RST sanity checker')
parser.add_argument('-d', '--dir', help="Specifications Directory",
default="specs")
return parser.parse_args()
def find_rst_files(dirname):
files = []
for root, dirnames, filenames in os.walk(dirname):
for f in filenames:
if f != ".keep":
files.append("%s/%s" % (root, f))
return files
def ensure_files_end_in_rst(files):
for fname in files:
if not re.search("\.rst$", fname):
error("E001: Filename %s does not end in .rst" % fname)
def ensure_lt80(files):
for fname in files:
for line in fileinput.input(fname):
if len(line) > 80:
error("E002: File %s exceeds 80 columns" % fname)
def main():
opts = get_options()
files = find_rst_files(opts.dir)
ensure_files_end_in_rst(files)
ensure_lt80(files)
if ERRORS > 0:
return 1
return 0
if __name__ == "__main__":
sys.exit(main())