2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2001-04-04 12:03:46 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Recorder Task</title>
|
2001-04-04 12:03:46 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="log">Record</h2>
|
2001-04-04 12:03:46 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>A recorder is a listener to the current build process that records the output to a file.</p>
|
2001-04-04 12:03:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Several recorders can exist at the same time. Each recorder is associated with a file. The
|
|
|
|
|
filename is used as a unique identifier for the recorders. The first call to
|
|
|
|
|
the <code>record</code> task with an unused filename will create a recorder (using the parameters
|
|
|
|
|
provided) and add it to the listeners of the build. All subsequent calls to the <code>record</code>
|
|
|
|
|
task using this filename will modify that recorder's state (recording or not) or other properties
|
|
|
|
|
(like logging level).</p>
|
2001-04-04 12:03:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Some technical issues: the file's print stream is flushed for <q>finished</q> events
|
|
|
|
|
(<q>buildFinished</q>, <q>targetFinished</q> and <q>taskFinished</q>), and is closed on
|
|
|
|
|
a <q>buildFinished</q> event.</p>
|
2001-04-04 12:03:46 +00:00
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-04-04 12:03:46 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>name</td>
|
|
|
|
|
<td>The name of the file this logger is associated with.</td>
|
|
|
|
|
<td>Yes</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>action</td>
|
|
|
|
|
<td>This tells the logger what to do: should it start recording or stop? The first time that
|
|
|
|
|
the recorder task is called for this logfile, and if this attribute is not provided, then the
|
|
|
|
|
default for this attribute is <q>start</q>. If this attribute is not provided on subsequent
|
|
|
|
|
calls, then the state remains as previous.</td>
|
|
|
|
|
<td>No [values = <q>start|stop</q>, default = no state change]</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>append</td>
|
|
|
|
|
<td>Should the recorder append to a file, or create a new one? This is only applicable the first
|
2018-03-10 20:17:33 +01:00
|
|
|
time this task is called for this file.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No [values = <q>start|stop</q>, default = no state change]</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
2002-04-12 09:35:39 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>emacsmode</td>
|
2018-03-10 20:17:33 +01:00
|
|
|
<td>Removes <code>[task]</code> banners like Apache Ant's <kbd>-emacs</kbd> command line
|
2018-02-28 07:58:59 +01:00
|
|
|
switch if set to <q>true</q>.</td>
|
|
|
|
|
<td>No; default is <q>false</q></td>
|
2002-04-12 09:35:39 +00:00
|
|
|
</tr>
|
2001-04-04 12:03:46 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>loglevel</td>
|
|
|
|
|
<td>At what logging level should this recorder instance record to? This is not a once only
|
|
|
|
|
parameter (like <var>append</var> is)—you can increase or decrease the logging level as
|
|
|
|
|
the build process continues.
|
2001-04-04 12:03:46 +00:00
|
|
|
</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No [values = <q>error|warn|info|verbose|debug</q>, default = no change]</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h3>Examples</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The following <samp>build.xml</samp> snippet is an example of how to use the recorder to record
|
|
|
|
|
just the <code><javac></code> task:</p>
|
2001-04-04 12:03:46 +00:00
|
|
|
<pre>
|
|
|
|
|
...
|
|
|
|
|
<compile >
|
2002-09-04 11:05:19 +00:00
|
|
|
<record name="log.txt" action="start"/>
|
2001-04-04 12:03:46 +00:00
|
|
|
<javac ...
|
2002-09-04 11:05:19 +00:00
|
|
|
<record name="log.txt" action="stop"/>
|
2001-04-04 12:03:46 +00:00
|
|
|
<compile/>
|
|
|
|
|
...
|
|
|
|
|
</pre>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The following two calls to <code><record></code> set up two recorders: one to
|
|
|
|
|
file <samp>records-simple.log</samp> at logging level <q>info</q> (the default) and one to
|
|
|
|
|
file <samp>ISO.log</samp> using logging level of <q>verbose</q>.</p>
|
2001-04-04 12:03:46 +00:00
|
|
|
<pre>
|
|
|
|
|
...
|
2002-09-04 11:05:19 +00:00
|
|
|
<record name="records-simple.log"/>
|
|
|
|
|
<record name="ISO.log" loglevel="verbose"/>
|
2001-04-04 12:03:46 +00:00
|
|
|
...
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<h3>Notes</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>There is some functionality that I would like to be able to add in the future. They include
|
|
|
|
|
things like the following:</p>
|
|
|
|
|
<table class="attr">
|
2001-04-04 12:03:46 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>listener</td>
|
|
|
|
|
<td>A classname of a build listener to use from this point on instead of the default
|
|
|
|
|
listener.</td>
|
|
|
|
|
<td>No</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>includetarget</td>
|
|
|
|
|
<td rowspan="2">A comma-separated list of targets to automatically record. If this value
|
|
|
|
|
is <q>all</q>, then all targets are recorded.</td>
|
|
|
|
|
<td>No; default is <q>all</q></td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>excludetarget</td>
|
|
|
|
|
<td>No</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>includetask</td>
|
|
|
|
|
<td rowspan="2">A comma-separated list of tasks to automatically record or not. This could be
|
|
|
|
|
difficult as it may conflict with the <code>includetarget/excludetarget</code>.
|
|
|
|
|
(e.g.: <code>includetarget="compile" excludetask="javac"</code>, what
|
|
|
|
|
should happen?)</td>
|
|
|
|
|
<td>No</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>excludetask</td>
|
|
|
|
|
<td>No</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>action</td>
|
|
|
|
|
<td>add greater flexibility to the <var>action</var> attribute. Things like <q>close</q> to
|
|
|
|
|
close the print stream.</td>
|
|
|
|
|
<td>No</td>
|
2001-04-04 12:03:46 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
