bloritsch 2002/09/25 18:01:45
Modified: event/src/xdocs menu.xml
Added: event/src/xdocs util.xml
Log:
Add the last of the "Why", "What", "Where" docs. The "How" docs will come later
Revision Changes Path
1.6 +1 -1 jakarta-avalon-excalibur/event/src/xdocs/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/event/src/xdocs/menu.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- menu.xml 26 Sep 2002 00:46:04 -0000 1.5
+++ menu.xml 26 Sep 2002 01:01:45 -0000 1.6
@@ -15,7 +15,7 @@
<item href="command.html" name="Command"/>
<item href="mpool.html" name="MPool"/>
<item href="thread.html" name="Thread"/>
-<!-- <item href="util.html" name="Util"/> -->
+ <item href="util.html" name="Util"/>
</menu>
<!--
<menu name="How To">
1.1 jakarta-avalon-excalibur/event/src/xdocs/util.xml
Index: util.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Excalibur Event - Util</title>
<authors>
<person name="Berin Loritsch" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Why Util Was Created">
<p>
Util was created to enable us to find out how many processors are
on a system programmatically. Unfortunately Sun does not think
it is important to know these details through Java. The Thread
Manager uses this to automatically determine how many background
threads it wants in the backing ThreadPool.
</p>
</s1>
<s1 title="When To Use Util">
<p>
Usually you won't use this package directly, unless you want to
know how many processors a system has. You might need to add a
new CPU Parser that will find out the necessary information from
environment variables or the /proc/ filesystem for a platform
that is not currently supported.
</p>
</s1>
<s1 title="Core Concepts">
<p>
Util has a SystemUtil which will load the correct CPU Parser for your
platform. If there is no maching CPU Parser will assume that there is
only one processor for your system.
</p>
<s2 title="System Util">
<p>
The System Util will allow you to gather any platform specific
information. Some of the methods are simpler ways of accessing
the System properties, and others are derived from the CPU Parser.
</p>
</s2>
<s2 title="CPU Parser">
<p>
The CPU Parser will allow you to gather essential information from
your platform. Unfortunately we cannot assume there is only one
way to gather information for each platform. If your platform is
not supported directly, please send an email to
<a href="mailto:[EMAIL PROTECTED]";>the Avalon Users</a>
mailing list with the new CPU Parser attached. We should be able
to include it in the next release. We currently support the entire
Microsoft Windows suite that supports Java, and Linux. Since we
don't currently have access to other machines, we can't support them
yet.
</p>
</s2>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2002/09/26 01:01:45 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
