Skip to content

Commit

Permalink
Deploy: unify argparse descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
jaagut committed Jan 26, 2024
1 parent eb033c4 commit 17fd700
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions scripts/deploy/deploy_robots.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,50 +74,57 @@ def _parse_arguments(self) -> argparse.Namespace:
"--sync",
dest="only_sync",
action="store_true",
help="Only synchronize (copy) files from you to the target machine",
help="Only synchronize (copy) files from you to the target machine.",
)
parser.add_argument(
"-i",
"--install",
dest="only_install",
action="store_true",
help="Only install ROS dependencies on the target",
help="Only install ROS dependencies on the targets.",
)
parser.add_argument(
"-c", "--configure", dest="only_configure", action="store_true", help="Only configure the target machine"
"-c", "--configure", dest="only_configure", action="store_true", help="Only configure the target machines."
)
parser.add_argument(
"-b", "--build", dest="only_build", action="store_true", help="Only build on the target machine"
"-b", "--build", dest="only_build", action="store_true", help="Only build/compile on the target machines."
)
parser.add_argument(
"-l",
"--launch",
dest="only_launch",
action="store_true",
help="Only launch teamplayer software on the target",
help="Only launch teamplayer software on the targets.",
)

# Optional arguments
parser.add_argument("-p", "--package", default="", help="Synchronize and build only the given ROS package")
parser.add_argument("-p", "--package", default="", help="Synchronize and build only the given ROS package.")
parser.add_argument(
"--clean",
action="store_true",
help="Clean complete workspace (source and install, ...) before syncing and building",
help="Clean complete workspace (source and install, ...) before syncing and building.",
)
parser.add_argument("--clean-src", action="store_true", help="Clean source directory before syncing")
parser.add_argument("--clean-src", action="store_true", help="Clean source directory before syncing.")
parser.add_argument(
"--clean-build",
action="store_true",
help="Clean workspace before building. If --package is given, clean only that package",
help="Clean workspace before building. If --package is given, clean only that package.",
)
parser.add_argument("--connection-timeout", default=10, help="Timeout to establish SSH connections in seconds.")
parser.add_argument(
"--print-bit-bot", action="store_true", default=False, help="Print our logo at script start"
"--print-bit-bot", action="store_true", default=False, help="Print our logo at script start."
)
parser.add_argument("-v", "--verbose", action="count", default=0, help="More output.")
parser.add_argument("-q", "--quiet", action="count", default=0, help="Less output.")
parser.add_argument(
"-u", "--user", default="bitbots", help="The SSH user to connect to the target machines with"
)
parser.add_argument(
"-w",
"--workspace",
default="~/colcon_ws",
help="Path to the workspace directory to deploy to. Defaults to '~/colcon_ws'",
)
parser.add_argument("-v", "--verbose", action="count", default=0, help="More output")
parser.add_argument("-q", "--quiet", action="count", default=0, help="Less output")
parser.add_argument("-u", "--user", default="bitbots", help="The user to connect to the target machines with")
parser.add_argument("-w", "--workspace", default="~/colcon_ws", help="The workspace to deploy to")

args = parser.parse_args()

Expand Down

0 comments on commit 17fd700

Please sign in to comment.