From 4b43f4653085ad3d63b13c0af1435678d7e0ccb7 Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 9 Oct 2018 15:10:23 -0400 Subject: [PATCH] Update roles-needing-docs.py --- scripts/roles-needing-docs.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/scripts/roles-needing-docs.py b/scripts/roles-needing-docs.py index 3d5a0aa83..9a2173c53 100755 --- a/scripts/roles-needing-docs.py +++ b/scripts/roles-needing-docs.py @@ -1,9 +1,9 @@ #!/usr/bin/env python3 ''' -This script checks every role in the project and prints its name to stdout if -the role directory does not contain a README file and it is not listed in -scripts/docs-ignore. +This script checks every role in the (Internet-in-a-Box) project and prints its +name to stdout if (1) the role directory does not contain a README file, and +(2) the role is not listed in /opt/iiab/iiab/unmaintained-roles.txt For ease of use, you can pipe the output of this script to a file or to a clipboard utility (e.g. pbcopy on macOS, xclip on Linux). @@ -16,7 +16,9 @@ from glob import glob def included_roles(): all_roles = set(os.listdir("/opt/iiab/iiab/roles")) excluded_roles = \ - map(str.rstrip, open(make_path("/opt/iiab/iiab/scripts", "/opt/iiab/iiab/scripts/docs-ignore"))) + map(str.rstrip, + open(make_path("/opt/iiab/iiab/scripts", + "/opt/iiab/iiab/unmaintained-roles.txt"))) included_roles = list(all_roles.difference(excluded_roles)) included_roles.sort() return included_roles