Skip to content

Commit

Permalink
Update gradle tasks (#2456)
Browse files Browse the repository at this point in the history
Fixes #2431
  • Loading branch information
sciencewhiz authored Jan 8, 2024
1 parent 10b878f commit 57fb982
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions source/docs/software/advanced-gradlerio/gradlew-tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ Build tasks
-----------

``./gradlew build`` - Assembles and tests this project. Useful for prebuilding your project without deploying to the roboRIO.

``./gradlew clean`` - Deletes the build directory.

CompileCommands tasks
---------------------

``./gradlew generateCompileCommands`` - Generate compile_commands.json. This is a configuration file that is supported by many Integrated Development Environments.
``./gradlew generateCompileCommands`` - Generate compile_commands.json for C++ programs. This is a configuration file that is supported by many Integrated Development Environments and build tools.

EmbeddedTools tasks
DeployUtils tasks
-------------------

``./gradlew deploy`` - Deploy all artifacts on all targets. This will deploy your robot project to the available targets (IE, roboRIO).
Expand All @@ -24,17 +25,15 @@ EmbeddedTools tasks
GradleRIO tasks
---------------

``./gradlew downloadAll`` - Download all dependencies that may be used by this project

``./gradlew $TOOL$`` - Runs the tool ``$TOOL$`` (Replace ``$TOOL$`` with the name of the tool. IE, Glass, Shuffleboard, etc)

``./gradlew $TOOL$Install`` - Installs the tool ``$TOOL$`` (Replace ``$TOOL$`` with the name of the tool. IE, Glass, Shuffleboard, etc)
``./gradlew $TOOL$Install`` - Installs the java tool ``$TOOL$`` (Replace ``$TOOL$`` with the name of the tool. IE, Shuffleboard, SmartDashboard, etc)

``./gradlew InstallAllTools`` - Installs all available tools. This excludes the development environment such as Visual Studio Code. It's the users requirement to ensure the required dependencies (Java) is installed. Only recommended for advanced users!

``./gradlew simulateExternalCpp`` - Simulate External Task for native executable. Exports a JSON file for use by editors / tools
``./gradlew simulateExternalNativeRelease`` - Simulate External Task for native executable. Exports a JSON file for use by editors / tools

``./gradlew simulateExternalJava`` - Simulate External Task for Java/Kotlin/JVM. Exports a JSON file for use by editors / tools
``./gradlew simulateExternalJavaRelease`` - Simulate External Task for Java/Kotlin/JVM. Exports a JSON file for use by editors / tools

``./gradlew simulateJava`` - Launches simulation for the Java projects

Expand Down

0 comments on commit 57fb982

Please sign in to comment.