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

[Aleksey Shipilev]

On Sat, 30 Sep 2023 16:18:51 GMT, abyrne133 <duke at openjdk.org> wrote:

> 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.

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

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

Marked as reviewed by shade (Committer).

Marked as reviewed by shade (Committer).

README.md line 28:

> 26: ### Preferred Usage: Command Line
> 27: 
> 28: **Step 1. Setting up the benchmarking project.** The following command will generate the new JMH-driven project in new test folder. Note that current and target folder should not already contain any Maven project for this to work reliably.

Ah wait, a little nit: `test` used to be markdown-ed.

README.md line 29:

> 27: 
> 28: **Step 1. Setting up the benchmarking project.** The following command will generate the new JMH-driven
> 29: project in `test` folder (do not try to run the command within an already existing maven project):

Would this be more understandable?

"The following command will generate the new JMH-driven project in new `test` folder. Note that current and target folder should not already contain any Maven project for this to work reliably."

-------------

PR Review: https://git.openjdk.org/jmh/pull/123#pullrequestreview-1652363175
Marked as reviewed by shade (Committer).

PR Review: https://git.openjdk.org/jmh/pull/123#pullrequestreview-1652879061
PR Review: https://git.openjdk.org/jmh/pull/123#pullrequestreview-1652880805
PR Review: https://git.openjdk.org/jmh/pull/123#pullrequestreview-1652966895
PR Review Comment: https://git.openjdk.org/jmh/pull/123#discussion_r1342772725
PR Review Comment: https://git.openjdk.org/jmh/pull/123#discussion_r1342443185