openstack/openstack-doc-tools
Code Issues Proposed changes

Fix handling of ignored_dirs

Browse Source 
https://review.openstack.org/#/c/94717/ triggered a bug in handling of
ignore_dirs: If a file in one of the ignored directories was changed, we
might still create dependencies for it and trigger an exception. Now we
remove also modified files in ignored directories.

Change-Id: I619d6c441a4fa4759e00d9c9e21c993707b19c6b
This commit is contained in:
Andreas Jaeger
2014-05-26 23:35:55 +02:00
parent 2af6041d17
commit b3874a2c60
2 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@@ -102,12 +102,12 @@ Release notes
* ``openstack-doc-test``: Output information about tested patch,
special case entity files for book building. Remove special handling
for high-availability-guide, it is not using asciidoc anymore.
for high-availability-guide, it is not using asciidoc anymore. Fix
handling of ignore-dir parameter.
* New script in cleanup/retf for spell checking using the RETF rules.
patch.
* Fix entity handling in ``openstack-generate-docbook``.
0.14
----

16
os_doc_tools/doctest.py
View File

@@ -884,6 +884,8 @@ def find_affected_books(rootdir, book_exceptions, file_exceptions,
# Dictionary with books and their bk*.xml files
book_bk = {}
# List of absolute paths of ignored directories
abs_ignore_dirs = []
# 1. Iterate over whole tree and analyze include files.
# This updates included_by, book_bk and books.
for root, dirs, files in os.walk(rootdir):
@@ -891,6 +893,10 @@ def find_affected_books(rootdir, book_exceptions, file_exceptions,
# Filter out directories to be ignored
if ignore_dirs:
for d in dirs:
if d in ignore_dirs:
abs_ignore_dirs.append(
os.path.join(os.path.join(root, d)))
dirs[:] = [d for d in dirs if d not in ignore_dirs]
if os.path.basename(root) in book_exceptions:
@@ -997,6 +1003,13 @@ def find_affected_books(rootdir, book_exceptions, file_exceptions,
# or Type changed
modified_files = get_modified_files(rootdir, "--diff-filter=ACMRT")
modified_files = [os.path.abspath(f) for f in modified_files]
if ignore_dirs:
for idir in abs_ignore_dirs:
non_ignored_files = []
for f in modified_files:
if not f.startswith(idir):
non_ignored_files.append(f)
modified_files = non_ignored_files
# 2. Find all modified files and where they are included
@@ -1339,6 +1352,9 @@ def handle_options():
if CONF.check_build:
if CONF.verbose:
if cfg.CONF.ignore_dir:
for d in cfg.CONF.ignore_dir:
print(" Ignore directory: %s" % d)
print(" Release path: %s" % cfg.CONF.release_path)
print(" Comments enabled: %s" % cfg.CONF.comments_enabled)