aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEdward Welbourne <edward.welbourne@qt.io>2019-01-17 15:39:20 +0100
committerEdward Welbourne <edward.welbourne@qt.io>2019-01-17 16:53:29 +0000
commitac54774cecb3fabd21e28081a29d3a38e8b5d076 (patch)
tree184e885ebc74fa20e3c52dc6b332af8c838266a1
parent98fa300396b81f6254404d59b9e5c61c590e91ec (diff)
Call it an API *change* reviewv5.12.1-packaging
Change-Id: Ia52c8555a8c97c74ee6b128958027ff2af74f9af Reviewed-by: Kari Oikarinen <kari.oikarinen@qt.io> Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
-rwxr-xr-xpackaging-tools/all-api-modules22
-rwxr-xr-xpackaging-tools/api-review-gen2
2 files changed, 12 insertions, 12 deletions
diff --git a/packaging-tools/all-api-modules b/packaging-tools/all-api-modules
index 078d264d0..18d7222c9 100755
--- a/packaging-tools/all-api-modules
+++ b/packaging-tools/all-api-modules
@@ -49,18 +49,18 @@ help () {
cat <<EOF
Run from the top-level (qt5) directory of a full Qt checkout with the
-module-set of an imminent release. For API review generation, check
-out .gitmodules on the reference version, so as to use its list of
-modules (and skip modules that were in preview back then). Give this
-script a command to run in each module; the purpose of this script is
-to run api-review-gen on each; but it also serves to prepare for this
-and later to run a git push to send the results to Gerrit for review.
-See examples below and output of ./api-review-gen -h for further
-details.
+module-set of an imminent release. For API change review generation,
+check out .gitmodules on the reference version, so as to use its list
+of modules (and skip modules that were in preview back then). Give
+this script a command to run in each module; the purpose of this
+script is to run api-review-gen on each; but it also serves to prepare
+for this and later to run a git push to send the results to Gerrit for
+review. See examples below and output of ./api-review-gen -h for
+further details.
Although this script can be used to run a general command in each
module, its selection of modules is specifically geared towards the
-particular task of generating API reviews, under the conditions
+particular task of generating API change reviews, under the conditions
described above; a general module iterator might one day replace it,
but please don't try to evolve this into that.
@@ -90,8 +90,8 @@ release tag, another for an imminent release branch. Note that, if a
relevant module is missing (not cloned), this script silently skips
it; you do need to have a suitable full work tree.
-By way of example, here's the work-flow for producing an API review
-between $LAST and $NEXT to be tracked by Jira issue $TASK (you
+By way of example, here's the work-flow for producing an API change
+review between $LAST and $NEXT to be tracked by Jira issue $TASK (you
can set LAST, NEXT and TASK in the environment to configure the
examples), assuming qtsdk/packaging-tools is in your PATH:
diff --git a/packaging-tools/api-review-gen b/packaging-tools/api-review-gen
index f44f1d9e2..87cb25efd 100755
--- a/packaging-tools/api-review-gen
+++ b/packaging-tools/api-review-gen
@@ -68,7 +68,7 @@ Options:
--task-number ID
Include a Task-number: in the commit message, with the
given id, ID, of the bug-tracker issue being used to keep
- track of the API review.
+ track of the API change review.
-a
--amend Amend existing commit rather than extending the review