From: mwebster Date: Thu, 26 Oct 2006 17:23:50 +0000 (+0000) Subject: Bug 159854 "Problem Diagnosis Guide" (skeleton) X-Git-Tag: V1_5_3rc1~19 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a4d46605ca5acf6be6485e079a368afa67d5de80;p=aspectj.git Bug 159854 "Problem Diagnosis Guide" (skeleton) --- diff --git a/docs/build.xml b/docs/build.xml index b053c1bd6..903ed6ff8 100644 --- a/docs/build.xml +++ b/docs/build.xml @@ -203,7 +203,7 @@ @@ -321,6 +321,28 @@ + + + + + + + + + + + + + + + + Quick Reference (AspectJ 5), Quick Reference (1.2.1), AspectJ 5 Developer's Notebook, - programming and - development guides, + programming, + development and + problem diagnosis guides, API and example code. @@ -111,6 +112,17 @@ + Problem Diagnosis Guide +
+ + (printable html) + + This has a guide to + the various features available such as message and trace to help you both solve problems + with you own programs and report bugs to the AspectJ team. + + + AspectJ API API documentation for AspectJ runtime classes. JoinPoint diff --git a/docs/pdGuideDB/ajcore.xml b/docs/pdGuideDB/ajcore.xml new file mode 100644 index 000000000..c78ce85e3 --- /dev/null +++ b/docs/pdGuideDB/ajcore.xml @@ -0,0 +1,15 @@ + + AspectJ Core Files + + + Introduction + + When the compiler terminates abnormally, either because an abort message was + issued or an exception was thrown, a AspectJ core file will be produced. You will + find it the working directory of the compiler and will have a name that contains + the date and time that the file was produced + e.g. ajcore.20060810.173655.626.txt. + + + + diff --git a/docs/pdGuideDB/ltwdump.xml b/docs/pdGuideDB/ltwdump.xml new file mode 100644 index 000000000..99240965a --- /dev/null +++ b/docs/pdGuideDB/ltwdump.xml @@ -0,0 +1,11 @@ + + LTW Dump + + + Introduction + + Occasionally problems may be encountered with classes that have been load-time woven. Symptoms will + include incorrect program function or a Java exception such as + java.lang.VerifyError. + + diff --git a/docs/pdGuideDB/messages.xml b/docs/pdGuideDB/messages.xml new file mode 100644 index 000000000..96512d362 --- /dev/null +++ b/docs/pdGuideDB/messages.xml @@ -0,0 +1,10 @@ + + Messages + + + Introduction + + By default only warning and error messages are issued by the compiler whether it is + being used for source code compilation, weaving, binary weaving or load-time weaving. + + diff --git a/docs/pdGuideDB/pdguide.xml b/docs/pdGuideDB/pdguide.xml new file mode 100644 index 000000000..2090cb6cb --- /dev/null +++ b/docs/pdGuideDB/pdguide.xml @@ -0,0 +1,44 @@ + + + + + + +]> + + + + The AspectJ<superscript>tm</superscript> Problem Diagnosis Guide + + + + the AspectJ Team + + + + + Copyright (c) 2006 IBM Corporation and others. + 2006 Contributors. + All rights reserved. + + + + + + This guide describes how to gather and interpret information from the AspectJ compiler + to when diagnsoing problems in AspectJ programs, configuring the load-time weaving + framework or reporting bugs on Bugzilla. + + + + + &messages; + &ajcore; + &trace; + <wdump; + + + diff --git a/docs/pdGuideDB/trace.xml b/docs/pdGuideDB/trace.xml new file mode 100644 index 000000000..49f642444 --- /dev/null +++ b/docs/pdGuideDB/trace.xml @@ -0,0 +1,15 @@ + + Trace + + + Introduction + + The usual approach to opening a report on Bugzilla is to describe the symptoms of the + problem and attach a simple testcase. This allows the AspectJ team to try and reproduce the problem in + an attempt to fix it as well as improve the test suite. Unfortunately it may not be possible + to produce such a testcase either because your program is too large or is comercially sensitive. Alternatively + the problem may relate to your specific environment where AspectJ is being used and will not be + reproducible by the AspectJ team. In one of these situations you may be asked to produce a + trace of the compiler when the problem occurs instead. This can then be attached to the bug report. + +