[HDFS-12154] Incorrect javadoc description in StorageLocationChecker#check

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.9.0, 3.0.0-beta1
• Hadoop Flags: Reviewed
• Assignee: Nandakumar
• Reporter: Nandakumar
• Created: 17/Jul/17 18:51
• Updated: 24/Apr/18 20:53
• Resolved: 18/Jul/17 09:29

Description

StorageLocationChecker#check returns list of healthy volumes, but javadoc states that it returns failed volumes.

/**
   * Initiate a check of the supplied storage volumes and return
   * a list of failed volumes.
   *
   * StorageLocations are returned in the same order as the input
   * for compatibility with existing unit tests.
   *
   * @param conf HDFS configuration.
   * @param dataDirs list of volumes to check.
   * @return returns a list of failed volumes. Returns the empty list if
   *         there are no failed volumes.
   *
   * @throws InterruptedException if the check was interrupted.
   * @throws IOException if the number of failed volumes exceeds the
   *                     maximum allowed or if there are no good
   *                     volumes.
   */