Skip to content

Commit d65f4a0

Browse files
DSouzaMolyagpl
authored andcommitted
Apply suggestions from code review
Co-authored-by: Olga Gupalo <[email protected]>
1 parent 6d5b934 commit d65f4a0

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

DEVELOPING.md

+9-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
@@ -35,8 +35,8 @@ Some examples (all executed from the root of the repository):
3535
./gradlew build
3636
```
3737

38-
3938
## Debugging Plugin(s)
39+
4040
It is often useful to attach a debugger to the Gradle and Maven plugins during a project build.
4141

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

5252
## Testing Local Changes with an Existing Project
53+
5354
A common development task is to modify a plugin and then test it with an existing project.
5455

5556
To do this, first modify the project as necessary, and then build and publish the plugins:
@@ -63,6 +64,7 @@ Next, update the project build files:
6364
2. Update the list of repositories to include and prioritize the common repo.
6465

6566
### Gradle
67+
6668
Make the following changes to the build files:
6769
```bash
6870
# build.gradle
@@ -98,7 +100,8 @@ Make the following changes to the build files:
98100
Then, run the Gradle command as usual.
99101
100102
### Maven
101-
Make the following changes to pom.xml:
103+
104+
Make the following changes to _pom.xml_:
102105
```bash
103106
# pom.xml
104107
<project ...>

native-gradle-plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This plugin can be built with this command (from the root directory):
1212
./gradlew :native-gradle-plugin:publishAllPublicationsToCommonRepository --no-parallel
1313
```
1414

15-
A snapshot will be published to `build/common-repo`. For more details, see the [Developer documentation](../DEVELOPING.md).
15+
The command will publish a snapshot to `build/common-repo`. For more details, see the [Developer documentation](../DEVELOPING.md).
1616

1717
In order to run testing part of this plugin you need to get (or build) corresponding `junit-platform-native` artifact.
1818

native-maven-plugin/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ This plugin can be built with this command (from the root directory):
1212
./gradlew :native-maven-plugin:publishAllPublicationsToCommonRepository --no-parallel
1313
```
1414

15-
A snapshot will be published to `build/common-repo`. For more details, see the [Developer documentation](../DEVELOPING.md).
15+
The command will publish a snapshot to `build/common-repo`.
16+
For more details, see the [Developer documentation](../DEVELOPING.md).
17+
18+
In order to run testing part of this plugin you need to get (or build) corresponding `junit-platform-native` artifact.
1619

1720
*You can also take a look at CI workflow [here](../.github/workflows/test-native-maven-plugin.yml).*

0 commit comments

Comments
 (0)