Improved comments in code surrounding the m_driveReadyDelayInSeconds attribute of CleanerSession

castor/messages/ForkCleaner.proto

@@ -31,5 +31,7 @@ message ForkCleaner {
   required string vid = 5;
 
   // Description of the cleaner job
+  // Warning, setting this value to 0 has the special meaning of NOT testing to
+  // see if the drive contains a tape.
   required uint32 drivereadydelayinseconds = 6;
 }

castor/tape/tapeserver/daemon/CleanerSession.cpp

@@ -143,6 +143,8 @@ std::auto_ptr<castor::tape::tapeserver::drive::DriveInterface>
 //------------------------------------------------------------------------------
 void castor::tape::tapeserver::daemon::CleanerSession::waitUntilDriveIsReady(
   drive::DriveInterface &drive) {
+  // Warning, setting m_driveReadyDelayInSeconds to 0 has the special meaning of
+  // NOT testing to see if the drive contains a tape.
   if(0 != m_driveReadyDelayInSeconds) {
     std::list<log::Param> params;
     params.push_back(log::Param("TPVID", m_vid));

castor/tape/tapeserver/daemon/CleanerSession.hpp

@@ -56,7 +56,9 @@ namespace daemon {
      * @param vid The volume identifier of the mounted tape if known,
      * else the empty string.
      * @param driveReadyDelayInSeconds The maximum number of seconds to wait for
-     * the drive to be raedy with a tape inside of it.
+     * the drive to be ready with a tape inside of it.  Warning, setting this
+     * value to 0 has the special meaning of NOT testing to see if the drive
+     * contains a tape.
      */
     CleanerSession(
       server::ProcessCap &capUtils,
@@ -111,7 +113,8 @@ namespace daemon {
 
     /**
      * The maximum number of seconds to wait for the drive to be raedy with a
-     * tape inside of it.
+     * tape inside of it.  Warning, setting this value to 0 has the special
+     * meaning of NOT testing to see if the drive contains a tape.
      */
     const uint32_t m_driveReadyDelayInSeconds;
 

castor/tape/tapeserver/daemon/ProcessForkerProxy.hpp

@@ -82,7 +82,9 @@ public:
    * identifier is known.  If the volume identifier is not known then this
    * parameter should be set to an empty string.
    * @param driveReadyDelayInSeconds The maximum number of seconds to wait for
-   * the drive to be raedy with a tape inside of it.
+   * the drive to be ready with a tape inside of it.  Warning, setting this
+   * value to 0 has the special meaning of NOT testing to see if the drive
+   * contains a tape.
    * @return The process identifier of the newly forked session.
    */
   virtual pid_t forkCleaner(const DriveConfig &driveConfig,

castor/tape/tapeserver/daemon/ProcessForkerProxyDummy.hpp

@@ -88,7 +88,9 @@ public:
    * identifier is known.  If the volume identifier is not known then this
    * parameter should be set to an empty string.
    * @param driveReadyDelayInSeconds The maximum number of seconds to wait for
-   * the drive to be raedy with a tape inside of it.
+   * the drive to be ready with a tape inside of it.  Warning, setting this
+   * value to 0 has the special meaning of NOT testing to see if the drive
+   * contains a tape.
    * @return The process identifier of the newly forked session.
    */
   pid_t forkCleaner(const DriveConfig &driveConfig,

castor/tape/tapeserver/daemon/ProcessForkerProxySocket.hpp

@@ -103,7 +103,9 @@ public:
    * identifier is known.  If the volume identifier is not known then this
    * parameter should be set to an empty string.
    * @param driveReadyDelayInSeconds The maximum number of seconds to wait for
-   * the drive to be ready with a tape inside of it.
+   * the drive to be ready with a tape inside of it.   Warning, setting this
+   * value to 0 has the special meaning of NOT testing to see if the drive
+   * contains a tape.
    * @return The process identifier of the newly forked session.
    */
   pid_t forkCleaner(const DriveConfig &driveConfig,