hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrew Wang (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-14398) Modify documents for the FileSystem Builder API
Date Tue, 15 Aug 2017 05:41:02 GMT

    [ https://issues.apache.org/jira/browse/HADOOP-14398?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16126823#comment-16126823
] 

Andrew Wang commented on HADOOP-14398:
--------------------------------------

Thanks for the rev Eddy! Almost there, a few more things:

* Can we update the example in FSDataOutputStream as well to use a FooFileSystem and fake
options too?
* There are still mentions of realistic looking names in the doc that I'd prefer were fake
ones.
* Looking at FSDataOutputStream, the javadoc for must and opt should have a {{@throws IllegalArgumentException}}
instead of linking. The overloads for the non-String types would also ideally {{@see #must(String,
String)}} or {{@see #opt(String, String}} as appropriate.

Reading Aaron's previous review and combining with my own, it sounds like we are deferring
the following to future work / more discussion:

* Specify what happens when must and opt conflict
* Are there provisions for probing FS capabilities without must ?
* Where to put any HDFS-specific information about the builder options

Would appreciate if you start conversations / file follow-on JIRAs as appropriate for this.

> Modify documents for the FileSystem Builder API
> -----------------------------------------------
>
>                 Key: HADOOP-14398
>                 URL: https://issues.apache.org/jira/browse/HADOOP-14398
>             Project: Hadoop Common
>          Issue Type: Sub-task
>          Components: fs
>    Affects Versions: 3.0.0-alpha3
>            Reporter: Lei (Eddy) Xu
>            Assignee: Lei (Eddy) Xu
>              Labels: docuentation
>         Attachments: HADOOP-14398.00.patch, HADOOP-14398.01.patch, HADOOP-14398.02.patch
>
>
> After finishes the API, we should update the document to describe the interface, capability
and contract which the APIs hold. 



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org


Mime
View raw message