From e109c42515185da99281d79650322d4520373aaf Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Sun, 5 Sep 2021 17:40:54 -0700 Subject: [PATCH] [build] Rename makeSim flag to forceGazebo to better describe what it does (#3535) --- .github/workflows/gazebo.yml | 2 +- README.md | 4 ++-- simulation/frc_gazebo_plugins/README.md | 2 +- simulation/frc_gazebo_plugins/build.gradle | 4 ++-- simulation/gz_msgs/README.md | 2 +- simulation/gz_msgs/build.gradle | 4 ++-- simulation/halsim_gazebo/build.gradle | 4 ++-- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/gazebo.yml b/.github/workflows/gazebo.yml index 34a9962cf1..53948fbda0 100644 --- a/.github/workflows/gazebo.yml +++ b/.github/workflows/gazebo.yml @@ -12,4 +12,4 @@ jobs: with: fetch-depth: 0 - name: Build with Gradle - run: ./gradlew simulation:frc_gazebo_plugins:build simulation:halsim_gazebo:build -PbuildServer -PmakeSim + run: ./gradlew simulation:frc_gazebo_plugins:build simulation:halsim_gazebo:build -PbuildServer -PforceGazebo diff --git a/README.md b/README.md index bdc60b6088..b783674311 100644 --- a/README.md +++ b/README.md @@ -95,10 +95,10 @@ If you have installed the FRC Toolchain to a directory other than the default, o ### Gazebo simulation -If you also want simulation to be built, add -PmakeSim. This requires gazebo_transport. We have tested on 14.04 and 15.05, but any correct install of Gazebo should work, even on Windows if you build Gazebo from source. Correct means CMake needs to be able to find gazebo-config.cmake. See [The Gazebo website](https://gazebosim.org/) for installation instructions. +If you also want to force building Gazebo simulation support, add -PforceGazebo. This requires gazebo_transport. We have tested on 14.04 and 15.05, but any correct install of Gazebo should work, even on Windows if you build Gazebo from source. Correct means CMake needs to be able to find gazebo-config.cmake. See [The Gazebo website](https://gazebosim.org/) for installation instructions. ```bash -./gradlew build -PmakeSim +./gradlew build -PforceGazebo ``` If you prefer to use CMake directly, the you can still do so. diff --git a/simulation/frc_gazebo_plugins/README.md b/simulation/frc_gazebo_plugins/README.md index 4a5a59a3d5..b89bbc52df 100644 --- a/simulation/frc_gazebo_plugins/README.md +++ b/simulation/frc_gazebo_plugins/README.md @@ -13,7 +13,7 @@ if those requirements are not met. This command: - `./gradlew build -PmakeSim` + `./gradlew build -PforceGazebo` will force it to attempt to build. diff --git a/simulation/frc_gazebo_plugins/build.gradle b/simulation/frc_gazebo_plugins/build.gradle index 8240962767..f42b70bf88 100644 --- a/simulation/frc_gazebo_plugins/build.gradle +++ b/simulation/frc_gazebo_plugins/build.gradle @@ -21,10 +21,10 @@ try { gazebo_linker_args = "pkg-config --libs gazebo protobuf".execute().text.split() } catch(Exception ex) { } -if (project.hasProperty("makeSim")) { +if (project.hasProperty("forceGazebo")) { if (!gazebo_version?.trim()) { println "Gazebo development files are not available. (pkg-config --modversion gazebo failed)" - println "makeSim set. Forcing build - failure likely." + println "forceGazebo set. Forcing build - failure likely." } } else { ext.skip_frc_plugins = true diff --git a/simulation/gz_msgs/README.md b/simulation/gz_msgs/README.md index 7df7a79d83..6850be7e56 100644 --- a/simulation/gz_msgs/README.md +++ b/simulation/gz_msgs/README.md @@ -7,6 +7,6 @@ gz_msgs currently requires libprotobuf-dev on Debian like systems. If it's not found via pkg-config, then it's build is diabled. -You can force it by specifying -PmakeSim on the gradle command line. +You can force it by specifying -PforceGazebo on the gradle command line. If you are installing FRCSim with the script, then this *should* have be done for you. diff --git a/simulation/gz_msgs/build.gradle b/simulation/gz_msgs/build.gradle index 22b6068f72..6b67f29ee5 100644 --- a/simulation/gz_msgs/build.gradle +++ b/simulation/gz_msgs/build.gradle @@ -24,10 +24,10 @@ try { } catch(Exception ex) { } -if (project.hasProperty("makeSim")) { +if (project.hasProperty("forceGazebo")) { if (!protobuf_version?.trim()) { println "Protobuf is not available. (pkg-config --modversion protobuf failed)" - println "makeSim set. Forcing build - failure likely." + println "forceGazebo set. Forcing build - failure likely." } } else { ext.skip_gz_msgs = true diff --git a/simulation/halsim_gazebo/build.gradle b/simulation/halsim_gazebo/build.gradle index 55a3597212..8d340d38c7 100644 --- a/simulation/halsim_gazebo/build.gradle +++ b/simulation/halsim_gazebo/build.gradle @@ -19,10 +19,10 @@ try { gazebo_linker_args = "pkg-config --libs gazebo protobuf".execute().text.split() } catch(Exception ex) { } -if (project.hasProperty("makeSim")) { +if (project.hasProperty("forceGazebo")) { if (!gazebo_version?.trim()) { println "Gazebo development files are not available. (pkg-config --modversion gazebo failed)" - println "makeSim set. Forcing build - failure likely." + println "forceGazebo set. Forcing build - failure likely." } } else { ext.skip_frc_plugins = true