hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bob Hansen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-9328) Formalize coding standards for libhdfs++
Date Thu, 19 Nov 2015 16:39:11 GMT

    [ https://issues.apache.org/jira/browse/HDFS-9328?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15013813#comment-15013813

Bob Hansen commented on HDFS-9328:

I'm sorry to revisit the closed issue, but can someone explain the genesis of the commenting
rule?  According to https://wiki.apache.org/hadoop/CodeReviewChecklist, Hadoop follows the
Sun style guide (http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#341),
which is pretty explicit in encouraging // comments: 

bq. The // comment delimiter can comment out a complete line or only a partial line. It shouldn't
be used on consecutive multiple lines for text comments

I count ~70,000 instances of // comments in the current hadoop codebase.

I'm not dead-set against it, but would hate for an out-of-context comment to turn into urban
legend and then into policy.

> Formalize coding standards for libhdfs++
> ----------------------------------------
>                 Key: HDFS-9328
>                 URL: https://issues.apache.org/jira/browse/HDFS-9328
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>          Components: hdfs-client
>            Reporter: James Clampffer
>            Assignee: James Clampffer
>            Priority: Blocker
>             Fix For: HDFS-8707
>         Attachments: HDFS-9328.HDFS-8707.000.patch, HDFS-9328.HDFS-8707.001.patch, HDFS-9328.HDFS-8707.002.patch,
HDFS-9328.HDFS-8707.003.patch, HDFS-9328.HDFS-8707.004.patch
> We have 2-3 people working on this project full time and hopefully more people will start
contributing.  In order to efficiently scale we need a single, easy to find, place where developers
can check to make sure they are following the coding standards of this project to both save
their time and save the time of people doing code reviews.
> The most practical place to do this seems like a README file in libhdfspp/. 
> The foundation of the standards is google's C++ guide found here: https://google-styleguide.googlecode.com/svn/trunk/cppguide.html
> Any exceptions to google's standards or additional restrictions need to be explicitly
enumerated so there is one single point of reference for all libhdfs++ code standards.

This message was sent by Atlassian JIRA

View raw message