db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1542028 - in /db/derby/docs/trunk/src/ref: crefproper22250.dita refderby.ditamap rrefproper13217.dita rrefproperrollingfile.dita rrefproperrollingfilecount.dita rrefproperrollingfilelimit.dita rrefproperrollingfilepattern.dita
Date Thu, 14 Nov 2013 19:13:32 GMT
Author: chaase3
Date: Thu Nov 14 19:13:32 2013
New Revision: 1542028

URL: http://svn.apache.org/r1542028
Log:
DERBY-6359  Document rolling derby.log file feature

Modified 2 Reference Manual topics and the map file, added 4 new topics.

Patch: DERBY-6359-2.diff

Added:
    db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita   (with props)
Modified:
    db/derby/docs/trunk/src/ref/crefproper22250.dita
    db/derby/docs/trunk/src/ref/refderby.ditamap
    db/derby/docs/trunk/src/ref/rrefproper13217.dita

Modified: db/derby/docs/trunk/src/ref/crefproper22250.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper22250.dita?rev=1542028&r1=1542027&r2=1542028&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefproper22250.dita (original)
+++ db/derby/docs/trunk/src/ref/crefproper22250.dita Thu Nov 14 19:13:32 2013
@@ -354,6 +354,26 @@ about when changes to the property are d
 <entry colname="3">Static</entry>
 </row>
 <row>
+<entry colname="1"><i><xref href="rrefproperrollingfilecount.dita#rrefproperrollingfilecount">derby.stream.error.rollingFile.count</xref></i></entry>
+<entry colname="2">S</entry>
+<entry colname="3">Static</entry>
+</row>
+<row>
+<entry colname="1"><i><xref href="rrefproperrollingfilelimit.dita#rrefproperrollingfilelimit">derby.stream.error.rollingFile.limit</xref></i></entry>
+<entry colname="2">S</entry>
+<entry colname="3">Static</entry>
+</row>
+<row>
+<entry colname="1"><i><xref href="rrefproperrollingfilepattern.dita#rrefproperrollingfilepattern">derby.stream.error.rollingFile.pattern</xref></i></entry>
+<entry colname="2">S</entry>
+<entry colname="3">Static</entry>
+</row>
+<row>
+<entry colname="1"><i><xref href="rrefproperrollingfile.dita#rrefproperrollingfile">derby.stream.error.style</xref></i></entry>
+<entry colname="2">S</entry>
+<entry colname="3">Static</entry>
+</row>
+<row>
 <entry colname="1"><i><xref href="rrefproperbootall.dita#rrefproperbootall">derby.system.bootAll</xref></i></entry>
 <entry colname="2">S</entry>
 <entry colname="3">Static</entry>

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1542028&r1=1542027&r2=1542028&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Nov 14 19:13:32 2013
@@ -1313,6 +1313,14 @@ URL syntax"></topicref>
 </topicref>
 <topicref href="rrefproper35028.dita" navtitle="derby.stream.error.method">
 </topicref>
+<topicref href="rrefproperrollingfilecount.dita" navtitle="derby.stream.error.rollingFile.count">
+</topicref>
+<topicref href="rrefproperrollingfilelimit.dita" navtitle="derby.stream.error.rollingFile.limit">
+</topicref>
+<topicref href="rrefproperrollingfilepattern.dita" navtitle="derby.stream.error.rollingFile.pattern">
+</topicref>
+<topicref href="rrefproperrollingfile.dita" navtitle="derby.stream.error.style">
+</topicref>
 <topicref href="rrefproperbootall.dita" navtitle="derby.system.bootAll">
 </topicref>
 <topicref href="rrefproperdurability.dita" navtitle="derby.system.durability">

Modified: db/derby/docs/trunk/src/ref/rrefproper13217.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper13217.dita?rev=1542028&r1=1542027&r2=1542028&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproper13217.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproper13217.dita Thu Nov 14 19:13:32 2013
@@ -32,6 +32,10 @@ limitations under the License.
 information can help you debug problems within a system.</p>
 <p>You can set this property even if the file does not yet exist;
 <ph conref="../conrefs.dita#prod/productshortname"></ph> creates the file.</p>
+<p>See
+<i><xref href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i>
for
+information on how this property works if the <i>derby.stream.error.style</i>
+property is set.</p>
 </section>
 <section><title>Default</title>
 <p>False.</p>

Added: db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita?rev=1542028&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita Thu Nov 14 19:13:32 2013
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefproperrollingfile" xml:lang="en-us">
+<title>derby.stream.error.style</title>
+<prolog><metadata>
+<keywords><indexterm>derby.stream.error.style</indexterm>
+<indexterm>Error log<indexterm>rolling over</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section><title>Function</title>
+<p>Specifies that the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+log file should be rolled over when it reaches a certain size.</p>
+<p>If you set this property to <codeph>rollingFile</codeph> (the only supported
+value), <ph conref="../conrefs.dita#prod/productshortname"></ph> by default
+creates up to 10 rolling files named <i>derby-0.log</i>, <i>derby-1.log</i>,
and
+so on, up to <i>derby-9.log</i>, each with a maximum length of 1,024,000
+bytes.</p>
+<p>You can override any of these defaults by setting one or more of the
+following properties:</p>
+<ul>
+<li><i><xref href="rrefproperrollingfilecount.dita#rrefproperrollingfilecount"></xref></i></li>
+<li><i><xref href="rrefproperrollingfilelimit.dita#rrefproperrollingfilelimit"></xref></i></li>
+<li><i><xref href="rrefproperrollingfilepattern.dita#rrefproperrollingfilepattern"></xref></i></li>
+</ul>
+<p>If you set this property, the
+<i><xref href="rrefproper33027.dita#rrefproper33027">derby.stream.error.field</xref></i>,
+<i><xref href="rrefproper18151.dita#rrefproper18151">derby.stream.error.file</xref></i>,
+and
+<i><xref href="rrefproper35028.dita#rrefproper35028">derby.stream.error.method</xref></i>
+properties are ignored.</p>
+<p>This property works in accordance with the setting of the
+<i><xref href="rrefproper13217.dita#rrefproper13217">derby.infolog.append</xref></i>
+property. If <i>derby.infolog.append</i> is not set or is set to false, any
+existing log files will be rolled over and a new log file will be created when
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> engine is started.
+If <i>derby.infolog.append</i> is set to true, the latest existing log file,
if
+any, will be appended to.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>derby.stream.error.style=<i>style</i></b></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>Not set.</p> </section>
+<example><title>Example</title>
+<codeblock><b>derby.stream.error.style=rollingFile</b></codeblock>
+</example>
+<section><title>Scope</title>
+<p><xref href="crefproper51399.dita#crefproper51399/rrefproper41229">system-wide</xref></p>
+</section>
+<section><title>Dynamic or static</title>
+<p>This property is static; if you change it while
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
+does not take effect until you reboot.</p> </section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefproperrollingfile.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita?rev=1542028&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita Thu Nov 14 19:13:32 2013
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefproperrollingfilecount" xml:lang="en-us">
+<title>derby.stream.error.rollingFile.count</title>
+<prolog><metadata>
+<keywords><indexterm>derby.stream.error.rollingFile.count</indexterm>
+<indexterm>Error log<indexterm>number of files</indexterm></indexterm>
+<indexterm>Error log<indexterm>rolling over</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section><title>Function</title>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is set
to
+<codeph>rollingFile</codeph>, this property specifies the number of rolling log
+files to permit before deleting the oldest file when rolling to the next
+file.</p>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is not
set,
+this property setting is ignored.</p>
+<p>You can override other rolling log file defaults by setting
+<i><xref href="rrefproperrollingfilelimit.dita#rrefproperrollingfilelimit"></xref></i>
+or
+<i><xref href="rrefproperrollingfilepattern.dita#rrefproperrollingfilepattern"></xref></i>.
+</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>derby.stream.error.rollingFile.count=<i>count</i></b></codeblock>
+<p>The specified <i>count</i> value must be equal to or greater than 1.</p>
+</refsyn>
+<section><title>Default</title>
+<p>10.</p></section>
+<example><title>Example</title>
+<codeblock><b>derby.stream.error.rollingFile.count=1</b></codeblock>
+</example>
+<section><title>Scope</title>
+<p><xref href="crefproper51399.dita#crefproper51399/rrefproper41229">system-wide</xref></p>
+</section>
+<section><title>Dynamic or static</title>
+<p>This property is static; if you change it while
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
+does not take effect until you reboot.</p> </section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefproperrollingfilecount.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita?rev=1542028&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita Thu Nov 14 19:13:32 2013
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefproperrollingfilelimit" xml:lang="en-us">
+<title>derby.stream.error.rollingFile.limit</title>
+<prolog><metadata>
+<keywords><indexterm>derby.stream.error.rollingFile.limit</indexterm>
+<indexterm>Error log<indexterm>size limit</indexterm></indexterm>
+<indexterm>Error log<indexterm>rolling over</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section><title>Function</title>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is set
to
+<codeph>rollingFile</codeph>, this property specifies the number of bytes to
+which to limit each rolling log file before it is rolled over to the next
+file.</p>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is not
set,
+this property setting is ignored.</p>
+<p>You can override other rolling log file defaults by setting
+<i><xref href="rrefproperrollingfilecount.dita#rrefproperrollingfilecount"></xref></i>
+or
+<i><xref href="rrefproperrollingfilepattern.dita#rrefproperrollingfilepattern"></xref></i>.
+</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>derby.stream.error.rollingFile.limit=<i>limit</i></b></codeblock>
+<p>The specified <i>limit</i> value must be equal to or greater than 0
(zero).
+If you specify 0 as the limit, the file size has no limit, and the log file will
+never roll over.</p>
+</refsyn>
+<section><title>Default</title>
+<p>1024000 (one megabyte).</p></section>
+<example><title>Example</title>
+<codeblock><b>derby.stream.error.rollingFile.limit=2048000</b></codeblock>
+</example>
+<section><title>Scope</title>
+<p><xref href="crefproper51399.dita#crefproper51399/rrefproper41229">system-wide</xref></p>
+</section>
+<section><title>Dynamic or static</title>
+<p>This property is static; if you change it while
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
+does not take effect until you reboot.</p> </section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefproperrollingfilelimit.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita?rev=1542028&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita Thu Nov 14 19:13:32 2013
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rrefproperrollingfilepattern" xml:lang="en-us">
+<title>derby.stream.error.rollingFile.pattern</title>
+<prolog><metadata>
+<keywords><indexterm>derby.stream.error.rollingFile.pattern</indexterm>
+<indexterm>Error log<indexterm>file name pattern</indexterm></indexterm>
+<indexterm>Error log<indexterm>rolling over</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section><title>Function</title>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is set
to
+<codeph>rollingFile</codeph>, this property specifies the naming pattern to use
+for the rolling log files.</p>
+<p>If <i><xref
+href="rrefproperrollingfile.dita#rrefproperrollingfile"></xref></i> is not
set,
+this property setting is ignored.</p>
+<p>You can override other rolling log file defaults by setting
+<i><xref href="rrefproperrollingfilecount.dita#rrefproperrollingfilecount"></xref></i>
+or
+<i><xref href="rrefproperrollingfilelimit.dita#rrefproperrollingfilelimit"></xref></i>.
+</p>
+<p>A pattern consists of a string that includes the following special components 
+that will be replaced at runtime.</p>
+<table frame="all"><title>Rolling log file pattern components</title>
+<desc>This table lists and describes the components of the rolling log file naming
pattern.</desc>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="30*"/>
+<colspec colname="2" colnum="2" colwidth="70*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Pattern component</entry>
+<entry colname="2">Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1"><codeph>/</codeph></entry>
+<entry colname="2">Local path name separator</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%t</codeph></entry>
+<entry colname="2">The system temporary directory</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%h</codeph></entry>
+<entry colname="2">The value of the <i>user.home</i> system property</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%d</codeph></entry>
+<entry colname="2">The value of the <i>derby.system.home</i> system property</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%g</codeph></entry>
+<entry colname="2">The generation number to distinguish rotated log files.
+Generation numbers follow the sequence 0, 1, 2, and so on. If you do not specify
+a <codeph>%g</codeph> field and the file count is greater than one, the
+generation number will be added to the end of the generated filename, after a
+dot.</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%u</codeph></entry>
+<entry colname="2">A unique number to resolve conflicts.</entry>
+</row>
+<row>
+<entry colname="1"><codeph>%%</codeph></entry>
+<entry colname="2">Translates to a single percent sign (<codeph>%</codeph>)</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<p>Thus, for example, a <i>derby.stream.error.rollingFile.pattern</i> setting
of
+<codeph>%t/java%g.log</codeph> with a
+<i>derby.stream.error.rollingFile.count</i> setting of 2 might cause log files
+on a UNIX system to be written to <i>/var/tmp/java0.log</i> and 
+<i>/var/tmp/java1.log</i>, whereas on a Windows 7 system they might be written
+to <i>%USERPROFILE%\AppData\Local\Temp\java0.log</i> and
+<i>%USERPROFILE%\AppData\Local\Temp\java1.log</i>.</p>
+<p>Normally, the <codeph>%u</codeph> unique field is set to 0 (zero). However,
+if <ph conref="../conrefs.dita#prod/productshortname"></ph> tries to open the
+file by the specified name and finds that the file is currently in use by
+another process, it will increment the unique number field and try again. This
+action will be repeated until
+<ph conref="../conrefs.dita#prod/productshortname"></ph> finds a file name that
+is not currently in use. If there is a conflict and no <codeph>%u</codeph> field
+has been specified, the unique number will be added at the end of the filename
+after a dot. (This will be after any automatically added generation number.)</p>
+<p>For example, if three processes are all trying to log to
+<codeph>fred%u.%g.txt</codeph>, they might have log files named
+<i>fred0.0.txt</i>, <i>fred1.0.txt</i>, <i>fred2.0.txt</i>
as the first file in
+their rotating sequences.</p>
+<note>The use of unique fields to avoid conflicts is guaranteed to work reliably
+only when you are using a local disk file system.</note>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>derby.stream.error.rollingFile.pattern=<i>pattern</i></b></codeblock>
+<p>The number of characters in the specified <i>pattern</i> value must
be equal
+to or greater than 1.</p></refsyn>
+<section><title>Default</title>
+<p><codeph>%d/derby-%g.log</codeph>.</p></section>
+<example><title>Example</title>
+<p>The following setting creates files named <i>myDBlog-0.txt</i>,
+<i>myDBlog-1.txt</i>, and so on, in the user's home directory:</p>
+<codeblock><b>derby.stream.error.rollingFile.pattern=%h/myDBlog-%g.txt</b></codeblock>
+</example>
+<section><title>Scope</title>
+<p><xref href="crefproper51399.dita#crefproper51399/rrefproper41229">system-wide</xref></p>
+</section>
+<section><title>Dynamic or static</title>
+<p>This property is static; if you change it while
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is running, the change
+does not take effect until you reboot.</p> </section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefproperrollingfilepattern.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message