Repository: hadoop Updated Branches: refs/heads/ozone-0.3 ca1136fb4 -> fac987b9a
HDDS-690. Javadoc build fails in hadoop-ozone. Contributed by Takanobu Asanuma. (cherry picked from commit f8d61b9fc2259e7bfd503924a0c2e41a0955aaed) Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/fac987b9 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/fac987b9 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/fac987b9 Branch: refs/heads/ozone-0.3 Commit: fac987b9a1a04acdd7ce9394fb892a9c6ca1f50a Parents: ca1136f Author: Anu Engineer <aengin...@apache.org> Authored: Thu Oct 18 12:14:54 2018 -0700 Committer: Anu Engineer <aengin...@apache.org> Committed: Thu Oct 18 12:16:30 2018 -0700 ---------------------------------------------------------------------- .../java/org/apache/hadoop/ozone/client/BucketArgs.java | 2 +- .../apache/hadoop/ozone/om/helpers/OmBucketArgs.java | 4 ++-- .../apache/hadoop/ozone/om/helpers/OmBucketInfo.java | 2 +- .../org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java | 1 - .../apache/hadoop/ozone/web/handlers/VolumeHandler.java | 6 ++++-- .../apache/hadoop/ozone/web/interfaces/Accounting.java | 2 +- .../org/apache/hadoop/ozone/web/interfaces/Volume.java | 12 +++++++----- .../java/org/apache/hadoop/ozone/om/KeyManager.java | 2 +- .../org/apache/hadoop/ozone/om/OzoneManagerLock.java | 7 ++++--- .../apache/hadoop/ozone/om/ServiceListJSONServlet.java | 4 ++-- .../genconf/GenerateOzoneRequiredConfigurations.java | 2 +- 11 files changed, 24 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java index d86062b..e68e9f1 100644 --- a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java +++ b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java @@ -74,7 +74,7 @@ public final class BucketArgs { /** * Returns the ACL's associated with this bucket. - * @return List<OzoneAcl> + * @return {@literal List<OzoneAcl>} */ public List<OzoneAcl> getAcls() { return acls; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java index 3819131..a3ae7e5 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java @@ -100,7 +100,7 @@ public final class OmBucketArgs implements Auditable { /** * Returns the ACL's that are to be added. - * @return List<OzoneAclInfo> + * @return {@literal List<OzoneAclInfo>} */ public List<OzoneAcl> getAddAcls() { return addAcls; @@ -108,7 +108,7 @@ public final class OmBucketArgs implements Auditable { /** * Returns the ACL's that are to be removed. - * @return List<OzoneAclInfo> + * @return {@literal List<OzoneAclInfo>} */ public List<OzoneAcl> getRemoveAcls() { return removeAcls; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java index 4418738..0bff1f7 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java @@ -101,7 +101,7 @@ public final class OmBucketInfo implements Auditable { /** * Returns the ACL's associated with this bucket. - * @return List<OzoneAcl> + * @return {@literal List<OzoneAcl>} */ public List<OzoneAcl> getAcls() { return acls; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java index 50f4b17..c9a7e48 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java @@ -119,7 +119,6 @@ public final class OmKeyInfo { * This will be called when the key is being committed to OzoneManager. * * @param locationInfoList list of locationInfo - * @throws IOException */ public void updateLocationInfoList(List<OmKeyLocationInfo> locationInfoList) { long latestVersion = getLatestVersionLocations().getVersion(); http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java index 002f289..bd04ea6 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java @@ -60,7 +60,8 @@ public class VolumeHandler implements Volume { * Creates a volume. * * @param volume Volume Name, this has to be unique at Ozone cluster level - * @param quota Quota for this Storage Volume - <int>(<BYTES|MB|GB|TB>) + * @param quota Quota for this Storage Volume + * - {@literal <int>(<BYTES|MB|GB|TB>)} * @param req Request Object * @param uriInfo URI info * @param headers Http Headers @@ -114,7 +115,8 @@ public class VolumeHandler implements Volume { * with neither of these actions, update just returns 200 OK. * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this volume - <int>(<BYTES|MB|GB|TB>)|remove + * @param quota Quota for this volume + * - {@literal <int>(<BYTES|MB|GB|TB>)}|remove * @param req - Request Object * @param uriInfo - URI info * @param headers Http Headers http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java index f03276c..73290b3 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java @@ -25,7 +25,7 @@ package org.apache.hadoop.ozone.web.interfaces; * TODO : Technically we need to report bucket creation and deletion too * since the bucket names and metadata consume storage. * <p> - * TODO : We should separate out reporting metadata & data -- + * TODO : We should separate out reporting metadata & data -- * <p> * In some cases end users will only want to account for the data they are * storing since metadata is mostly a cost of business. http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java index 85b2240..ce37042 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java @@ -54,11 +54,12 @@ public interface Volume { * * Params : * Quota - Specifies the Maximum usable size by the user - * the valid parameters for quota are <int>(<BYTES| MB|GB|TB>) | remove. - * For example 10GB or "remove". + * the valid parameters for quota are {@literal <int>(<BYTES| MB|GB|TB>)} + * | remove. For example 10GB or "remove". * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this Storage Volume - <int>(<MB|GB|TB>) | remove + * @param quota Quota for this Storage Volume - {@literal <int>(<MB|GB|TB>)} + * | remove * @param req - Request Object - Request Object * @param uriInfo - Http UriInfo * @param headers Http Headers HttpHeaders @@ -91,11 +92,12 @@ public interface Volume { * Params : * Owner - Specifies the name of the owner * Quota - Specifies the Maximum usable size by the user - * the valid parameters for quota are <int>(<MB|GB|TB>) | remove. + * the valid parameters for quota are {@literal <int>(<MB|GB|TB>)} | remove. * For example 10GB or "remove". * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this Storage Volume - <int>(<MB|GB|TB>) | remove + * @param quota Quota for this Storage Volume - {@literal <int>(<MB|GB|TB>)} + * | remove * @param req - Request Object - Request Object * @param headers Http Headers HttpHeaders * http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java index 83363e7..b7b4517 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java @@ -72,7 +72,7 @@ public interface KeyManager { * * @param args the args of the key provided by client. * @return a OpenKeySession instance client uses to talk to container. - * @throws Exception + * @throws IOException */ OpenKeySession openKey(OmKeyArgs args) throws IOException; http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java index 6203ddf..c5ce9e2 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java @@ -33,6 +33,7 @@ import static org.apache.hadoop.ozone.OzoneConsts.OM_USER_PREFIX; * We also maintain lock hierarchy, based on the weight. * * <table> + * <caption></caption> * <tr> * <td><b> WEIGHT </b></td> <td><b> LOCK </b></td> * </tr> @@ -53,9 +54,9 @@ import static org.apache.hadoop.ozone.OzoneConsts.OM_USER_PREFIX; * <p> * For example: * <br> - * -> acquireVolumeLock (will work)<br> - * +-> acquireBucketLock (will work)<br> - * +--> acquireUserLock (will throw Exception)<br> + * {@literal ->} acquireVolumeLock (will work)<br> + * {@literal +->} acquireBucketLock (will work)<br> + * {@literal +-->} acquireUserLock (will throw Exception)<br> * </p> * <br> * To acquire a user lock you should not hold any Volume/Bucket lock. Similarly http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java index 47713e2..acc1634 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java @@ -41,7 +41,7 @@ import java.io.PrintWriter; * * The return format is of JSON and in the form * <p> - * <code><pre> + * <pre><code> * { * "services" : [ * { @@ -54,7 +54,7 @@ import java.io.PrintWriter; * } * ] * } - * </pre></code> + * </code></pre> * <p> * */ http://git-wip-us.apache.org/repos/asf/hadoop/blob/fac987b9/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java ---------------------------------------------------------------------- diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java index b58cfc2..5d27838 100644 --- a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java +++ b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java @@ -40,7 +40,7 @@ import java.util.List; * This tool generates an ozone-site.xml with minimally required configs. * This tool can be invoked as follows:<br> * <ul> - * <li>ozone genconf <Path to output file></li> + * <li>ozone genconf {@literal <Path to output file>}</li> * <li>ozone genconf --help</li> * <li>ozone genconf -h</li> * </ul> --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org
