RFR: 8303923: ZipOutStream::putEntry should include an apiNote to indicate that the STORED compression method should be used when writing directory entries [v3]

[Lance Andersen]

On Sun, 19 Mar 2023 14:50:41 GMT, Eirik Bjorsnos <duke at openjdk.org> wrote:

>> ZipOutputStream currently writes directory entries using the DEFLATED compression method. This does not strictly comply with the APPNOTE.TXT specification and is also about 10x slower than using the STORED compression method.
>> 
>> Because of these concerns, `ZipOutputStream.putNextEntry` should be updated with an `@apiNote` recommending
>> the use of the STORED compression method for directory entries.
>> 
>> Suggested CSR in the first comment.
>
> Eirik Bjorsnos has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Remove speculation that using DEFLATED for directory entries is not in strict compliance with APPNOTE.txt

Thank you for making the changes.  I think this looks better.

I go back and forth as to whether to include the sentence regarding performance but I think it is OK.  Let's see if anyone else has thoughts prior to finalizing the CSR with this change

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

Marked as reviewed by lancea (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/12899#pullrequestreview-1351148686