Skip to content

Commit c026664

Browse files
DSouzaMolyagpl
andauthored
Apply suggestions from code review
Co-authored-by: Olga Gupalo <olga.gupalo@oracle.com>
1 parent 6e1272c commit c026664

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

DEVELOPING.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ This document describes how to set up and develop Native Build Tools on your loc
44

55
## Environment
66

7-
The project uses Gradle as its build system. At the very minimum, you should set `JAVA_HOME` to a [Gradle-compatible JDK](https://docs.gradle.org/current/userguide/compatibility.html).
7+
Start by setting `JAVA_HOME` to a [Gradle-compatible JDK (https://docs.gradle.org/current/userguide/compatibility.html).
88

99
Some build tasks require a GraalVM JDK (e.g., tests). You should set `GRAALVM_HOME` to an appropriate GraalVM JDK.
1010

1111
## IDE Setup
1212

13-
The Native Build Tools repo is set up as a multi-project Gradle project, with the Maven and Gradle plugins declared as subprojects of the root project.
14-
To set the project up in your IDE (e.g., IntelliJ IDEA), import the root project and the IDE should automatically import the subprojects.
13+
The Native Build Tools repository is structured as a Gradle multi-project, with the Maven and Gradle plugins declared as subprojects of the root project.
14+
To configure it in your IDE (e.g., IntelliJ IDEA), import the root project, and the IDE should automatically detect and include the subprojects."
1515

1616
## Building and Testing
1717

1818
You can use the various commands in the [Gradle build lifecycle](https://docs.gradle.org/current/userguide/build_lifecycle.html) to build and test the project.
19-
Some examples (all executed from the root of the repository):
19+
Some examples are (all executed from the root of the repository):
2020

2121
```bash
2222
# Compile all projects
@@ -37,6 +37,7 @@ Some examples (all executed from the root of the repository):
3737

3838

3939
## Debugging Plugin(s)
40+
4041
It is often useful to attach a debugger to the Gradle and Maven plugins during a project build.
4142

4243
For the Gradle plugin, this can be accomplished by passing debugger options to the Gradle daemon via `org.gradle.jvmargs`, for example:
@@ -50,6 +51,7 @@ The Gradle daemon will suspend on start-up, wait for you to attach a debugger, a
5051
For the Maven plugin, simply use the `mvnDebug` command in place of the `mvn` command.
5152

5253
## Testing Local Changes with an Existing Project
54+
5355
A common development task is to modify a plugin and then test it with an existing project.
5456

5557
To do this, first modify the project as necessary, and then build and publish the plugins:
@@ -62,7 +64,8 @@ Next, update the project build files:
6264
1. Update the version string. The version can be found manually by searching for the published artifacts in `build/common-repo`, or alternatively by checking the `nativeBuildTools` property [here](gradle/libs.versions.toml).
6365
2. Update the list of repositories to include and prioritize the common repo.
6466

65-
### Gradle
67+
68+
Make the following changes to the build files:
6669
Make the following changes to the build files:
6770
```bash
6871
# build.gradle
@@ -98,7 +101,8 @@ Make the following changes to the build files:
98101
Then, run the Gradle command as usual.
99102
100103
### Maven
101-
Make the following changes to pom.xml:
104+
105+
Make the following changes to _pom.xml_:
102106
```bash
103107
# pom.xml
104108
<project ...>

0 commit comments

Comments
 (0)