hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mi...@apache.org
Subject [26/52] [partial] hbase-site git commit: Published site at 75c23605430266da0f30eef04b97ebd4b30c60b8.
Date Tue, 31 May 2016 17:50:57 GMT
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/db523e4d/book.html
----------------------------------------------------------------------
diff --git a/book.html b/book.html
index 138c0d6..d107f54 100644
--- a/book.html
+++ b/book.html
@@ -28705,32 +28705,44 @@ It provides a nice overview that applies equally to the Apache HBase
Project.</p
 <div class="sect3">
 <h4 id="submitting.patches.create"><a class="anchor" href="#submitting.patches.create"></a>150.8.1.
Create Patch</h4>
 <div class="paragraph">
-<p>The script <em>dev-support/make_patch.sh</em> has been provided to help
you adhere to patch-creation guidelines.
-The script has the following syntax:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>$ make_patch.sh [-a] [-p &lt;patch_dir&gt;]</pre>
-</div>
+<p>Use <em>dev-support/submit-patch.py</em> to create patches and optionally,
upload to jira and update
+reviews on Review Board. Patch name is formatted as (JIRA).(branch name).(patch number).patch
to
+follow Yetus' naming rules. Use <code>-h</code> flag to know detailed usage information.
Most useful options
+are:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
-<p>If you do not pass a <code>patch_dir</code>, the script defaults to
<em>~/patches/</em>.
-If the <code>patch_dir</code> does not exist, it is created.</p>
+<p><code>-b BRANCH, --branch BRANCH</code> : Specify base branch for generating
the diff. If not specified, tracking branch is used. If there is no tracking branch, error
will be thrown.</p>
 </li>
 <li>
-<p>By default, if an existing patch exists with the JIRA ID, the version of the new
patch is incremented (<em>HBASE-XXXX-v3.patch</em>). If the <code>-a</code>
                           option is passed, the version is not incremented, but the suffix
<code>-addendum</code> is added (<em>HBASE-XXXX-v2-addendum.patch</em>).
A second addendum to a given version is not supported.</p>
-</li>
-<li>
-<p>Detects whether you have more than one local commit on your branch.
-If you do, the script offers you the chance to run git rebase
--i to squash the changes into a single commit so that it can use git format-patch.
-If you decline, the script uses git diff instead.
-The patch is saved in a configurable directory and is ready to be attached to your JIRA.</p>
+<p><code>-jid JIRA_ID, --jira-id JIRA_ID</code> : Jira id of the issue.
If set, we deduce next patch version from attachments in the jira and also upload the new
patch. Script will ask for jira username/password for authentication. If not set, patch is
named &lt;branch&gt;.patch.</p>
 </li>
 </ol>
 </div>
+<div class="paragraph">
+<p>The script builds a new patch, and uses REST API to upload it to the jira (if --jira-id
is
+specified) and update the review on ReviewBoard (if --skip-review-board not specified).
+Remote links in the jira are used to figure out if a review request already exists. If no
review
+request is present, then creates a new one and populates all required fields using jira summary,
+patch description, etc. Also adds this review&#8217;s link to the jira.</p>
+</div>
+<div class="dlist">
+<dl>
+<dt class="hdlist1">Authentication</dt>
+<dd>
+<p>Since attaching patches on JIRA and creating/changing review request on ReviewBoard
requires a
+logged in user, the script will prompt you for username and password. To avoid the hassle
every
+time, set up <code>~/.apache-creds</code> with login details and encrypt it by
following the steps in footer
+of script&#8217;s help message.</p>
+</dd>
+<dt class="hdlist1">Python dependencies</dt>
+<dd>
+<p>To install required python dependencies, execute
+<code>pip install -r dev-support/python-requirements.txt</code> from the master
branch.</p>
+</dd>
+</dl>
+</div>
 <div class="ulist">
 <div class="title">Patching Workflow</div>
 <ul>
@@ -28744,23 +28756,14 @@ If necessary, squash local commits to merge local commits into a
single one firs
 See this <a href="http://stackoverflow.com/questions/5308816/how-to-use-git-merge-squash">Stack
Overflow question</a> for more information about squashing commits.</p>
 </li>
 <li>
-<p>The patch should have the JIRA ID in the name.
-If you are generating from a branch, include the target branch in the filename.
-A common naming scheme for patches is:</p>
-<div class="listingblock">
-<div class="content">
-<pre>HBASE-XXXX.patch</pre>
-</div>
-</div>
+<p>Patch name should be as follows to adhere to Yetus' naming convention.</p>
 <div class="listingblock">
 <div class="content">
-<pre>HBASE-XXXX-0.90.patch     # to denote that the patch is against branch 0.90</pre>
+<pre>(JIRA).(branch name).(patch number).patch</pre>
 </div>
 </div>
-<div class="listingblock">
-<div class="content">
-<pre>HBASE-XXXX-v3.patch       # to denote that this is the third version of the patch</pre>
-</div>
+<div class="paragraph">
+<p>For eg. HBASE-11625.master.001.patch, HBASE-XXXXX.branch-1.2.0005.patch, etc.</p>
 </div>
 </li>
 <li>
@@ -28779,10 +28782,7 @@ See <a href="#reviewboard">reviewboard</a>.</p>
 <p>If you need to revise your patch, leave the previous patch file(s) attached to the
JIRA, and upload the new one, following the naming conventions in <a href="#submitting.patches.create">submitting.patches.create</a>.
 Cancel the Patch Available flag and then re-trigger it, by toggling the <b class="button">Patch
Available</b> button in JIRA.
 JIRA sorts attached files by the time they were attached, and has no problem with multiple
attachments with the same name.
-However, at times it is easier to refer to different version of a patch if you add <code>-vX</code>,
where the <em class="replaceable">X</em> is the version (starting with 2).</p>
-</li>
-<li>
-<p>If you need to submit your patch against multiple branches, rather than just master,
name each version of the patch with the branch it is for, following the naming conventions
in <a href="#submitting.patches.create">submitting.patches.create</a>.</p>
+However, at times it is easier to increment patch number in the patch name.</p>
 </li>
 </ul>
 </div>
@@ -33640,7 +33640,7 @@ The server will return cellblocks compressed using this same compressor
as long
 <div id="footer">
 <div id="footer-text">
 Version 2.0.0-SNAPSHOT<br>
-Last updated 2016-04-11 14:30:43 UTC
+Last updated 2016-04-08 14:30:12 UTC
 </div>
 </div>
 </body>

http://git-wip-us.apache.org/repos/asf/hbase-site/blob/db523e4d/bulk-loads.html
----------------------------------------------------------------------
diff --git a/bulk-loads.html b/bulk-loads.html
index fb0ab9b..9a3b2b9 100644
--- a/bulk-loads.html
+++ b/bulk-loads.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20160527" />
+    <meta name="Date-Revision-yyyymmdd" content="20160531" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Apache HBase &#x2013;  
       Bulk Loads in Apache HBase (TM)
@@ -305,7 +305,7 @@ under the License. -->
                         <a href="http://www.apache.org/">The Apache Software Foundation</a>.
             All rights reserved.      
                     
-                  <li id="publishDate" class="pull-right">Last Published: 2016-05-27</li>
+                  <li id="publishDate" class="pull-right">Last Published: 2016-05-31</li>
             </p>
                 </div>
 


Mime
View raw message