[jira] [Created] (HADOOP-17047) TODO comments exist in trunk while the related issues are already fixed.

["Rungroj Maipradit (Jira)" <ji...@apache.org>]

Rungroj Maipradit created HADOOP-17047:
------------------------------------------

             Summary: TODO comments exist in trunk while the related issues are already fixed.
                 Key: HADOOP-17047
                 URL: https://issues.apache.org/jira/browse/HADOOP-17047
             Project: Hadoop Common
          Issue Type: Improvement
            Reporter: Rungroj Maipradit


In a research project, we analyzed the source code of Hadoop looking for comments with on-hold SATDs (self-admitted technical debt) that could be fixed already. An on-hold SATD is a TODO/FIXME comment blocked by an issue. If this blocking issue is already resolved, the related todo can be implemented (or sometimes it is already implemented, but the comment is left in the code causing confusions). As we found a few instances of these in Hadoop, we decided to collect them in a ticket, so they are documented and can be addressed sooner or later.

A list of code comments that mention already closed issues.
 * A code comment suggests making the setJobConf method deprecated along with a mapred package HADOOP-1230. HADOOP-1230 has been closed a long time ago, but the method is still not annotated as deprecated.
{code:java}
 /**
   * This code is to support backward compatibility and break the compile  
   * time dependency of core on mapred.
   * This should be made deprecated along with the mapred package HADOOP-1230. 
   * Should be removed when mapred package is removed.
   */ {code}
Comment location: [https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/ReflectionUtils.java#L88]

 * A comment mentions that the return type of the getDefaultFileSystem method should be changed to AFS when HADOOP-6223 is completed.
 Indeed, this change was done in the related commit of HADOOP-6223: ([https://github.com/apache/hadoop/commit/3f371a0a644181b204111ee4e12c995fc7b5e5f5#diff-cd86a2b9ce3efd2232c2ace0e9084508L395)]
 Thus, the comment could be removed.
{code:java}
@InterfaceStability.Unstable /* return type will change to AFS once
HADOOP-6223 is completed */
{code}
Comment location: [https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileContext.java#L512]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

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