Changeset 3411

Timestamp:

May 30, 2007, 4:41:36 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #601.

Location:

trunk/doc/src/docbook/appendix

Files:

• jobagent.properties.xml (modified) (9 diffs)
• jobagent.sh.xml (modified) (4 diffs)

trunk/doc/src/docbook/appendix/jobagent.properties.xml

@@ -49 +49 @@
       <listitem>
         <para>
-          Required. The BASE user account the job agent should use to login 
+          Required. The BASE user account used by the job agent to log on 
           to the BASE server. The user account must have sufficient privileges 
           to access jobs and job agents. The <emphasis>Job agent</emphasis>
           role is a predefined role with all permissions a job agent needs.
-          There is also a predefined user account with the login 
+          There is also a predefined user account with the user name 
           <emphasis>jobagent</emphasis>. This account is disabled by default and
           has to be enabled and given a password before it can be used.
@@ -64 +64 @@
       <listitem>
         <para>
-          Required. The password for the user account.
+          Required. The password for the job agent user account.
         </para>
       </listitem>
@@ -130 +130 @@
       <listitem>
         <para>
-          Optional. A comma-separated list of ip addresses or names of 
+          Optional. A comma-separated list of IP addresses or names of 
           computers that are allowed to send control requests to the job 
           agent. If no value is specified, only the local host is allowed 
@@ -177 +177 @@
       <listitem>
         <para>
-          Optional. If the <command>start</command> command should be 
-          accepted from remote hosts specified in the <property>agent.remotecontrol</property> setting. 
-          If <constant>false</constant>, only the local host is allowed to 
-          start the job agent when it's paused. The default value is <constant>true</constant>.
+          Optional, valid only when job agent is paused. If
+          the <command>start</command> command should be accepted from
+          remote hosts specified in
+          the <property>agent.remotecontrol</property> setting.
+          If <constant>false</constant>, only the local host is
+          allowed to start the job agent when it is paused. The
+          default value is <constant>true</constant>.
         </para>
       </listitem>
@@ -207 +210 @@
           <itemizedlist>
           <listitem>
+            <term>
+            <classname>net.sf.basedb.clients.jobagent.executors.ProcessJobExecutor</classname>
+            </term>
             <para>
-            <classname>net.sf.basedb.clients.jobagent.executors.ProcessJobExecutor</classname>: 
             Executes the job in an 
             external process. This is the recommended executor and is the default
-            choice if no value has been specified. With this executor a 
+            choice if no value has been specified. With this executor, a 
             misbehaving plugin doesn't affect the job agent or other jobs.
             The drawback is that since a new virtual machine has to be started,
-            more memory is required and the startup time can be long.
+            more memory is required and the start up time can be long.
             </para>
           </listitem>
@@ -223 +228 @@
             Executes the job in a separate thread. This is only recommended 
             for plugins that are  trusted and safe. A misbehaving plugin can affect the job agent 
-            and other jobs, but the startup time is short and less memory 
+            and other jobs, but the start up time is short and less memory 
             is used.
             </para>
@@ -289 +294 @@
       <listitem>
         <para>
-          Optional. Number of seconds between checks to the database 
+          Optional. Number of seconds between querying the database 
           for jobs that are waiting for execution. The default value
           is 30 seconds.
@@ -303 +308 @@
     
     <para>
-      The job agent doesn't execute any number of jobs at the same time.
+      The job agent doesn't execute an arbitrary number of jobs simultaneously.
       This would sooner or later break the server. Instead, it uses a
       simple system with four different slots. Each slot is reserved for
@@ -312 +317 @@
     
     <para>
-      With each slot is also associated a thread priority. The priority
+      A thread priority is associated with each slot. The priority
       is a value between 1 and 10 as defined by the 
       <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html"

trunk/doc/src/docbook/appendix/jobagent.sh.xml

@@ -32 +32 @@
   <para>
     The <filename>jobagent.sh</filename> (or <filename>jobagent.bat</filename> on
-    Windows) is a command-line utitlity for controlling the job agent. 
+    Windows) is a command-line utility for controlling the job agent. 
     The syntax is:
 
@@ -43 +43 @@
     The options are optional, but a <command>command</command>
     must always be given. The script is located in the 
-    <filename>&lt;base-dir&gt;/bin</filename> diretory and you must
+    <filename>&lt;base-dir&gt;/bin</filename> directory and you must
     change to that directory to be able to use the script.
   </para>
@@ -102 +102 @@
         <para>
           Start the job agent. As soon as it is up and running it will 
-          check the datbase for jobs that are waiting to be executed.
+          check the database for jobs that are waiting to be executed.
         </para>
       </listitem>
@@ -145 +145 @@
           running, the ID is given. In the future, the <command>info</command>
           command may output more information. For example, there is already
-          infrastructure code for cpu and memory usage. The only problem is
+          infrastructure code for CPU and memory usage. The only problem is
           that the information isn't easy to get for a Java program.
         </para>