robossembler/ros2nix
7
0
Fork 0
mirror of https://github.com/wentasah/ros2nix.git synced 2025-06-09 15:52:23 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Improve --patches documentation and regenerate README.md

Browse source
This commit is contained in:
Michal Sojka 2024-12-23 00:16:08 +01:00
parent dc3de1f289
commit 773c31d355
2 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -94,12 +94,14 @@ the [Autoware][] project as an example.
## ros2nix reference ## ros2nix reference
<!-- `$ python3 -m ros2nix --help` --> <!-- `$ python3 -m ros2nix --help` -->
``` ```
usage: ros2nix [-h] usage: ros2nix [-h]
[--output OUTPUT | --output-as-ros-pkg-name | --output-as-nix-pkg-name] [--output OUTPUT | --output-as-ros-pkg-name | --output-as-nix-pkg-name]
[--output-dir OUTPUT_DIR] [--fetch] [--distro DISTRO] [--output-dir OUTPUT_DIR] [--fetch] [--patches | --no-patches]
[--src-param SRC_PARAM] [--source-root SOURCE_ROOT] [--distro DISTRO] [--src-param SRC_PARAM]
[--do-check] [--extra-build-inputs DEP1,DEP2,...] [--source-root SOURCE_ROOT] [--do-check]
[--extra-build-inputs DEP1,DEP2,...]
[--extra-propagated-build-inputs DEP1,DEP2,...] [--extra-propagated-build-inputs DEP1,DEP2,...]
[--extra-check-inputs DEP1,DEP2,...] [--extra-check-inputs DEP1,DEP2,...]
[--extra-native-build-inputs DEP1,DEP2,...] [--flake] [--extra-native-build-inputs DEP1,DEP2,...] [--flake]
@ -132,6 +134,11 @@ options:
determined from the local git work tree. sourceRoot determined from the local git work tree. sourceRoot
attribute is set if needed and not overridden by attribute is set if needed and not overridden by
--source-root. (default: False) --source-root. (default: False)
--patches, --no-patches
Add local git commits not present in git remote named
"origin" to patches in the generated Nix expression.
Only allowed with --fetch. This option is experimental
and may be changed in the future. (default: None)
--distro DISTRO ROS distro (used as a context for evaluation of --distro DISTRO ROS distro (used as a context for evaluation of
conditions in package.xml, in the name of the Nix conditions in package.xml, in the name of the Nix
expression and in flake.nix). Note that the generated expression and in flake.nix). Note that the generated

2
ros2nix/ros2nix.py
View file

@ -250,7 +250,7 @@ def ros2nix(args):
parser.add_argument( parser.add_argument(
"--patches", "--patches",
action=argparse.BooleanOptionalAction, action=argparse.BooleanOptionalAction,
help="""Add git commits not present in git remote named "origin" as patches in the """ help="""Add local git commits not present in git remote named "origin" to patches in the """
"""generated Nix expression. Only allowed with --fetch. This option is experimental """ """generated Nix expression. Only allowed with --fetch. This option is experimental """
"""and may be changed in the future.""", """and may be changed in the future.""",
) )