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

Steve Loughran updated HADOOP-13605:
------------------------------------
    Attachment: HADOOP-13605-branch-2-002.patch

HADOOP-13605 patch 002: 
* read the javadocs and make them consistent with what happens
* use consistently FileSystem to refer to instance of the class, filesystem to 
refer to the place where files live
* explain that and other things in the introduction
* trim all trailing whitespace
* fix up the <p/> references and a few other javadoc issues
* fix the failing test

My IDE is mostly happy now, the javadocs are in sync with the FS spec

> Clean up FileSystem javadocs, logging; improve diagnostics on FS load
> ---------------------------------------------------------------------
>
>                 Key: HADOOP-13605
>                 URL: https://issues.apache.org/jira/browse/HADOOP-13605
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: fs
>    Affects Versions: 2.8.0
>            Reporter: Steve Loughran
>            Assignee: Steve Loughran
>         Attachments: HADOOP-13605-branch-2-001.patch, 
> HADOOP-13605-branch-2-002.patch
>
>
> We can't easily debug FS instantiation problems as there isn't much detail in 
> what was going on.
> We can add more logging, but cannot simply switch {{FileSystem.LOG}} to SLF4J 
> —the class is used in too many places, including tests which cast it. 
> Instead, add a new private SLF4J Logger, {{LOGGER}} and switch logging to it. 
> While working in the base FileSystem class, take the opportunity to clean up 
> javadocs and comments
> # add the list of exceptions, including indicating which base classes throw 
> UnsupportedOperationExceptions
> # cut bits in the comments which are not true
> The outcome of this patch is that IDEs shouldn't highlight most of the file 
> as flawed in some way or another



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

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

Reply via email to