From 4aad075e6143986af2974fcda1591996e3c88a29 Mon Sep 17 00:00:00 2001
From: kohsuke <kohsuke@71c3de6d-444a-0410-be80-ed276b4c234a>
Date: Wed, 22 Apr 2009 02:07:14 +0000
Subject: [PATCH] added help

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@17363 71c3de6d-444a-0410-be80-ed276b4c234a
---
 .../ArchitectureMonitor/help.html             |  3 +++
 .../node_monitors/ClockMonitor/help.html      |  9 ++++++++
 .../node_monitors/DiskSpaceMonitor/help.html  |  7 ++++++
 .../ResponseTimeMonitor/help.html             |  9 ++++++++
 .../node_monitors/SwapSpaceMonitor/help.html  | 23 +++++++++++++++++++
 .../TemporarySpaceMonitor/help.html           | 13 +++++++++++
 6 files changed, 64 insertions(+)
 create mode 100644 core/src/main/resources/hudson/node_monitors/ArchitectureMonitor/help.html
 create mode 100644 core/src/main/resources/hudson/node_monitors/ClockMonitor/help.html
 create mode 100644 core/src/main/resources/hudson/node_monitors/DiskSpaceMonitor/help.html
 create mode 100644 core/src/main/resources/hudson/node_monitors/ResponseTimeMonitor/help.html
 create mode 100644 core/src/main/resources/hudson/node_monitors/SwapSpaceMonitor/help.html
 create mode 100644 core/src/main/resources/hudson/node_monitors/TemporarySpaceMonitor/help.html

diff --git a/core/src/main/resources/hudson/node_monitors/ArchitectureMonitor/help.html b/core/src/main/resources/hudson/node_monitors/ArchitectureMonitor/help.html
new file mode 100644
index 0000000000..aab9bec30e
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/ArchitectureMonitor/help.html
@@ -0,0 +1,3 @@
+<div>
+    This monitor just shows the architecture of the slave for your information. It never marks the slave offline.
+</div>
\ No newline at end of file
diff --git a/core/src/main/resources/hudson/node_monitors/ClockMonitor/help.html b/core/src/main/resources/hudson/node_monitors/ClockMonitor/help.html
new file mode 100644
index 0000000000..365ac1851b
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/ClockMonitor/help.html
@@ -0,0 +1,9 @@
+<div>
+    This monitors the clock difference between the master and nodes.
+    While Hudson itself is generally capable of torelating clock differences between systems,
+    version control activities and distributed file access (such as NFS, Windows file shares)
+    tend to have strange problems when systems involved have different clocks.
+
+    <p>
+    To keep clocks in sync, refer to NTP.
+</div>
\ No newline at end of file
diff --git a/core/src/main/resources/hudson/node_monitors/DiskSpaceMonitor/help.html b/core/src/main/resources/hudson/node_monitors/DiskSpaceMonitor/help.html
new file mode 100644
index 0000000000..f7195cc833
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/DiskSpaceMonitor/help.html
@@ -0,0 +1,7 @@
+<div>
+    This monitors the available disk space of <tt>$HUDSON_HOME</tt> on each slave, and if it gets below
+    a threshold, the slave will be marked offline.
+
+    <p>
+    This directory is where all your builds are performed, so if it fills up, all the builds will fail.
+</div>
\ No newline at end of file
diff --git a/core/src/main/resources/hudson/node_monitors/ResponseTimeMonitor/help.html b/core/src/main/resources/hudson/node_monitors/ResponseTimeMonitor/help.html
new file mode 100644
index 0000000000..366e1d9633
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/ResponseTimeMonitor/help.html
@@ -0,0 +1,9 @@
+<div>
+    This monitors the round trip network response time from the master to the slave, and if it
+    goes above a threshold repeatedly, it marks the slave offline.
+
+    <p>
+    This is useful for detecting unresponsive slaves, or other network problems that clog the
+    communication channel. More specifically, the master sends a no-op command to the slave,
+    and checks the time it takes to get back the result of this no-op command.
+</div>
\ No newline at end of file
diff --git a/core/src/main/resources/hudson/node_monitors/SwapSpaceMonitor/help.html b/core/src/main/resources/hudson/node_monitors/SwapSpaceMonitor/help.html
new file mode 100644
index 0000000000..abb86420d2
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/SwapSpaceMonitor/help.html
@@ -0,0 +1,23 @@
+<div>
+    This monitors the available virtual memory space of the computer (commonly known as "swap space"),
+    and if it goes below a threshold, the slave is marked offline.
+
+    <p>
+    The exact definition of the swap space is platform dependent.
+
+    <ul>
+    <li>
+    On Windows, this value is
+    <a href="http://msdn.microsoft.com/en-us/library/aa366589(VS.85).aspx">the available space in the page file</a>,
+    but because Windows is capable of expanding the page file size automatically, the value doesn't really mean much.
+
+    <li>
+    On Linux, this value is obtained from <tt>/proc/meminfo</tt>.
+
+    <li>
+    On other Unix systems, this value is obtained by executing the <tt>top</tt> command.
+    </ul>
+
+    <p>
+    If you have an operating system where this value is not reported, please let us know so that we can improve this.
+</div>
\ No newline at end of file
diff --git a/core/src/main/resources/hudson/node_monitors/TemporarySpaceMonitor/help.html b/core/src/main/resources/hudson/node_monitors/TemporarySpaceMonitor/help.html
new file mode 100644
index 0000000000..31d6a0becb
--- /dev/null
+++ b/core/src/main/resources/hudson/node_monitors/TemporarySpaceMonitor/help.html
@@ -0,0 +1,13 @@
+<div>
+    This monitors the available disk space of the temporary directory, and if it gets below a certain threshold
+    the node will be made offline.
+
+    <p>
+    Java tools and tests/builds often create files in the temporary directory, and may not function
+    properly if there's no available space.
+
+    <p>
+    More specifically, it checks the available disk space of a partition
+    that includes directory designated by the <tt>java.io.tmpdir</tt> system property.
+    To check where this directory is on a given slave, go to <tt>${rootURL}/computer/SLAVENAME/systemInfo</tt>.
+</div>
\ No newline at end of file
-- 
GitLab