Bug 190960 - [batch][compiler] help message for annotations processing should be improved
Summary: [batch][compiler] help message for annotations processing should be improved
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: 3.4 M1   Edit
Assignee: Olivier Thomann CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-06-05 02:30 EDT by Maxime Daniel CLA
Modified: 2007-08-07 06:02 EDT (History)
2 users (show)

See Also:


Attachments
Proposed fix (2.84 KB, patch)
2007-06-05 13:19 EDT, Olivier Thomann CLA
no flags Details | Diff
updated patch (2.88 KB, patch)
2007-06-05 18:23 EDT, Walter Harley CLA
no flags Details | Diff
Updated patch + regression tests (8.35 KB, patch)
2007-06-05 18:42 EDT, Olivier Thomann CLA
no flags Details | Diff
Proposed fix + regression test (7.00 KB, patch)
2007-07-09 11:24 EDT, Olivier Thomann CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Maxime Daniel CLA 2007-06-05 02:30:44 EDT
Source based, v_769.

The help message reads as follows for its annotations processing part (added line numbers):
1 \ Annotation processing options:\n\
2 \   These options are meaningful only in a 1.6 environment.\n\
3 \    -Akey[=value]        annotation processors options that are made to\n\
4 \                         annotation processors. key are identifiers separated\n\
5 \                         by ''.''.\n\
6 \    -processorpath <directories and zip/jar files separated by {0}>\n\
7 \                         specify locations where to find annotation processors\n\
8 \                         If this option is not used, the classpath will be\n\
9 \                         searched for processors.\n\
10 \    -processor <class1[,class2,...]>\n\
11 \                         Qualified names of the annotation processors to run.\n\
12 \                         This bypasses the default annotation discovery process\n\
13 \    -proc:only           run annotation processors, but do not compile\n\
14 \    -proc:none           perform compilation but do not run annotation\n\
15 \                         processors\n\
16 \    -s <dir>             specify a directory where to put the generated source\n\
17 \                         files\n\
18 \    -XprintProcessorInfo print information about which annotations and which\n\
19 \                         elements a processor is asked to process\n\
20 \    -XprintRounds        print information about annotation processing rounds.\n\
21 \    -classNames <className1[,className2,...]>\n\
22 \                         Qualified names of the classes that need\n\
23 \                         to be processed\n\

Remarks and suggestions:
- line 3 is incorrect; suggest to add 'available' so as to get 'made available to';
- line 4 'key are' is a singular/plural mismatch; would suggest 'key is made of', or 'key is a suite of';
- line 19 would suggest using the simpler 'a processor processes';
- lines 22-23: I do not quite get what happens exactly here; are other classes compiled or not? how does that play along with other options?
- the use of capital letters and dots is not consistent across the help message; my guess would be that we only use capital letters following a dot, and that we use dots only in between sentences; this would lead to line 22 starting with 'qualified', line 9 not ending with a dot, etc.
Comment 1 Olivier Thomann CLA 2007-06-05 13:19:57 EDT
Created attachment 70176 [details]
Proposed fix
Comment 2 Walter Harley CLA 2007-06-05 18:23:18 EDT
Created attachment 70245 [details]
updated patch

Here's my version of the proposed patch; in addition to correcting typos I tried to clarify the text a bit.
Comment 3 Olivier Thomann CLA 2007-06-05 18:42:57 EDT
Created attachment 70251 [details]
Updated patch + regression tests

Walter's patch + corresponding regression tests updated
Comment 4 Olivier Thomann CLA 2007-06-05 21:32:39 EDT
All tests passed with this patch.
Comment 5 Olivier Thomann CLA 2007-06-06 11:59:09 EDT
Closing as WONTFIX since this won't go in for 3.3 and the whole print usage should be reorganized for 3.4.
Comment 6 Jerome Lanneluc CLA 2007-06-06 12:23:42 EDT
Even if print usage is rewritten, we should not loose the suggestions included in this bug.
Comment 7 Olivier Thomann CLA 2007-06-06 15:23:34 EDT
Updated batch compiler tests also passed on Linux.
Comment 8 Olivier Thomann CLA 2007-06-07 10:13:33 EDT
If this doesn't make it for 3.3, I'll release it for 3.3.1. It doesn't affect translations (in fact actual code might make the translation more difficult since some sentences are not very clear) since it is only a rephrasing of the English sentences. The meaning is similar.
Comment 9 Olivier Thomann CLA 2007-07-09 11:24:47 EDT
Created attachment 73337 [details]
Proposed fix + regression test

Same patch, but without the change in the print usage for the warnings. I thought it was over the 80 character limit, but it just fits in. So no need for this change.
Only the rewording of the annotation processing help is required.
Comment 10 Olivier Thomann CLA 2007-07-09 11:27:27 EDT
Released for 3.4M1.
Updated the regression tests inside BatchCompilerTests.

Might want to backport to 3.3.1 in order to clarify the annotation processing options.
Comment 11 Frederic Fusier CLA 2007-08-07 06:02:49 EDT
Verified for 3.4M1 using build I20070806-1800.