Siphalor/tweed5-commons-logging
1
0
Fork 0
Code Activity

Corrections to document regarding NLS enablement, wording was to strong.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@138911 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Richard A. Sitze
2002-08-23 14:55:32 +00:00
parent 2ba41d354f
commit 76fd384d20
1 changed files with 28 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
usersguide.html
View File

@@ -156,34 +156,38 @@ Yes, the logging methods will perform the same check, but only after resolving p
<h4>General - Message Priorities/Levels</h4> <h4>General - Message Priorities/Levels</h4>
It is important to ensure that log message are It is important to ensure that log message are
appropriate in content and severity. appropriate in content and severity.
The following guidelines are strongly suggested: The following guidelines are suggested:</a>
<ul> <ul>
<li><b>fatal</b> - Severe errors that cause premature termination. <li><b>fatal</b> - Severe errors that cause premature termination.
Expect these to be immediately visible on a console, Expect these to be immediately visible on a status console.
and MUST be internationalized.</li> See also <a HREF="#Internationalization">Internationalization</a>.
</li>
<br>&nbsp; <br>&nbsp;
<li><b>error</b> - Other runtime errors or unexpected conditions. <li><b>error</b> - Other runtime errors or unexpected conditions.
Expect these to be immediately visible on a console, Expect these to be immediately visible on a status console.
and MUST be internationalized.</li> See also <a HREF="#Internationalization">Internationalization</a>.
</li>
<br>&nbsp; <br>&nbsp;
<li><b>warn</b> - Use of deprecated APIs, poor use of API, 'almost' errors, other <li><b>warn</b> - Use of deprecated APIs, poor use of API, 'almost' errors,
runtime situations that are undesirable or unexpected, but not other runtime situations that are undesirable or unexpected, but not
necessarily "wrong". necessarily "wrong".
Expect these to be immediately visible on a console, Expect these to be immediately visible on a status console.
and MUST be internationalized.</li> See also <a HREF="#Internationalization">Internationalization</a>.
</li>
<br>&nbsp; <br>&nbsp;
<li><b>info</b> - Interesting runtime events (startup/shutdown). <li><b>info</b> - Interesting runtime events (startup/shutdown).
Expect these to be immediately visible on a console, Expect these to be immediately visible on a console,
so be conservative and keep to a minimum. so be conservative and keep to a minimum.
These MUST be internationalized.</li> See also <a HREF="#Internationalization">Internationalization</a>.
</li>
<br>&nbsp; <br>&nbsp;
<li><b>debug</b> - detailed information on flow of through the system. <li><b>debug</b> - detailed information on flow of through the system.
Expect these to be written to logs only. Expect these to be written to logs only.
These NEED NOT be internationalized, but it never hurts...</li> </li>
<br>&nbsp; <br>&nbsp;
<li><b>trace</b> - more detailed information. <li><b>trace</b> - more detailed information.
Expect these to be written to logs only. Expect these to be written to logs only.
These NEED NOT be internationalized, but it never hurts...</li> </li>
</ul> </ul>
<h4>General - Default Message Priority/Level</h4> <h4>General - Default Message Priority/Level</h4>
@@ -280,19 +284,26 @@ by most logger implementations.
</p> </p>
<a NAME="Internationalization"></a>
<h4>Enterprise - National Language Support - Internationalization</h4> <h4>Enterprise - National Language Support - Internationalization</h4>
<p>NLS internationalization involves looking up messages from <p>NLS internationalization involves looking up messages from
a message file by a message key, and using that message logging. a message file by a message key, and using that message for logging.
There are various tools in Java, and provided by other components, There are various tools in Java, and provided by other components,
for working with NLS messages. for working with NLS messages.
</p> </p>
<p>NLS internationalization SHOULD be used for <p>
<b>fatal</b>, <b>error</b>, <b>warn</b>, and <b>info</b> messages. NLS enabled components are particularly appreciated
It can be considered optional for <b>debug</b> and <b>trace</b> messages. (thats an open-source-correct term for 'required by corporate end-users' :-)
for <strong>tooling</strong> and <strong>middleware</strong> components.
</p> </p>
<p>Perhaps a more direct support for internationalizing log messages <p>NLS internationalization SHOULD be strongly considered for used for
<b>fatal</b>, <b>error</b>, <b>warn</b>, and <b>info</b> messages.
It is generally considered optional for <b>debug</b> and <b>trace</b> messages.
</p>
<p>Perhaps more direct support for internationalizing log messages
can be introduced in a future or alternate version of the <code>Log</code> interface. can be introduced in a future or alternate version of the <code>Log</code> interface.
</p> </p>