RFR: 8025856 - Fix typos in the GC code

[Jesper Wilhelmsson]

Hi Mikael,

Thanks for looking at this!

I'll change the comment in space.cpp to say ContiguousSpace as you suggested and 
I'll check with the other teams if they are OK with the changes in the non-GC 
files you listed.

As for punctuation, there is a fairly common comment style saying that if it is 
one sentence there should not be a period and if there are more than one there 
should be. Another style is to use complete sentences with period everywhere. 
I'm fine with both. I just went with the style that seemed to be dominant in the 
code. If we actively want to move towards using periods in all comments I'll be 
happy to change this.

Thanks,
/Jesper


Mikael Gerdin skrev 10/1/14 10:48 AM:
> Jesper,
>
> I've read through the entire patch. I don't necessarily agree with all your
> changes but I'm fine with them and I don't want to dig down into petty details
> :)
>
> I have one comment about correctness and one about which files you've edited,
> see inline.
>
> On Friday 10 January 2014 09.54.58 Mikael Gerdin wrote:
>> Hi Jesper,
>>
>> On Wednesday 08 January 2014 16.37.23 Jesper Wilhelmsson wrote:
>>> Hi,
>>>
>>> Anyone up for a really tedious review?
>>>
>>> This change fixes about 300 typos in comments in the GC code. There should
>>> only be changes in comments in this change.
>>>
>>> I had this out for review a while ago but it was a bit late in 8u20 to
>>> push
>>> a large change like this. I got a few comments last time that have been
>>> fixed in this new version.
>>>
>>> This new webrev is based on jdk9/hs-gc and once approved it will be
>>> backported to jdk8 (to minimize the diff between jdk8 and jdk9).
>>>
>>> Let me know if you have some change out that you want to push before I
>>> push
>>> this change. The risk of merge conflicts is high since the change touches
>>> a
>>> lot of code.
>>>
>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8025856
>>>
>>> Webrev: http://cr.openjdk.java.net/~jwilhelm/8025856/webrev.1/
>
> space.cpp:
> @@ -729,7 +729,7 @@
>     object_iterate_from(bm, blk);
>   }
>
> -// For a continguous space object_iterate() and safe_object_iterate()
> +// For a continuous space object_iterate() and safe_object_iterate()
>   // are the same.
>   void ContiguousSpace::safe_object_iterate(ObjectClosure* blk) {
>
> I think the comment here is intended to describe the class ContiguousSpace, so
> you should probably go for that spelling in the comment as well, perhaps even
> change the comment to read "For a ContiguousSpace ...".
>
> The files heap.[ch]pp, allocation.hpp, resourceArea.hpp and thread.cpp are
> arguably not GC code, so other groups may have opinions about those changes.
>
> Aside:
> heap.[ch]pp should probably be moved to the code/ subdirectory and/or renamed
> to codeHeap.
>
> /Mikael
>
>>
>> I'm in the process of reading through the patch.
>>
>> I have a question regarding punctuation in comments, for example in
>> compactibleFreeListSpace.hpp.
>> You've removed the full stop at the end of several one-line comments but
>> kept it for the multi-line comments, is there any particular reason behind
>> these changes? I remember being told to add punctuation to comments I've
>> written in the past.
>>
>> /Mikael
>>
>>> Thanks,
>>> /Jesper
>