Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate the --install-directory option #166

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate the --install-directory option #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions rosdoc2/verbs/build/impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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(
Expand Down
7 changes: 3 additions & 4 deletions rosdoc2/verbs/scan/impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down