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.

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

Merge upstream version 0.8.2 #9

Merged
merged 70 commits into from
Dec 10, 2021
Merged
Changes from 1 commit
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
071d273
Fix jobs flags handling (#655)
timonegk Feb 23, 2021
c4718f6
import cleanup (#651)
timonegk Feb 23, 2021
2e78d2f
Fix cleaning jobs flags with --no-make-args (#656)
timonegk Feb 25, 2021
3f08efd
escape whitespaces in `catkin config` printout (#657)
pseyfert Feb 25, 2021
471f223
Fixes for extending profiles (#658)
timonegk Feb 26, 2021
78a039a
remove hack (#659)
timonegk Feb 26, 2021
ea32f1c
Fix handling of invalid package.xml files (#660)
timonegk Mar 2, 2021
cca4c41
Use PYTHONASYNCIODEBUG instead of TROLLIUSDEBUG (#661)
timonegk Mar 2, 2021
5e57348
Evaluate conditional dependencies in package.xml (#662)
timonegk Mar 2, 2021
1cfdd7d
Use standard python function to determine terminal width (#653)
timonegk Mar 11, 2021
95d1a62
Fix Blank lines in build output (#666)
MatthijsBurgh Mar 17, 2021
fe1bec6
Fix shell completion install locations (#652)
timonegk Mar 19, 2021
5a133fa
Remove superfluous argument to sys.exit
timonegk Mar 19, 2021
50cc55d
Use loadavg over the last 1 minute (#668)
mobangjack Mar 23, 2021
5860b7f
Support building from a symlinked workspace (#669)
timonegk Mar 23, 2021
a3a9c97
Fix `catkin create pkg` without license parameter (#671)
timonegk Mar 24, 2021
fc555e7
Fix catkin clean --all-profiles when not at workspace root (#673)
zig-for Apr 8, 2021
3d06964
Fix placeholders for cmake warning and error coloring (#678)
timonegk Apr 19, 2021
11da5e0
Fix stdeb for python 3 (#648)
timonegk Jul 17, 2021
f5a4a0a
Regenerate setup files when the install space was cleaned (#682)
timonegk Jul 17, 2021
404ed5f
Switch from Travis CI to GitHub actions (#684)
timonegk Jul 18, 2021
cffdf51
Make it possible to clean individual packages with isolated layout (#…
timonegk Jul 18, 2021
a32d2b3
Avoid that catkin build --this can create a new workspace (#685)
timonegk Jul 18, 2021
132d8ab
Update changelog
timonegk Jul 18, 2021
7ed2ee2
catkin test: initial commit
timonegk Apr 16, 2021
53649cd
catkin test: fix output of live stdout/stderr
timonegk Apr 16, 2021
ae7d311
catkin test: split test jobs in cmake and catkin test job generators
timonegk Apr 17, 2021
fe10c71
catkin test: add CMakeMakeRunTestsIOBufferProtocol
timonegk Apr 17, 2021
bc0d186
catkin test: add some command line arguments
timonegk Apr 17, 2021
88b62d8
catkin test: add run_tests alias for backwards compatibility
timonegk Apr 17, 2021
8a8cd2b
catkin test: better output filtering
timonegk Apr 17, 2021
6d2d1b2
catkin test: add result of catkin_test_results
timonegk Apr 17, 2021
ac9eebc
catkin test: update tests
timonegk Apr 17, 2021
0f2044d
catkin test: add more options for package selection
timonegk Apr 17, 2021
2984af4
catkin test: add --continue-on-failure
timonegk Apr 17, 2021
61d4e60
catkin test: parallel execution
timonegk Apr 17, 2021
4431f5f
catkin test: add --interleave-output
timonegk Apr 17, 2021
14638bf
catkin test: add --summarize
timonegk Apr 17, 2021
056c8e4
catkin test: PEP8
timonegk Apr 17, 2021
abbc436
catkin test: show error message when unbuilt packages are requested
timonegk Apr 17, 2021
c19e43b
prevent nosetests from executing functions starting with test_ in source
timonegk Apr 17, 2021
388d5d3
add tests for catkin test
timonegk Apr 18, 2021
fe15d87
catkin test: show complete output of ctest for cmake packages
timonegk Apr 18, 2021
520ddbb
catkin test: report success when no tests exist
timonegk Apr 18, 2021
3645adf
catkin test: add option to manually specify test target
timonegk Apr 18, 2021
8f11788
catkin test: add shell completion
timonegk Apr 19, 2021
bbb4799
catkin test: add documentation
timonegk Apr 19, 2021
c4b2c7b
catkin test: fix --verbose
timonegk Apr 19, 2021
a8bc55d
catkin test: improve filtering of run_tests output
timonegk Apr 20, 2021
fc65a6b
catkin test: check for circular dependencies
timonegk Jul 18, 2021
e3f9f7c
catkin test: add --make-args
timonegk Jul 18, 2021
a3cab74
catkin test: call cmake_check_build_system before running the tests
timonegk Jul 18, 2021
142dfa1
Fix environment variable parsing (#686)
timonegk Jul 27, 2021
5d9d272
Update installation docs for python 3 (#687)
timonegk Aug 3, 2021
bbe4eff
catkin test: fix parsing of make arguments
timonegk Oct 3, 2021
0d546c2
Merge pull request #676 from catkin/catkin_test
timonegk Oct 3, 2021
e83062f
https in docs, properties over vars, sphinx cleanup (#690)
MatthijsBurgh Oct 14, 2021
9f81a46
More cleanup (#692)
MatthijsBurgh Oct 15, 2021
6895d4b
add arguments to catkin_test for backwards compatibility (#693)
timonegk Oct 15, 2021
116e203
Improve wording in documentation (#694)
balint-bg Oct 17, 2021
e8cd5a2
Add changelog of version 0.7.2
timonegk Nov 18, 2021
374febc
Added doc for custom build, devel, install dirs (#697)
jimaldon Nov 26, 2021
5163ee2
Some space fixes (#691)
MatthijsBurgh Nov 29, 2021
cd83bb1
0.8.0
timonegk Nov 29, 2021
3b4034c
test: add --limit-status-rate option (#699)
timonegk Nov 30, 2021
6d9f6fd
0.8.1
timonegk Nov 30, 2021
6f7c54d
Add back flags that were removed in #691 (#702)
timonegk Dec 1, 2021
6b78bec
update CLI documentation
timonegk Dec 1, 2021
fd856e4
0.8.2
timonegk Dec 1, 2021
7657efd
Merge tag '0.8.2' into merge/upstream/0.8.2
meyerj Dec 9, 2021
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
Prev Previous commit
Next Next commit
update CLI documentation
timonegk committed Dec 1, 2021
commit 6b78becef628a56013bd946ff1384cb5eb657aa2
10 changes: 7 additions & 3 deletions docs/verbs/cli/catkin_build.txt
Original file line number Diff line number Diff line change
@@ -3,15 +3,16 @@ usage: catkin build [-h] [--workspace WORKSPACE] [--profile PROFILE]
[--unbuilt] [--start-with PKGNAME | --start-with-this]
[--continue-on-failure] [--force-cmake] [--pre-clean]
[--no-install-lock] [--save-config] [-j JOBS]
[-p PACKAGE_JOBS] [--jobserver | --no-jobserver]
[-p PACKAGE_JOBS] [-l LOAD_AVERAGE]
[--jobserver | --no-jobserver]
[--env-cache | --no-env-cache] [--cmake-args ARG [ARG ...]
| --no-cmake-args] [--make-args ARG [ARG ...] |
--no-make-args] [--catkin-make-args ARG [ARG ...] |
--no-catkin-make-args] [--verbose] [--interleave-output]
[--no-status] [--summarize] [--no-summarize]
[--override-build-tool-check]
[--limit-status-rate LIMIT_STATUS_RATE] [--no-notify]
[PKGNAME [PKGNAME ...]]
[PKGNAME ...]

Build one or more packages in a catkin workspace. This invokes `CMake`,
`make`, and optionally `make install` for either all or the specified packages
@@ -69,6 +70,9 @@ Config:
-p PACKAGE_JOBS, --parallel-packages PACKAGE_JOBS
Maximum number of packages allowed to be built in
parallel (default is cpu count)
-l LOAD_AVERAGE, --load-average LOAD_AVERAGE
Maximum load average before no new build jobs are
scheduled
--jobserver Use the internal GNU Make job server which will limit
the number of Make jobs across all active packages.
--no-jobserver Disable the internal GNU Make job server, and use an
@@ -113,7 +117,7 @@ Interface:
--no-summarize, --no-summary
Explicitly disable the end of build summary
--override-build-tool-check
use to override failure due to using differnt build
use to override failure due to using different build
tools on the same workspace.
--limit-status-rate LIMIT_STATUS_RATE, --status-rate LIMIT_STATUS_RATE
Limit the update rate of the status bar to this
16 changes: 10 additions & 6 deletions docs/verbs/cli/catkin_clean.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
usage: catkin clean [-h] [--workspace WORKSPACE] [--profile PROFILE]
[--dry-run] [--verbose] [--yes] [--force] [--all-profiles]
[--deinit] [-l] [-b] [-d] [-i] [--this] [--dependents]
[--deinit] [-b] [-d] [-i] [-L] [--this] [--dependents]
[--orphans] [--setup-files]
[PKGNAME [PKGNAME ...]]
[PKGNAME ...]

Deletes various products of the build verb.

@@ -31,10 +31,14 @@ Full:
Spaces:
Clean workspace subdirectories for the selected profile.

-l, --logs Remove the entire log space.
-b, --build Remove the entire build space.
-d, --devel Remove the entire devel space.
-i, --install Remove the entire install space.
-b, --build, --build-space
Remove the entire build space.
-d, --devel, --devel-space
Remove the entire devel space.
-i, --install, --install-space
Remove the entire install space.
-L, --logs, --log-space
Remove the entire log space.

Packages:
Clean products from specific packages in the workspace. Note that these
24 changes: 14 additions & 10 deletions docs/verbs/cli/catkin_config.txt
Original file line number Diff line number Diff line change
@@ -6,15 +6,16 @@ usage: catkin config [-h] [--workspace WORKSPACE] [--profile PROFILE]
[--whitelist PKG [PKG ...] | --no-whitelist]
[--blacklist PKG [PKG ...] | --no-blacklist]
[--build-space BUILD_SPACE | --default-build-space]
[--log-space LOG_SPACE | --default-log-space]
[--install-space INSTALL_SPACE | --default-install-space]
[--devel-space DEVEL_SPACE | --default-devel-space]
[--install-space INSTALL_SPACE | --default-install-space]
[--log-space LOG_SPACE | --default-log-space]
[--source-space SOURCE_SPACE | --default-source-space]
[-x SPACE_SUFFIX]
[--link-devel | --merge-devel | --isolate-devel]
[--install | --no-install]
[--isolate-install | --merge-install] [-j JOBS]
[-p PACKAGE_JOBS] [--jobserver | --no-jobserver]
[-p PACKAGE_JOBS] [-l LOAD_AVERAGE]
[--jobserver | --no-jobserver]
[--env-cache | --no-env-cache]
[--cmake-args ARG [ARG ...] | --no-cmake-args]
[--make-args ARG [ARG ...] | --no-make-args]
@@ -83,17 +84,17 @@ Spaces:
The path to the build space.
--default-build-space
Use the default path to the build space ("build")
--log-space LOG_SPACE, -l LOG_SPACE
The path to the log space.
--default-log-space Use the default path to the log space ("logs")
--install-space INSTALL_SPACE, -i INSTALL_SPACE
The path to the install space.
--default-install-space
Use the default path to the install space ("install")
--devel-space DEVEL_SPACE, -d DEVEL_SPACE
The path to the devel space.
--default-devel-space
Use the default path to the devel space ("devel")
--install-space INSTALL_SPACE, -i INSTALL_SPACE
The path to the install space.
--default-install-space
Use the default path to the install space ("install")
--log-space LOG_SPACE, -L LOG_SPACE
The path to the log space.
--default-log-space Use the default path to the log space ("logs")
--source-space SOURCE_SPACE, -s SOURCE_SPACE
The path to the source space.
--default-source-space
@@ -133,6 +134,9 @@ Build Options:
-p PACKAGE_JOBS, --parallel-packages PACKAGE_JOBS
Maximum number of packages allowed to be built in
parallel (default is cpu count)
-l LOAD_AVERAGE, --load-average LOAD_AVERAGE
Maximum load average before no new build jobs are
scheduled
--jobserver Use the internal GNU Make job server which will limit
the number of Make jobs across all active packages.
--no-jobserver Disable the internal GNU Make job server, and use an
17 changes: 8 additions & 9 deletions docs/verbs/cli/catkin_create_pkg.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
usage: catkin create pkg [-h] [-p PATH] [--rosdistro ROSDISTRO]
usage: catkin create pkg [-h] [-p PATH] --rosdistro ROSDISTRO
[-v MAJOR.MINOR.PATCH] [-l LICENSE] [-m NAME EMAIL]
[-a NAME EMAIL] [-d DESCRIPTION]
[--catkin-deps [DEP [DEP ...]]]
[--system-deps [DEP [DEP ...]]]
[--boost-components [COMP [COMP ...]]]
[--catkin-deps [DEP ...]] [--system-deps [DEP ...]]
[--boost-components [COMP ...]]
PKG_NAME [PKG_NAME ...]

Create a new Catkin package. Note that while the default options used by this
command are sufficient for prototyping and local usage, it is important that
any publically-available packages have a valid license and a valid maintainer
any publicly-available packages have a valid license and a valid maintainer
e-mail address.

positional arguments:
PKG_NAME The name of one or more packages to create. This name
should be completely lower-case with individual words
separated by undercores.
separated by underscores.

optional arguments:
-h, --help show this help message and exit
@@ -41,15 +40,15 @@ Package Metadata:
Description of the package. (default: empty)

Package Dependencies:
--catkin-deps [DEP [DEP ...]], -c [DEP [DEP ...]]
--catkin-deps [DEP ...], -c [DEP ...]
The names of one or more Catkin dependencies. These
are Catkin-based packages which are either built as
source or installed by your system's package manager.
--system-deps [DEP [DEP ...]], -s [DEP [DEP ...]]
--system-deps [DEP ...], -s [DEP ...]
The names of one or more system dependencies. These
are other packages installed by your operating
system's package manager.

C++ Options:
--boost-components [COMP [COMP ...]]
--boost-components [COMP ...]
One or more boost components used by the package.
6 changes: 3 additions & 3 deletions docs/verbs/cli/catkin_env.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
usage: catkin env [-h] [-i] [-s]
[NAME=VALUE [NAME=VALUE ...]] [COMMAND] [ARG [ARG ...]]
usage: catkin env [-h] [-i] [-s] [NAME=VALUE ...] [COMMAND] [ARG ...]

Run an arbitrary command in a modified environment.

@@ -12,7 +11,8 @@ optional arguments:
-i, --ignore-environment
Start with an empty environment.
-s, --stdin Read environment variable definitions from stdin.
Variables should be given in NAME=VALUE format.
Variables should be given in NAME=VALUE format,
separated by null-bytes.

command:
COMMAND Command to run. If omitted, the environment is printed
15 changes: 7 additions & 8 deletions docs/verbs/cli/catkin_list.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
usage: catkin list [-h] [--workspace WORKSPACE] [--profile PROFILE]
[--deps | --rdeps] [--depends-on [PKG [PKG ...]]]
[--rdepends-on [PKG [PKG ...]]] [--this]
[--directory [DIRECTORY [DIRECTORY ...]]] [--quiet]
[--unformatted]
[--deps | --rdeps] [--depends-on [PKG ...]]
[--rdepends-on [PKG ...]] [--this]
[--directory [DIRECTORY ...]] [--quiet] [--unformatted]

Lists catkin packages in the workspace or other arbitray folders.
Lists catkin packages in the workspace or other arbitrary folders.

optional arguments:
-h, --help show this help message and exit
@@ -25,15 +24,15 @@ Information:
Packages:
Control which packages are listed.

--depends-on [PKG [PKG ...]]
--depends-on [PKG ...]
Only show packages that directly depend on specific
package(s).
--rdepends-on [PKG [PKG ...]], --recursive-depends-on [PKG [PKG ...]]
--rdepends-on [PKG ...], --recursive-depends-on [PKG ...]
Only show packages that recursively depend on specific
package(s).
--this Show the package which contains the current working
directory.
--directory [DIRECTORY [DIRECTORY ...]], -d [DIRECTORY [DIRECTORY ...]]
--directory [DIRECTORY ...], -d [DIRECTORY ...]
Pass list of directories process all packages in
directory

18 changes: 12 additions & 6 deletions docs/verbs/cli/catkin_locate.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
usage: catkin locate [-h] [--workspace WORKSPACE] [--profile PROFILE] [-e]
[-r] [-q] [-s | -b | -d | -i] [--this] [--shell-verbs]
[--examples]
[-r] [-q] [-b | -d | -i | -L | -s] [--this]
[--shell-verbs] [--examples]
[PACKAGE]

Get the paths to various locations in a workspace.
@@ -22,10 +22,16 @@ Sub-Space Options:
Get the absolute path to one of the following locations in the given
workspace with the given profile.

-s, --src Get the path to the source space.
-b, --build Get the path to the build space.
-d, --devel Get the path to the devel space.
-i, --install Get the path to the install space.
-b, --build, --build-space
Get the path to the build space.
-d, --devel, --devel-space
Get the path to the devel space.
-i, --install, --install-space
Get the path to the install space.
-L, --logs, --log-space
Get the path to the log space.
-s, --src, --source-space
Get the path to the source space.

Package Directories:
Get the absolute path to package directories in the given workspace and
18 changes: 11 additions & 7 deletions docs/verbs/cli/catkin_profile_add.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
usage: catkin profile add [-h] [-f] [--copy BASE_PROFILE | --copy-active] name
usage: catkin profile add [-h] [-f]
[--copy BASE_PROFILE | --copy-active | --extend PARENT_PROFILE]
name

positional arguments:
name The new profile name.
name The new profile name.

optional arguments:
-h, --help show this help message and exit
-f, --force Overwrite an existing profile.
--copy BASE_PROFILE Copy the settings from an existing profile. (default:
None)
--copy-active Copy the settings from the active profile.
-h, --help show this help message and exit
-f, --force Overwrite an existing profile.
--copy BASE_PROFILE Copy the settings from an existing profile. (default:
None)
--copy-active Copy the settings from the active profile.
--extend PARENT_PROFILE
Extend another profile
2 changes: 1 addition & 1 deletion docs/verbs/cli/catkin_profile_remove.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
usage: catkin profile remove [-h] [name [name ...]]
usage: catkin profile remove [-h] [name ...]

positional arguments:
name One or more profile names to remove.
13 changes: 9 additions & 4 deletions docs/verbs/cli/catkin_test.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
usage: catkin test [-h] [--workspace WORKSPACE] [--profile PROFILE] [--this]
[--continue-on-failure] [-p PACKAGE_JOBS] [-t TARGET]
[--catkin-test-target TARGET] [--make-args ARG [ARG ...]]
[--verbose] [--interleave-output] [--no-status]
[--summarize] [--no-notify]
[--verbose] [--interleave-output] [--summarize]
[--no-status] [--limit-status-rate LIMIT_STATUS_RATE]
[--no-notify]
[PKGNAME ...]

Test one or more packages in a catkin workspace. This invokes `make run_tests`
@@ -52,8 +53,12 @@ Interface:
--interleave-output, -i
Prevents ordering of command output when multiple
commands are running at the same time.
--no-status Suppresses status line, useful in situations where
carriage return is not properly supported.
--summarize, --summary, -s
Adds a summary to the end of the log
--no-status Suppresses status line, useful in situations where
carriage return is not properly supported.
--limit-status-rate LIMIT_STATUS_RATE, --status-rate LIMIT_STATUS_RATE
Limit the update rate of the status bar to this
frequency. Zero means unlimited. Must be positive,
default is 10 Hz.
--no-notify Suppresses system pop-up notification.