diff options
Diffstat (limited to 'docs/pdGuideDB/messages.xml')
| -rw-r--r-- | docs/pdGuideDB/messages.xml | 126 |
1 files changed, 63 insertions, 63 deletions
diff --git a/docs/pdGuideDB/messages.xml b/docs/pdGuideDB/messages.xml index 8d2a2ab97..9d2caf0b5 100644 --- a/docs/pdGuideDB/messages.xml +++ b/docs/pdGuideDB/messages.xml @@ -1,6 +1,6 @@ <chapter id="messages" xreflabel="Messages"> <title>Messages</title> - + <sect1 id="messages-introduction"> <title>Introduction</title> <para> @@ -11,47 +11,47 @@ which are hidden. However, when investigating unexpected behavior it's helpful to show them. This section describes how to configure messages, presents some problem scenarios when - compiling or doing load-time weaving, and summarizes some of the + compiling or doing load-time weaving, and summarizes some of the more relevant messages. </para> - <sect2 id="messages-introduction-config" + <sect2 id="messages-introduction-config" xreflabel="messages-configuration"> <title>Configuring Messages</title> <para> - The compiler offers <literal>-verbose</literal>, - <literal>-warning</literal>, and <literal>-XLint</literal> options - when invoked using the command-line, Ant, or embedded in an IDE. - All options are listed in the AspectJ Development Environment Guide - sections for - <ulink url="../devguide/ajc-ref.html">Ajc</ulink> and + The compiler offers <literal>-verbose</literal>, + <literal>-warning</literal>, and <literal>-XLint</literal> options + when invoked using the command-line, Ant, or embedded in an IDE. + All options are listed in the AspectJ Development Environment Guide + sections for + <ulink url="../devguide/ajc-ref.html">Ajc</ulink> and <ulink url="../devguide/antTasks-iajc.html">Ant Tasks</ulink>. - The <ulink url="../devguide/ltw.html">Load-time Weaving</ulink> + The <ulink url="../devguide/ltw.html">Load-time Weaving</ulink> section describes how to use XML configuration files and system properties to pass options to the weaver. (You can also pass options to the weaver using system properties in build- - time weaving.) + time weaving.) The <literal>-verbose</literal> option has the effect of including messages level "info", which are normally ignored. Both <literal>warning</literal> and <literal>XLint</literal> - enable you to identify specific messages to emit, but warning - messages tend to be the same provided by the underlying Eclipse - JDT (Java) compiler, while XLint messages are emitted by the + enable you to identify specific messages to emit, but warning + messages tend to be the same provided by the underlying Eclipse + JDT (Java) compiler, while XLint messages are emitted by the AspectJ compiler or weaver. Obviously, during load-time weaving only weaver messages will be emitted. Similarly, if aspects are compiled but not woven, then only compiler messages will be emitted. However, the usual case for the compiler/weaver working at build time is to emit both compiler and weaver messages. </para> - - <para> The tables below list some options, System Properties (for LTW only) and Java 5 annotations + + <para> The tables below list some options, System Properties (for LTW only) and Java 5 annotations used to control AspectJ messages. The method - of configuration depends on your environment so please refer to the relevant - documentation for - <ulink url="../devguide/ajc-ref.html">ajc</ulink>, - <ulink url="../devguide/antTasks.html">Ant</ulink> or - <ulink url="../devguide/ltw-configuration.html#weaver-options">LTW</ulink>. + of configuration depends on your environment so please refer to the relevant + documentation for + <ulink url="../devguide/ajc-ref.html">ajc</ulink>, + <ulink url="../devguide/antTasks.html">Ant</ulink> or + <ulink url="../devguide/ltw-configuration.html#weaver-options">LTW</ulink>. </para> - + <para> <informaltable> <tgroup cols="2"> @@ -105,15 +105,15 @@ </entry> <entry> In Ant tasks and LTW respectively specify the class to receive all messages. - See + See <ulink url="../devguide/antTasks-iajc.html#antTasks-iajc-options"> iajc task options</ulink> or <ulink url="../devguide/ltw-configuration.html#weaver-options"> Weaver Options</ulink>. </entry> </row> - -<!-- We need full javadoc for this API + +<!-- We need full javadoc for this API <row> <entry> <literal>org.aspectj.tools.Main.setMessageHolder(..)</literal> @@ -123,7 +123,7 @@ outside of Ant. </entry> </row> ---> +--> </tbody> </tgroup> </informaltable> @@ -144,7 +144,7 @@ <literal>aj.weaving.verbose</literal> </entry> <entry> - Show informational messages including AspectJ version and build date + Show informational messages including AspectJ version and build date (same as <literal>-verbose</literal> option). </entry> </row> @@ -162,7 +162,7 @@ <literal>org.aspectj.weaving.messages</literal> </entry> <entry> - Set this system property to enable tracing of all compiler + Set this system property to enable tracing of all compiler messages. See <xref linkend="trace-configuration"/>. </entry> </row> @@ -170,7 +170,7 @@ </tgroup> </informaltable> </para> - + <para> <informaltable> <tgroup cols="2"> @@ -194,39 +194,39 @@ </tgroup> </informaltable> </para> - - </sect2> - </sect1> + + </sect2> + </sect1> <sect1 id="messages-scenarios"> <title>Message scenarios</title> - + <sect2 id="messages-scenarios-ct"> <title>Compile-time weaving scenarios</title> <sect3 id="messages-scenarios-ct-adviceNotWoven"> <title>Advice not woven</title> <para>This means that the pointcut for the advice did not match, - and it should be debugged as described in + and it should be debugged as described in <xref linkend="pointcuts"/>.</para> </sect3> </sect2> - + <sect2 id="messages-scenarios-ltw"> <title>Load-time weaving scenarios</title> - + <para> You can use <literal>META-INF/aop.xml</literal> to control which messages are produced during LTW. The following example will produce basic informational messages about the lifecyle of the weaver in addition to any warning or error messages. </para> <programlisting><![CDATA[ - <aspectj> - <weaver options="-verbose"> - </weaver> - </aspectj> - ]]></programlisting> - - <para>The messages indicate which <literal>META-INF/aop.xml</literal> - configurations file(s) are being used. Each message is also preceeded by the +<aspectj> + <weaver options="-verbose"> + </weaver> +</aspectj> +]]></programlisting> + + <para>The messages indicate which <literal>META-INF/aop.xml</literal> + configurations file(s) are being used. Each message is also preceeded by the name of the defining class loader associated with weaver. You can use this information in a large system to distinguish between different applications each of which will typically have its own class loader. </para> @@ -238,25 +238,25 @@ [AppClassLoader@92e78c] info using configuration /C:/temp/META-INF/aop-ajc.xml [AppClassLoader@92e78c] info register aspect ExceptionHandler [AppClassLoader@92e78c] info processing reweavable type ExceptionHandler: ExceptionHandler.aj - ]]></programlisting> - +]]></programlisting> + <sect3 id="messages-scenarios-ltw-adviceNotWoven"> <title>Advice not woven</title> <para> It is often difficult to determine, especially when using load-time weaving (LTW), why advice has not been woven. Here is a quick guide to the messages to - look for. Firstly if you use the <literal>-verbose</literal> option you + look for. Firstly if you use the <literal>-verbose</literal> option you should see the following message when your aspect is registered: </para> <programlisting><![CDATA[ - info register aspect MyAspect - ]]></programlisting> +info register aspect MyAspect +]]></programlisting> - <para> Secondly if you use the <literal>-debug</literal> option you should + <para> Secondly if you use the <literal>-debug</literal> option you should see a message indicating that you class is being woven: </para> <programlisting><![CDATA[ - debug weaving 'HelloWorld' - ]]></programlisting> +debug weaving 'HelloWorld' +]]></programlisting> <para> However this does not mean that advice has actually been woven into your class; it says that the class has been passed to the weaver. To determine @@ -264,18 +264,18 @@ option which will cause a message to be issued each time a join point is woven: </para> <programlisting><![CDATA[ - weaveinfo Join point 'method-execution(void HelloWorld.main(java.lang.String[]))' ... - ]]></programlisting> - - <para>If advice is woven at this join point you should get the +weaveinfo Join point 'method-execution(void HelloWorld.main(java.lang.String[]))' ... +]]></programlisting> + + <para>If advice is woven at this join point you should get the corresponding message.</para> </sect3> </sect2> </sect1> - + <sect1 id="messages-xlint"> <title>Lint messages</title> - <para> + <para> The table below lists some useful <literal>-Xlint</literal> messages. </para> <informaltable> <tgroup cols="3"> @@ -297,8 +297,8 @@ <entry> If an aspect is not being woven, despite being registered, it could be that it has been excluded - by either an <literal>include</literal> or <literal>exclude</literal> - element in the + by either an <literal>include</literal> or <literal>exclude</literal> + element in the <literal>aspects</literal> section of <literal>META-INF/aop.xml</literal>. Enable this message to determine whether an aspect has been excluded. @@ -314,7 +314,7 @@ <entry> Issued when advice did not potentially affect any join points. This means the corresponding pointcut did not match any join - points in the program. This may be valid e.g., in library + points in the program. This may be valid e.g., in library aspects or code picking up error conditions, but often the programmer simply made a mistake in the pointcut. The best approach is to debug the pointcut. @@ -356,7 +356,7 @@ </entry> <entry> Before AspectJ 5, declare soft used to soften runtime exceptions - (unnecessarily). Since then, it does not but does issue this + (unnecessarily). Since then, it does not but does issue this warning in case the programmer did intend for the exception to be wrapped. </entry> @@ -381,5 +381,5 @@ </tgroup> </informaltable> </sect1> - + </chapter> |