HBase
  1. HBase
  2. HBASE-11855

HBase handbook chapter 18.9 out of date

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.0.0
    • Fix Version/s: 2.0.0
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      Recently Alex Newman committed a change HBASE-4955 renaming Dsurefire.*PartThreadCount to Dsurefire.*PartForkCount for the 2.0 version.

      I'm excited to help with documentation and the webpage going forward. Can someone help mentor me with the process? Thanks.

      1. hbase-11855-v2.patch
        3 kB
        Michael Tauscher
      2. hbase-11855-v1.patch
        2 kB
        Michael Tauscher
      3. hbase-11855-v0.patch
        1 kB
        Michael Tauscher

        Activity

        Hide
        Hudson added a comment -

        FAILURE: Integrated in HBase-TRUNK #5460 (See https://builds.apache.org/job/HBase-TRUNK/5460/)
        HBASE-11855 HBase handbook chapter 18.9 out of date (Michael Tauscher) (stack: rev 767aced0f90b740dbc5a4141380b0276802c0d8b)

        • src/main/docbkx/developer.xml
        Show
        Hudson added a comment - FAILURE: Integrated in HBase-TRUNK #5460 (See https://builds.apache.org/job/HBase-TRUNK/5460/ ) HBASE-11855 HBase handbook chapter 18.9 out of date (Michael Tauscher) (stack: rev 767aced0f90b740dbc5a4141380b0276802c0d8b) src/main/docbkx/developer.xml
        Hide
        stack added a comment -

        Committed. Thanks for patch Michael (nice reviews reviewers)

        Show
        stack added a comment - Committed. Thanks for patch Michael (nice reviews reviewers)
        Hide
        Misty Stanley-Jones added a comment -

        +1 to v2. Thanks for your help, Michael Tauscher!

        Show
        Misty Stanley-Jones added a comment - +1 to v2. Thanks for your help, Michael Tauscher !
        Hide
        Michael Tauscher added a comment -

        Denormalized the <screen> indentation and changed instances of 'Gb' to 'GB' per Misty Stanley-Jones.

        Thanks again to everyone for the help!

        Show
        Michael Tauscher added a comment - Denormalized the <screen> indentation and changed instances of 'Gb' to 'GB' per Misty Stanley-Jones . Thanks again to everyone for the help!
        Hide
        Misty Stanley-Jones added a comment -

        Looks good to me, with some nits:

        1. When using a <screen> or <programlisting> tag, you need to "denormalize" the indentation of the content within it so that the first level of indentation within the tags is at the left-hand side of the page, so that the indentation is correct in the published output. This is because these tags show their contents (mostly) exactly as they appear in the source file. For instance, change this:

                        <screen language="bourne">$ sudo mkdir /ram2G
                            sudo mount -t tmpfs -o size=2048M tmpfs /ram2G</screen>
        

        to this:

                        <screen language="bourne">$ sudo mkdir /ram2G
        sudo mount -t tmpfs -o size=2048M tmpfs /ram2G</screen>
        

        I know it doesn't look as nice in the source, but it looks better in the output.

        2. I prefer all-caps GB or spelling it out (gigabytes) rather than mixed-case Gb.

        Thanks so much for helping out.

        Show
        Misty Stanley-Jones added a comment - Looks good to me, with some nits: 1. When using a <screen> or <programlisting> tag, you need to "denormalize" the indentation of the content within it so that the first level of indentation within the tags is at the left-hand side of the page, so that the indentation is correct in the published output. This is because these tags show their contents (mostly) exactly as they appear in the source file. For instance, change this: <screen language= "bourne" >$ sudo mkdir /ram2G sudo mount -t tmpfs -o size=2048M tmpfs /ram2G</screen> to this: <screen language= "bourne" >$ sudo mkdir /ram2G sudo mount -t tmpfs -o size=2048M tmpfs /ram2G</screen> I know it doesn't look as nice in the source, but it looks better in the output. 2. I prefer all-caps GB or spelling it out (gigabytes) rather than mixed-case Gb. Thanks so much for helping out.
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12665476/hbase-11855-v1.patch
        against trunk revision .
        ATTACHMENT ID: 12665476

        +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 javac. The applied patch does not increase the total number of javac compiler warnings.

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

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

        +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

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

        -1 lineLengths. The patch introduces the following lines longer than 100:
        + -Dsurefire.secondPartForkCount=12</command>. If using a version earlier than
        + </command>. To increase the speed, you can as well use a ramdisk. You will need 2Gb

        +1 site. The mvn site goal succeeds with this patch.

        -1 core tests. The patch failed these unit tests:
        org.apache.hadoop.hbase.TestRegionRebalancing

        Test results: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//testReport/
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop-compat.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-protocol.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-common.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-thrift.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop2-compat.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-server.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-examples.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-prefix-tree.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-client.html
        Console output: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//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/12665476/hbase-11855-v1.patch against trunk revision . ATTACHMENT ID: 12665476 +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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 findbugs . The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. -1 lineLengths . The patch introduces the following lines longer than 100: + -Dsurefire.secondPartForkCount=12</command>. If using a version earlier than + </command>. To increase the speed, you can as well use a ramdisk. You will need 2Gb +1 site . The mvn site goal succeeds with this patch. -1 core tests . The patch failed these unit tests: org.apache.hadoop.hbase.TestRegionRebalancing Test results: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//testReport/ Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop-compat.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-protocol.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-common.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-thrift.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop2-compat.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-server.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-examples.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-prefix-tree.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//artifact/patchprocess/newPatchFindbugsWarningshbase-client.html Console output: https://builds.apache.org/job/PreCommit-HBASE-Build/10653//console This message is automatically generated.
        Hide
        Michael Tauscher added a comment -

        Rewrote to accommodate 1.0 and 2.0 per Sean Busbey's comment

        Show
        Michael Tauscher added a comment - Rewrote to accommodate 1.0 and 2.0 per Sean Busbey 's comment
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12665430/hbase-11855-v0.patch
        against trunk revision .
        ATTACHMENT ID: 12665430

        +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 javac. The applied patch does not increase the total number of javac compiler warnings.

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

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

        +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

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

        +1 lineLengths. The patch does not introduce lines longer than 100

        +1 site. The mvn site goal succeeds with this patch.

        -1 core tests. The patch failed these unit tests:
        org.apache.hadoop.hbase.TestRegionRebalancing

        -1 core zombie tests. There are 1 zombie test(s):

        Test results: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//testReport/
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop-compat.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-protocol.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-common.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-thrift.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop2-compat.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-server.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-examples.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-prefix-tree.html
        Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-client.html
        Console output: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//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/12665430/hbase-11855-v0.patch against trunk revision . ATTACHMENT ID: 12665430 +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 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 findbugs . The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 lineLengths . The patch does not introduce lines longer than 100 +1 site . The mvn site goal succeeds with this patch. -1 core tests . The patch failed these unit tests: org.apache.hadoop.hbase.TestRegionRebalancing -1 core zombie tests . There are 1 zombie test(s): Test results: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//testReport/ Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop-compat.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-protocol.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-common.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-thrift.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop2-compat.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-server.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-examples.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-prefix-tree.html Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//artifact/patchprocess/newPatchFindbugsWarningshbase-client.html Console output: https://builds.apache.org/job/PreCommit-HBASE-Build/10649//console This message is automatically generated.
        Hide
        stack added a comment -

        Yes

        Show
        stack added a comment - Yes
        Hide
        Michael Tauscher added a comment -

        I'd be happy to, what's the best practice here?

        Can I add a line saying something like, "If using a version earlier than 2.0, do: mvn test -P runAllTests -Dsurefire.secondPartThreadCount=12."?

        Show
        Michael Tauscher added a comment - I'd be happy to, what's the best practice here? Can I add a line saying something like, "If using a version earlier than 2.0, do: mvn test -P runAllTests -Dsurefire.secondPartThreadCount=12 ."?
        Hide
        Sean Busbey added a comment -

        Thanks for hte start Michael. As Alex mentions, this will only work for version 2.0.

        We keep a single version of the book for all supported versions. Could you rework it so it calls out what to do in 2.0 vs earlier?

        Show
        Sean Busbey added a comment - Thanks for hte start Michael. As Alex mentions, this will only work for version 2.0. We keep a single version of the book for all supported versions. Could you rework it so it calls out what to do in 2.0 vs earlier?
        Hide
        Alex Newman added a comment -

        For reviewers. This is correct in hbase 2 but not earlier. Thus we should only push this change to the correct version of the handbook

        Show
        Alex Newman added a comment - For reviewers. This is correct in hbase 2 but not earlier. Thus we should only push this change to the correct version of the handbook
        Hide
        Michael Tauscher added a comment -

        I did it

        Show
        Michael Tauscher added a comment - I did it
        Hide
        Michael Tauscher added a comment -

        Thanks Misty Stanley-Jones and Sean Busbey again, consider me unofficially assigned to this - I've got a patch coming today.

        Show
        Michael Tauscher added a comment - Thanks Misty Stanley-Jones and Sean Busbey again, consider me unofficially assigned to this - I've got a patch coming today.
        Hide
        Sean Busbey added a comment -

        If you haven't made a contribution previously, you won't yet be in the list of people who can be assigned to. Until a committer adds you, a note in a comment here is sufficient.

        Show
        Sean Busbey added a comment - If you haven't made a contribution previously, you won't yet be in the list of people who can be assigned to. Until a committer adds you, a note in a comment here is sufficient.
        Hide
        Misty Stanley-Jones added a comment -

        Sure, just ping me if you need help. Don't forget to assign this JIRA to yourself if you want to work on it.Thanks for stepping up to help!

        Show
        Misty Stanley-Jones added a comment - Sure, just ping me if you need help. Don't forget to assign this JIRA to yourself if you want to work on it.Thanks for stepping up to help!
        Hide
        Michael Tauscher added a comment -

        Thanks Sean Busbey

        Show
        Michael Tauscher added a comment - Thanks Sean Busbey
        Hide
        Sean Busbey added a comment -

        Take a look at our new appendix on helping with documentation.

        It should guide you through what you need to do to update that part of the book.

        Show
        Sean Busbey added a comment - Take a look at our new appendix on helping with documentation . It should guide you through what you need to do to update that part of the book.
        Hide
        Alex Newman added a comment -

        Good catch. I knew I forgot something. Since it is your first documentation issue perhaps Misty Stanley-Jones can help out.

        Show
        Alex Newman added a comment - Good catch. I knew I forgot something. Since it is your first documentation issue perhaps Misty Stanley-Jones can help out.

          People

          • Assignee:
            Michael Tauscher
            Reporter:
            Michael Tauscher
          • Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development