yetus-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sek...@apache.org
Subject yetus git commit: YETUS-438 Minor issues on newly added sections in releasedocmaker document
Date Thu, 28 Jul 2016 12:28:26 GMT
Repository: yetus
Updated Branches:
  refs/heads/master 073514844 -> 5a8383c32


YETUS-438 Minor issues on newly added sections in releasedocmaker document

Signed-off-by: Kengo Seki <sekikn@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/5a8383c3
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/5a8383c3
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/5a8383c3

Branch: refs/heads/master
Commit: 5a8383c32a0295dcf4c813d056433dc3f5009d17
Parents: 0735148
Author: Ajay Yadava <ajayyadava@apache.org>
Authored: Thu Jul 28 09:19:30 2016 +0530
Committer: Kengo Seki <sekikn@apache.org>
Committed: Thu Jul 28 12:28:10 2016 +0000

----------------------------------------------------------------------
 .../documentation/in-progress/releasedocmaker.md   | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/yetus/blob/5a8383c3/asf-site-src/source/documentation/in-progress/releasedocmaker.md
----------------------------------------------------------------------
diff --git a/asf-site-src/source/documentation/in-progress/releasedocmaker.md b/asf-site-src/source/documentation/in-progress/releasedocmaker.md
index b1ef0a4..d30c634 100644
--- a/asf-site-src/source/documentation/in-progress/releasedocmaker.md
+++ b/asf-site-src/source/documentation/in-progress/releasedocmaker.md
@@ -26,8 +26,11 @@ releasedocmaker
 * [Changing the Header](#changing-the-header)
 * [Multiple Versions](#multiple-versions)
 * [Unreleased Dates](#unreleased-dates)
+* [Sorted Output](#sorted-output)
+* [Backward Incompatible Changes](#backward-incompatible-changes)
 * [Lint Mode](#lint-mode)
 * [Index Mode](#index-mode)
+* [Release Version](#release-version)
 
 # Purpose
 
@@ -130,13 +133,13 @@ Different projects may find one type of sort better than another, depending
upon
 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:
 
 ```bash
-$ releasedocmaker --sorttype=releasedate --sortorder=older
+$ releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder
older
 ```
 
 The order can be reversed so that newer issues appear on top by providing the 'newer' flag:
 
 ```bash
-$ releasedocmaker --sorttype=releasedate --sortorder=newer
+$ releasedocmaker.py --project falcon --version 0.6 --sorttype resolutiondate --sortorder
newer
 ```
 
 In the case of multiple projects given on the command line, the projects will be interspersed.
@@ -146,7 +149,7 @@ In the case of multiple projects given on the command line, the projects
will be
 An alternative to the date-based sort is to sort based upon the issue id.  This may be accomplished
via:
 
 ```bash
-$ releasedocmaker --sorttype=issueid --sortorder=asc
+$ releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder asc
 ```
 
 This will now sort by the issue id, listing them in lowest to highest (or ascending) order.
@@ -154,7 +157,7 @@ This will now sort by the issue id, listing them in lowest to highest
(or ascend
 The order may be reversed to list them in highest to lowest (or descending) order by providing
the appropriate flag:
 
 ```bash
-$ releasedocmaker --sorttype=issueid --sortorder=desc
+$ releasedocmaker.py --project falcon --version 0.6 --sorttype issueid --sortorder desc
 ```
 
 In the case of multiple projects given on the command line, the projects will be grouped
and then sorted by issue id.
@@ -163,16 +166,16 @@ In the case of multiple projects given on the command line, the projects
will be
 
 To check if an issue is backward-incompatible the releasedocmaker script first checks the
"Hadoop Flags" 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.
+default value for this label by using --incompatiblelabel option e.g.
 
 ```bash
-$ releasedocmaker --project=falcon --version 0.6 --incompatiblelabel not-compatible
+$ releasedocmaker.py --project falcon --version 0.6 --incompatiblelabel not-compatible
 ```
 
 or equivalently using the shorter -X option
 
 ```bash
-$ releasedocmaker --project=falcon --version 0.6 -X not-compatible
+$ releasedocmaker.py --project falcon --version 0.6 -X not-compatible
 ```
 
 # Lint Mode


Mime
View raw message