hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Chen He (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HADOOP-11775) Fix typos in Swift related Javadoc
Date Mon, 30 Mar 2015 21:00:54 GMT

     [ https://issues.apache.org/jira/browse/HADOOP-11775?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Chen He updated HADOOP-11775:
-----------------------------
    Description: 
Some typos are listed below but not limited to:
SwiftNativeFileSystemObject.java
  /**
   * Initalize the filesystem store -this creates the REST client binding.
   *
   * @param fsURI         URI of the filesystem, which is used to map to the filesystem-specific
   *                      options in the configuration file
   * @param configuration configuration
   * @throws IOException on any failure.
   */

SwiftNativeFileSystem.java
  /**
   * Low level method to do a deep listing of all entries, not stopping
   * at the next directory entry. This is to let tests be confident that
   * recursive deletes &c really are working.
   * @param path path to recurse down
   * @param newest ask for the newest data, potentially slower than not.
   * @return a potentially empty array of file status
   * @throws IOException any problem
   */

  /**
   * Low-level operation to also set the block size for this operation
   * @param path       the file name to open
   * @param bufferSize the size of the buffer to be used.
   * @param readBlockSize how big should the read blockk/buffer size be?
   * @return the input stream
   * @throws FileNotFoundException if the file is not found
   * @throws IOException any IO problem
   */

SwiftRestClient.java

  /**
   * Converts Swift path to URI to make request.
   * This is public for unit testing
   *
   * @param path path to object
   * @param endpointURI damain url e.g. http://domain.com
   * @return valid URI for object
   */




  was:
Some typos are listed below but not limited to:
SwiftNativeFileSystemObject
  /**
   * Initalize the filesystem store -this creates the REST client binding.
   *
   * @param fsURI         URI of the filesystem, which is used to map to the filesystem-specific
   *                      options in the configuration file
   * @param configuration configuration
   * @throws IOException on any failure.
   */
SwiftNativeFileSystem
  /**
   * Low level method to do a deep listing of all entries, not stopping
   * at the next directory entry. This is to let tests be confident that
   * recursive deletes &c really are working.
   * @param path path to recurse down
   * @param newest ask for the newest data, potentially slower than not.
   * @return a potentially empty array of file status
   * @throws IOException any problem
   */

  /**
   * Low-level operation to also set the block size for this operation
   * @param path       the file name to open
   * @param bufferSize the size of the buffer to be used.
   * @param readBlockSize how big should the read blockk/buffer size be?
   * @return the input stream
   * @throws FileNotFoundException if the file is not found
   * @throws IOException any IO problem
   */

SwiftRestClient

  /**
   * Converts Swift path to URI to make request.
   * This is public for unit testing
   *
   * @param path path to object
   * @param endpointURI damain url e.g. http://domain.com
   * @return valid URI for object
   */





> Fix typos in Swift related Javadoc
> ----------------------------------
>
>                 Key: HADOOP-11775
>                 URL: https://issues.apache.org/jira/browse/HADOOP-11775
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 2.6.0
>            Reporter: Chen He
>            Assignee: Yanjun Wang
>            Priority: Trivial
>
> Some typos are listed below but not limited to:
> SwiftNativeFileSystemObject.java
>   /**
>    * Initalize the filesystem store -this creates the REST client binding.
>    *
>    * @param fsURI         URI of the filesystem, which is used to map to the filesystem-specific
>    *                      options in the configuration file
>    * @param configuration configuration
>    * @throws IOException on any failure.
>    */
> SwiftNativeFileSystem.java
>   /**
>    * Low level method to do a deep listing of all entries, not stopping
>    * at the next directory entry. This is to let tests be confident that
>    * recursive deletes &c really are working.
>    * @param path path to recurse down
>    * @param newest ask for the newest data, potentially slower than not.
>    * @return a potentially empty array of file status
>    * @throws IOException any problem
>    */
>   /**
>    * Low-level operation to also set the block size for this operation
>    * @param path       the file name to open
>    * @param bufferSize the size of the buffer to be used.
>    * @param readBlockSize how big should the read blockk/buffer size be?
>    * @return the input stream
>    * @throws FileNotFoundException if the file is not found
>    * @throws IOException any IO problem
>    */
> SwiftRestClient.java
>   /**
>    * Converts Swift path to URI to make request.
>    * This is public for unit testing
>    *
>    * @param path path to object
>    * @param endpointURI damain url e.g. http://domain.com
>    * @return valid URI for object
>    */



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message