RFR: 8251888: Move HotSpot Style Guide wiki subpages to jdk/jdk/doc

[David Holmes]

On 18/08/2020 3:55 am, Igor Ignatyev wrote:
>> On Aug 17, 2020, at 10:22 AM, Vladimir Kozlov <vladimir.kozlov at oracle.com> wrote:
>>
>> Hi Kim,
>>
>> Looks good to me.
> +1
>>
>> On 8/17/20 3:32 AM, Kim Barrett wrote:
>>> Please review this followup to JDK-8247976 [1], rehoming the information
>>> from two subpages of the wiki Style Guide to jdk/jdk/doc.
>>> The "Naming HotSpot JTReg Tests" wiki page has been summarized as an
>>> additional small section in the HotSpot Style Guide.
>>
>> I think we (in Compiler group at least) also have rules to specify package for each jtreg test to match sub-directories they are in:
>> http://hg.openjdk.java.net/jdk/jdk/file/35dc23e2705a/test/hotspot/jtreg/compiler/allocation/TestAllocation.java#l34
>>
>> Someone from SQE need to comment about this if it is requirement.
> it's not a requirement per se, it's rather a guideline that make it easier to use an IDE to work w/ tests. there are however tests (even in compiler) which don't follow this and don't have package statement. in any case, Kim's RFR is for migration of the docs as-is, thus if we are to add this piece, it should be handled separately.

Agreed. FWIW putting tests in packages is an unnecessary encumberance 
IMO (and no I never use an IDE so ...). It makes it hard to run tests 
manually and harder for tests that want to switch out versions of 
classes at runtimes by changing classpath. I've been advocating removing 
unneccessary package use in our tests when I see them.

Cheers,
David


> -- Igor
> 
>>
>> Thanks,
>> Vladimir K
>>
>>> The "Native/Unit Test Development Guidelines" has been transferred wholesale
>>> to a new file: jdk/jdk/doc/hotspot-unit-tests.{md,html}. This transfer was
>>> accomplished by cut-and-paste of the wiki page content to the new file, then
>>> adding markdown annotations corresponding to the wiki page's formatting.  No
>>> significant modifications were made to the text, not even to correct typos
>>> and other errors that seem obvious.  I want to get the file in place before
>>> doing any updates to the content.
>>> [1] https://bugs.openjdk.java.net/browse/JDK-8247976
>>> I think this change doesn't modify the Style Guide in any substantive way,
>>> so I think a simple review is sufficient, rather than needing to gather
>>> consensus for the change from the Group Members.
>>> Once this change is pushed I'll update the wiki pages to note they are
>>> obsolete and provide a forwarding pointer.
>>> CR:
>>> https://bugs.openjdk.java.net/browse/JDK-8251888
>>> Webrev:
>>> https://cr.openjdk.java.net/~kbarrett/8251888/open.00/
>