Hadoop HDFS
  1. Hadoop HDFS
  2. HDFS-352

saveNamespace command should be documented.

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.20.1
    • Fix Version/s: 0.21.0
    • Component/s: documentation
    • Labels:
      None

      Description

      Document admin command saveNamespace introduced in HADOOP-4826.

      1. HADOOP-5501new.patch
        12 kB
        Konstantin Shvachko
      2. HADOOP-5501new.patch
        12 kB
        Ravi Phulari
      3. HADOOP-5501.patch
        10 kB
        Ravi Phulari

        Issue Links

          Activity

          Hide
          Ravi Phulari added a comment -

          Documented saveNamespace and other missing dfsadmin commands. Documentation change in src/docs/src/documentation/content/xdocs/commands_manual.xml . Verified web page for correctness . No unit tests required as no code changes made.

           
             [exec] 
               [exec] -----------------------------
               [exec] Static site was successfully generated at:
               [exec] /Users/rphulari/dev/HWorkSpace/Hadoop/src/docs/cn/build/site
               [exec] ------------------------------
               [exec]     
               [exec] 
               [exec] BUILD SUCCESSFUL
               [exec] Total time: 41 seconds
               [copy] Copying 100 files to /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn
              [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
              [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn
              [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
              [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn
              [style] Warning: the task name <style> is deprecated. Use <xslt> instead.
              [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn
              [style] Processing /Users/rphulari/dev/HWorkSpace/Hadoop/src/mapred/mapred-default.xml to /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn/mapred-default.html
              [style] Loading stylesheet /Users/rphulari/dev/HWorkSpace/Hadoop/conf/configuration.xsl
          
          changes-to-html:
          
          BUILD SUCCESSFUL
          
          Show
          Ravi Phulari added a comment - Documented saveNamespace and other missing dfsadmin commands. Documentation change in src/docs/src/documentation/content/xdocs/commands_manual.xml . Verified web page for correctness . No unit tests required as no code changes made. [exec] [exec] ----------------------------- [exec] Static site was successfully generated at: [exec] /Users/rphulari/dev/HWorkSpace/Hadoop/src/docs/cn/build/site [exec] ------------------------------ [exec] [exec] [exec] BUILD SUCCESSFUL [exec] Total time: 41 seconds [copy] Copying 100 files to /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn [style] Warning: the task name <style> is deprecated. Use <xslt> instead. [style] Transforming into /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn [style] Processing /Users/rphulari/dev/HWorkSpace/Hadoop/src/mapred/mapred-default.xml to /Users/rphulari/dev/HWorkSpace/Hadoop/build/docs/cn/mapred-default.html [style] Loading stylesheet /Users/rphulari/dev/HWorkSpace/Hadoop/conf/configuration.xsl changes-to-html: BUILD SUCCESSFUL
          Hide
          Hadoop QA added a comment -

          -1 overall. Here are the results of testing the latest attachment
          http://issues.apache.org/jira/secure/attachment/12409054/HADOOP-5501.patch
          against trunk revision 779448.

          +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 failed contrib unit tests.

          Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/testReport/
          Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
          Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/artifact/trunk/build/test/checkstyle-errors.html
          Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/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/12409054/HADOOP-5501.patch against trunk revision 779448. +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 failed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/418/console This message is automatically generated.
          Hide
          Ravi Phulari added a comment -

          Contrib tests failures are unrelated to changes made in this patch.

          Show
          Ravi Phulari added a comment - Contrib tests failures are unrelated to changes made in this patch.
          Hide
          Konstantin Shvachko added a comment -
          1. It would be better to move the description of -setSpaceQuota and -clrSpaceQuota right after the descriptions of -setQuota and -clrQuota.
          2. I did not get what "Best effort for the directory" means, and why it is followed by ',' in the first occasion but with the "." in the second.

          The rest looks good.

          Show
          Konstantin Shvachko added a comment - It would be better to move the description of -setSpaceQuota and -clrSpaceQuota right after the descriptions of -setQuota and -clrQuota. I did not get what "Best effort for the directory" means, and why it is followed by ',' in the first occasion but with the "." in the second. The rest looks good.
          Hide
          Tsz Wo Nicholas Sze added a comment -

          Links to HADOOP-5937.

          Show
          Tsz Wo Nicholas Sze added a comment - Links to HADOOP-5937 .
          Hide
          Robert Chansler added a comment -

          How about replacing the "best effort" line for each of the quota commands with words like:

          For each directory, attempt to set the quota. An error will be reported if:

          Show
          Robert Chansler added a comment - How about replacing the "best effort" line for each of the quota commands with words like: For each directory, attempt to set the quota. An error will be reported if:
          Hide
          Ravi Phulari added a comment -

          This patch documents saveNamespace command . Also corrects quota commands documentation .

               [exec] 
               [exec] 
               [exec] 
               [exec] -1 overall.  
               [exec] 
               [exec]     +1 @author.  The patch does not contain any @author tags.
               [exec] 
               [exec]     -1 tests included.  The patch doesn't appear to include any new or modified tests.
               [exec]                         Please justify why no tests are needed for this patch.
               [exec] 
               [exec]     +1 javadoc.  The javadoc tool did not generate any warning messages.
               [exec] 
               [exec]     +1 javac.  The applied patch does not increase the total number of javac compiler warnings.
               [exec] 
               [exec]     +1 findbugs.  The patch does not introduce any new Findbugs warnings.
               [exec] 
               [exec]     +1 Eclipse classpath. The patch retains Eclipse classpath integrity.
               [exec] 
               [exec]     +1 release audit.  The applied patch does not increase the total number of release audit warnings.
               [exec] 
               [exec] 
               [exec] 
               [exec] 
               [exec] ======================================================================
               [exec] ======================================================================
               [exec]     Finished build.
               [exec] ======================================================================
               [exec] ======================================================================
               [exec] 
               [exec] 
          
          Show
          Ravi Phulari added a comment - This patch documents saveNamespace command . Also corrects quota commands documentation . [exec] [exec] [exec] [exec] -1 overall. [exec] [exec] +1 @author. The patch does not contain any @author tags. [exec] [exec] -1 tests included. The patch doesn't appear to include any new or modified tests. [exec] Please justify why no tests are needed for this patch. [exec] [exec] +1 javadoc. The javadoc tool did not generate any warning messages. [exec] [exec] +1 javac. The applied patch does not increase the total number of javac compiler warnings. [exec] [exec] +1 findbugs. The patch does not introduce any new Findbugs warnings. [exec] [exec] +1 Eclipse classpath. The patch retains Eclipse classpath integrity. [exec] [exec] +1 release audit. The applied patch does not increase the total number of release audit warnings. [exec] [exec] [exec] [exec] [exec] ====================================================================== [exec] ====================================================================== [exec] Finished build. [exec] ====================================================================== [exec] ====================================================================== [exec] [exec]
          Hide
          Ravi Phulari added a comment -

          Konstantin thanks for reviewing patch and comments , I have corrected quota description as per Rob Chansler's suggestion . Thanks for input Rob.

          Show
          Ravi Phulari added a comment - Konstantin thanks for reviewing patch and comments , I have corrected quota description as per Rob Chansler's suggestion . Thanks for input Rob.
          Hide
          Ravi Phulari added a comment -

          Resubmitting patch with tests for dfsadmin help command.

               [exec] 
               [exec] 
               [exec] 
               [exec] +1 overall.  
               [exec] 
               [exec]     +1 @author.  The patch does not contain any @author tags.
               [exec] 
               [exec]     +1 tests included.  The patch appears to include 3 new or modified tests.
               [exec] 
               [exec]     +1 javadoc.  The javadoc tool did not generate any warning messages.
               [exec] 
               [exec]     +1 javac.  The applied patch does not increase the total number of javac compiler warnings.
               [exec] 
               [exec]     +1 findbugs.  The patch does not introduce any new Findbugs warnings.
               [exec] 
               [exec]     +1 Eclipse classpath. The patch retains Eclipse classpath integrity.
               [exec] 
               [exec]     +1 release audit.  The applied patch does not increase the total number of release audit warnings.
               [exec] 
               [exec] 
               [exec] 
               [exec] 
               [exec] ======================================================================
               [exec] ======================================================================
               [exec]     Finished build.
               [exec] ======================================================================
               [exec] ======================================================================
               [exec] 
               [exec] 
          
          BUILD SUCCESSFUL
          Total time: 23 minutes 42 seconds
          
          
          Show
          Ravi Phulari added a comment - Resubmitting patch with tests for dfsadmin help command. [exec] [exec] [exec] [exec] +1 overall. [exec] [exec] +1 @author. The patch does not contain any @author tags. [exec] [exec] +1 tests included. The patch appears to include 3 new or modified tests. [exec] [exec] +1 javadoc. The javadoc tool did not generate any warning messages. [exec] [exec] +1 javac. The applied patch does not increase the total number of javac compiler warnings. [exec] [exec] +1 findbugs. The patch does not introduce any new Findbugs warnings. [exec] [exec] +1 Eclipse classpath. The patch retains Eclipse classpath integrity. [exec] [exec] +1 release audit. The applied patch does not increase the total number of release audit warnings. [exec] [exec] [exec] [exec] [exec] ====================================================================== [exec] ====================================================================== [exec] Finished build. [exec] ====================================================================== [exec] ====================================================================== [exec] [exec] BUILD SUCCESSFUL Total time: 23 minutes 42 seconds
          Hide
          Hadoop QA added a comment -

          -1 overall. Here are the results of testing the latest attachment
          http://issues.apache.org/jira/secure/attachment/12409864/HADOOP-5501new.patch
          against trunk revision 781816.

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

          +1 tests included. The patch appears to include 3 new or modified 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 failed contrib unit tests.

          Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/testReport/
          Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
          Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/artifact/trunk/build/test/checkstyle-errors.html
          Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/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/12409864/HADOOP-5501new.patch against trunk revision 781816. +1 @author. The patch does not contain any @author tags. +1 tests included. The patch appears to include 3 new or modified 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 failed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-vesta.apache.org/465/console This message is automatically generated.
          Hide
          Konstantin Shvachko added a comment -

          I just committed this. Thank you Ravi.

          Show
          Konstantin Shvachko added a comment - I just committed this. Thank you Ravi.
          Hide
          Konstantin Shvachko added a comment -

          Due to the projects split the location of some files changed. Replaced "src/hdfs" with "src/java".

          Show
          Konstantin Shvachko added a comment - Due to the projects split the location of some files changed. Replaced "src/hdfs" with "src/java".
          Hide
          Hudson added a comment -

          Integrated in Hadoop-Hdfs-trunk #8 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Hdfs-trunk/8/)

          Show
          Hudson added a comment - Integrated in Hadoop-Hdfs-trunk #8 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Hdfs-trunk/8/ )

            People

            • Assignee:
              Ravi Phulari
              Reporter:
              Konstantin Shvachko
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development