Hadoop Common
  1. Hadoop Common
  2. HADOOP-4719

The ls shell command documentation is out-dated

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.18.2
    • Fix Version/s: 0.19.2
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      Current ls output is

      bash-3.2$ ./bin/hadoop fs -ls  
      Found 1 items
      -rw-r--r--   3 tsz supergroup       1366 2008-11-24 16:58 /user/tsz/r.txt
      

      but the doc says "dirname <dir> modification_time modification_time permissions userid groupid". See http://hadoop.apache.org/core/docs/r0.18.2/hdfs_shell.html#ls

      1. hdfs_shell.patch
        2 kB
        Ravi Phulari
      2. Hadoop-4719-3.patch
        1 kB
        Ravi Phulari

        Activity

        Hide
        Hudson added a comment -

        Integrated in Hadoop-trunk #790 (See http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/790/)
        . Fix documentation of 'ls' format for FsShell. Contributed by Ravi Phulari

        Show
        Hudson added a comment - Integrated in Hadoop-trunk #790 (See http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/790/ ) . Fix documentation of 'ls' format for FsShell. Contributed by Ravi Phulari
        Hide
        Chris Douglas added a comment -

        I committed this. Thanks, Ravi

        Show
        Chris Douglas added a comment - I committed this. Thanks, Ravi
        Hide
        Chris Douglas added a comment -

        Technically, the owner and group are optional in the output (in support of FileSystems like KFS: HADOOP-4335). I have no strong convictions about including this point in the docs; we can open another issue if it causes confusion.

        +1

        Show
        Chris Douglas added a comment - Technically, the owner and group are optional in the output (in support of FileSystems like KFS: HADOOP-4335 ). I have no strong convictions about including this point in the docs; we can open another issue if it causes confusion. +1
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12402605/Hadoop-4719-3.patch
        against trunk revision 756152.

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 findbugs. The patch does not introduce any new Findbugs warnings.

        +1 Eclipse classpath. The patch retains Eclipse classpath integrity.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed core unit tests.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/artifact/trunk/build/test/checkstyle-errors.html
        Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - +1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12402605/Hadoop-4719-3.patch against trunk revision 756152. +1 @author. The patch does not contain any @author tags. +0 tests included. The patch appears to be a documentation patch that doesn't require tests. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs warnings. +1 Eclipse classpath. The patch retains Eclipse classpath integrity. +1 release audit. The applied patch does not increase the total number of release audit warnings. +1 core tests. The patch passed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/110/console This message is automatically generated.
        Hide
        Ravi Phulari added a comment -

        Submitting correct patch .

        Output of ant test docs

        [exec] -----------------------------
        [exec] Static site was successfully generated at:
        [exec] /home/rphulari/hadoop/src/docs/cn/build/site
        [exec] ------------------------------
        [exec]
        [exec]
        [exec] BUILD SUCCESSFUL
        [exec] Total time: 39 seconds
        [copy] Copying 107 files to /home/rphulari/hadoop/build/docs/cn
        [copy] Copied 7 empty directories to 3 empty directories under /home/rphulari/hadoop/build/docs/cn
        [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
        [style] Transforming into /home/rphulari/hadoop/build/docs/cn
        [style] Processing /home/rphulari/hadoop/src/core/core-default.xml to /home/rphulari/hadoop/build/docs/cn/core-default.html
        [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl
        [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
        [style] Transforming into /home/rphulari/hadoop/build/docs/cn
        [style] Processing /home/rphulari/hadoop/src/hdfs/hdfs-default.xml to /home/rphulari/hadoop/build/docs/cn/hdfs-default.html
        [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl
        [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
        [style] Transforming into /home/rphulari/hadoop/build/docs/cn
        [style] Processing /home/rphulari/hadoop/src/mapred/mapred-default.xml to /home/rphulari/hadoop/build/docs/cn/mapred-default.html
        [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl

        changes-to-html:

        BUILD SUCCESSFUL

        Show
        Ravi Phulari added a comment - Submitting correct patch . Output of ant test docs [exec] ----------------------------- [exec] Static site was successfully generated at: [exec] /home/rphulari/hadoop/src/docs/cn/build/site [exec] ------------------------------ [exec] [exec] [exec] BUILD SUCCESSFUL [exec] Total time: 39 seconds [copy] Copying 107 files to /home/rphulari/hadoop/build/docs/cn [copy] Copied 7 empty directories to 3 empty directories under /home/rphulari/hadoop/build/docs/cn [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /home/rphulari/hadoop/build/docs/cn [style] Processing /home/rphulari/hadoop/src/core/core-default.xml to /home/rphulari/hadoop/build/docs/cn/core-default.html [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /home/rphulari/hadoop/build/docs/cn [style] Processing /home/rphulari/hadoop/src/hdfs/hdfs-default.xml to /home/rphulari/hadoop/build/docs/cn/hdfs-default.html [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /home/rphulari/hadoop/build/docs/cn [style] Processing /home/rphulari/hadoop/src/mapred/mapred-default.xml to /home/rphulari/hadoop/build/docs/cn/mapred-default.html [style] Loading stylesheet /home/rphulari/hadoop/conf/configuration.xsl changes-to-html: BUILD SUCCESSFUL
        Hide
        Ravi Phulari added a comment -

        Canceling patch to resubmit correct patch.

        Show
        Ravi Phulari added a comment - Canceling patch to resubmit correct patch.
        Hide
        Tsz Wo Nicholas Sze added a comment -
            [exec] validate-xdocs:
             [exec] /home/tsz/hadoop/testing/src/docs/src/documentation/content/xdocs/hdfs_shell.xml:221:65: The element type "code" must be terminated by the matching end-tag "</code>".
             [exec] 
             [exec] BUILD FAILED
        

        The patch does not work.

        Show
        Tsz Wo Nicholas Sze added a comment - [exec] validate-xdocs: [exec] /home/tsz/hadoop/testing/src/docs/src/documentation/content/xdocs/hdfs_shell.xml:221:65: The element type "code" must be terminated by the matching end-tag "</code>". [exec] [exec] BUILD FAILED The patch does not work.
        Hide
        Ravi Phulari added a comment -

        Did not run tests . Just document change.

        Show
        Ravi Phulari added a comment - Did not run tests . Just document change.
        Hide
        Ravi Phulari added a comment -

        Canceling patch to fix issue raised by Nicholas

        Show
        Ravi Phulari added a comment - Canceling patch to fix issue raised by Nicholas
        Hide
        Tsz Wo Nicholas Sze added a comment -

        "&lt;number of replicas&gt;" should be changed to "number_of_replicas" since the ls output does not contain '<' and '>' anymore.

        Show
        Tsz Wo Nicholas Sze added a comment - "&lt;number of replicas&gt;" should be changed to "number_of_replicas" since the ls output does not contain '<' and '>' anymore.
        Hide
        Ravi Phulari added a comment -

        Did not run tests . Change in documentation .

        Show
        Ravi Phulari added a comment - Did not run tests . Change in documentation .

          People

          • Assignee:
            Ravi Phulari
            Reporter:
            Tsz Wo Nicholas Sze
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development