Bug 398213 - doc-update for bug 381443: new warning options
Summary: doc-update for bug 381443: new warning options
Status: RESOLVED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.3   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 4.3 RC3   Edit
Assignee: Stephan Herrmann CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2013-01-15 12:26 EST by Stephan Herrmann CLA
Modified: 2013-05-26 18:08 EDT (History)
2 users (show)

See Also:


Attachments
patch in preparation (16.04 KB, patch)
2013-05-23 15:38 EDT, Stephan Herrmann CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Stephan Herrmann CLA 2013-01-15 12:26:54 EST
Bug 381443 introduces a new option constant in JavaCore and a new command line option. Both need documenting.
Comment 1 Jay Arthanareeswaran CLA 2013-05-15 11:07:18 EDT
I guess this isn't going in yet for RC1. Resetting to 4.3.
Comment 2 Dani Megert CLA 2013-05-23 05:33:20 EDT
Stephan, time's running out.
Comment 3 Stephan Herrmann CLA 2013-05-23 09:45:46 EDT
I should have done this earlier, my apologies.

Here's a list of option constants in JavaCore introduced since Juno:
(1) null analysis:
    COMPILER_INHERIT_NULL_ANNOTATIONS
    COMPILER_PB_NONNULL_PARAMETER_ANNOTATION_DROPPED
    COMPILER_PB_SYNTACTIC_NULL_ANALYSIS_FOR_FIELDS
(2) other:
    COMPILER_PB_UNUSED_TYPE_PARAMETER

Changes regarding CLI options in class Main (new since Juno):
(3) fix for bug 375366
(4) bug 375409 (see list at bug 375409 comment 18)
(5) inheritNullAnnot, nonnullNotRepeated
(6) unusedTypeParameter, unusedTypeArgs


This is where we stand regarding documentation updates for these:
(1) planned via this bug
(2) via bug 391643
(3) via bug 375366 comment 12
(4) via bug 375409 comment 18
(5) planned via this bug
(6) via bug 353238

Furthermore this comparison reveals: I forgot to add a CLI token for
COMPILER_PB_SYNTACTIC_NULL_ANALYSIS_FOR_FIELDS
Comment 4 Stephan Herrmann CLA 2013-05-23 09:49:46 EDT
(In reply to comment #3)
> Furthermore this comparison reveals: I forgot to add a CLI token for
> COMPILER_PB_SYNTACTIC_NULL_ANALYSIS_FOR_FIELDS

I just filed bug 408815 for this.
Comment 5 Stephan Herrmann CLA 2013-05-23 09:58:12 EDT
Correction:

(In reply to comment #3)
> Changes regarding CLI options in class Main (new since Juno):
> (6) unusedTypeParameter, unusedTypeArgs
>
> This is where we stand regarding documentation updates for these:
> (6) via bug 353238

That bug only covered unusedTypeArgs.
unusedTypeParameter should be handled via bug 391643 -> reopened.
Comment 6 Stephan Herrmann CLA 2013-05-23 15:37:06 EDT
Even less to be done: documentation for inheritNullAnnot and 
COMPILER_INHERIT_NULL_ANNOTATIONS was already present via bug 388281.


On the positive side I'm preparing the following changes:

jdt_api_options.htm
- COMPILER_PB_NONNULL_PARAMETER_ANNOTATION_DROPPED
- COMPILER_PB_SYNTACTIC_NULL_ANALYSIS_FOR_FIELDS

ref-preferences-errors-warnings.htm
- cross linked with other sections

task-using_batch_compiler.htm
- nonnullNotRepeated

task-using_null_annotations.htm
- Section "Relaxing a @NonNull parameter to unspecified?"
- Section "The case of fields"


The latter section contains a paragraph intended to avoid undue expectations 
by users.
===>>> Comments to this part are particularly welcomed.
Comment 7 Stephan Herrmann CLA 2013-05-23 15:38:08 EDT
Created attachment 231414 [details]
patch in preparation

I intend to release this once RC2 is declared.

Comments welcomed.
Comment 8 Stephan Herrmann CLA 2013-05-26 18:08:32 EDT
Released for 4.3 RC3 via commit 7baaf2559f961b1c740093aaee9a631c3fe90b27