CODETOOLS-7903567: JMH: Improve README guidance for archetype bootstrap

[abyrne133]

Attempting to execute the "mvn archetype:generate" command specified in Step 1 of Preferred Usage in the README will result in a maven execution error if you interpret it like I did! In my case I naively interpreted the following text to mean that I could create a sub project within the test folder of my already existing java project. "test" is the default test folder!

_

"Step 1. Setting up the benchmarking project. The following command will generate the new JMH-driven project in test folder:"

_

This resulted in 10-15 minutes of trying to figure out if I needed to install something new to use mvn archetype - as I have not used it before.

This change might make it easier for users to get set up with JMH project templates.

---

Progress

• Change must not contain extraneous whitespace
• Change must be properly reviewed (1 review required, with at least 1 Committer)

Issue

• CODETOOLS-7903567: JMH: Improve README guidance for archetype bootstrap (Enhancement - P4)

Reviewers

• Aleksey Shipilev (@shipilev - Committer)
• @mamadaliev (no known openjdk.org user name / role)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jmh.git pull/123/head:pull/123
$ git checkout pull/123

Update a local copy of the PR:
$ git checkout pull/123
$ git pull https://git.openjdk.org/jmh.git pull/123/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 123

View PR using the GUI difftool:
$ git pr show -t 123

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jmh/pull/123.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

Hi @abyrne133, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user abyrne133" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

[abyrne133]

/signed

[bridgekeeper]

Thank you! Please allow for up to two weeks to process your OCA, although it is usually done within one to two business days. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

[shipilev]

Thanks, have not realized this is a pitfall. Consider an edit below.

[shipilev]

Looks fine. Let's just wait for OCA to clear, after which bots would allow you to integrate.

[openjdk]

@abyrne133 This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

7903567: JMH: Improve README guidance for archetype bootstrap

Reviewed-by: shade

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 2 new commits pushed to the master branch:

• a1ca901: 7903440: JMH: Add automatic module names
• f1c7092: 7903572: JMH: mempool should capture Direct/Mapped memory pools as well

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@shipilev) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[mlbridge]

Webrevs

• 00: Full (b6f32f07)

[bridgekeeper]

@abyrne133 This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

[shipilev]

@abyrne133 Are you planning to integrate this?

[abyrne133]

@abyrne133 Are you planning to integrate this?

Hi @shipilev
It all seems to be in order. Happy for it to be merged. Let me know if anything else needed from my side and I'll sort it out.
Thanks,
Alan

[shipilev]

Say /integrate, as per bot comment :)

[abyrne133]

/integrate

[shipilev]

/sponsor

[openjdk]

@abyrne133
Your change (at version b6f32f0) is now ready to be sponsored by a Committer.

[openjdk]

Going to push as commit cb3c3a9.
Since your change was applied there have been 2 commits pushed to the master branch:

• a1ca901: 7903440: JMH: Add automatic module names
• f1c7092: 7903572: JMH: mempool should capture Direct/Mapped memory pools as well

Your commit was automatically rebased without conflicts.

[openjdk]

@shipilev @abyrne133 Pushed as commit cb3c3a9.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.