From 853d27170363493a94b6a37803249ef6a31955c6 Mon Sep 17 00:00:00 2001 From: Jeremie Guichard Date: Fri, 17 Jan 2025 09:20:42 +0100 Subject: [PATCH] Deprecate the --install-directory option resolves #165 --- rosdoc2/verbs/build/impl.py | 8 +++----- rosdoc2/verbs/scan/impl.py | 7 +++---- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/rosdoc2/verbs/build/impl.py b/rosdoc2/verbs/build/impl.py index 8eff6a1..a777fe8 100644 --- a/rosdoc2/verbs/build/impl.py +++ b/rosdoc2/verbs/build/impl.py @@ -66,7 +66,7 @@ def prepare_arguments(parser): parser.add_argument( '--install-directory', '-i', - help='install directory of the package', + help='UNUSED, to be removed at some time (install directory of the package)', ) parser.add_argument( '--cross-reference-directory', @@ -127,10 +127,8 @@ def main_impl(options): 'The --build-directory option (-b) is unused and will be removed in a future version') if options.install_directory is not None: - # Check that the install directory exists. - if not os.path.exists(options.install_directory): - sys.exit( - f"Error: given install directory '{options.install_directory}' does not exist") + logger.warn( + 'The --install-directory option (-i) is unused and will be removed in a future version') # Inspect package for additional settings, using defaults if none found. tool_settings, builders = inspect_package_for_settings( diff --git a/rosdoc2/verbs/scan/impl.py b/rosdoc2/verbs/scan/impl.py index 585dc97..d9d29fd 100644 --- a/rosdoc2/verbs/scan/impl.py +++ b/rosdoc2/verbs/scan/impl.py @@ -26,6 +26,7 @@ logging.basicConfig( format='[%(name)s] [%(levelname)s] %(message)s', level=logging.INFO) +logger = logging.getLogger('rosdoc2') logger_scan = logging.getLogger('rosdoc2.scan') goptions = None @@ -87,10 +88,8 @@ def main_impl(options): goptions = options if options.install_directory is not None: - # Check that the install directory exists. - if not os.path.exists(options.install_directory): - sys.exit( - f"Error: given install directory '{options.install_directory}' does not exist") + logger.warn( + 'The --install-directory option (-i) is unused and will be removed in a future version') # Locate the packages to document. found_packages = find_packages_allowing_duplicates(options.package_path)