You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@yetus.apache.org by se...@apache.org on 2016/07/28 12:36:33 UTC
yetus git commit: git hash 5a8383c32a0295dcf4c813d056433dc3f5009d17
Repository: yetus
Updated Branches:
refs/heads/asf-site 1d0d8e96a -> f25b5e829
git hash 5a8383c32a0295dcf4c813d056433dc3f5009d17
Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/f25b5e82
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/f25b5e82
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/f25b5e82
Branch: refs/heads/asf-site
Commit: f25b5e8293f8b332089b999ac374539c6287cdf0
Parents: 1d0d8e9
Author: Kengo Seki <se...@apache.org>
Authored: Thu Jul 28 12:36:16 2016 +0000
Committer: Kengo Seki <se...@apache.org>
Committed: Thu Jul 28 12:36:16 2016 +0000
----------------------------------------------------------------------
.../in-progress/releasedocmaker/index.html | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/yetus/blob/f25b5e82/documentation/in-progress/releasedocmaker/index.html
----------------------------------------------------------------------
diff --git a/documentation/in-progress/releasedocmaker/index.html b/documentation/in-progress/releasedocmaker/index.html
index 0730e00..3bbb8a9 100644
--- a/documentation/in-progress/releasedocmaker/index.html
+++ b/documentation/in-progress/releasedocmaker/index.html
@@ -130,8 +130,11 @@
<li><a href="#changing-the-header">Changing the Header</a></li>
<li><a href="#multiple-versions">Multiple Versions</a></li>
<li><a href="#unreleased-dates">Unreleased Dates</a></li>
+<li><a href="#sorted-output">Sorted Output</a></li>
+<li><a href="#backward-incompatible-changes">Backward Incompatible Changes</a></li>
<li><a href="#lint-mode">Lint Mode</a></li>
<li><a href="#index-mode">Index Mode</a></li>
+<li><a href="#release-version">Release Version</a></li>
</ul>
<h1 id="purpose">Purpose</h1>
@@ -226,11 +229,11 @@ remaining text
<h2 id="resolution-date-base-sort">Resolution Date-base Sort</h2>
<p>By default, releasedocmaker will sort the output based upon the resolution date of the issue starting with older resolutions. This is the same as giving these options:</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --sorttype<span class="o">=</span>releasedate --sortorder<span class="o">=</span>older
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder older
</code></pre>
<p>The order can be reversed so that newer issues appear on top by providing the ‘newer’ flag:</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --sorttype<span class="o">=</span>releasedate --sortorder<span class="o">=</span>newer
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder newer
</code></pre>
<p>In the case of multiple projects given on the command line, the projects will be interspersed.</p>
@@ -238,13 +241,13 @@ remaining text
<h2 id="issue-number-based-sort">Issue Number-based Sort</h2>
<p>An alternative to the date-based sort is to sort based upon the issue id. This may be accomplished via:</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --sorttype<span class="o">=</span>issueid --sortorder<span class="o">=</span>asc
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder asc
</code></pre>
<p>This will now sort by the issue id, listing them in lowest to highest (or ascending) order.</p>
<p>The order may be reversed to list them in highest to lowest (or descending) order by providing the appropriate flag:</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --sorttype<span class="o">=</span>issueid --sortorder<span class="o">=</span>desc
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder desc
</code></pre>
<p>In the case of multiple projects given on the command line, the projects will be grouped and then sorted by issue id.</p>
@@ -253,12 +256,12 @@ remaining text
<p>To check if an issue is backward-incompatible the releasedocmaker script first checks the <q>Hadoop Flags</q> field in the
issue. If this field is found to be blank then it searches for the 'backward-incompatible’ label. You can override the
-default value for this label by using -L option e.g.</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project<span class="o">=</span>falcon --version 0.6 --incompatiblelabel not-compatible
+default value for this label by using –incompatiblelabel option e.g.</p>
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 --incompatiblelabel not-compatible
</code></pre>
<p>or equivalently using the shorter -X option</p>
-<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker --project<span class="o">=</span>falcon --version 0.6 -X not-compatible
+<pre class="highlight shell"><code><span class="gp">$ </span>releasedocmaker.py --project falcon --version 0.6 -X not-compatible
</code></pre>
<h1 id="lint-mode">Lint Mode</h1>