ctubbsii commented on code in PR #5887:
URL: https://github.com/apache/accumulo/pull/5887#discussion_r2356719202
##########
server/base/src/main/java/org/apache/accumulo/server/util/UpgradeUtil.java:
##########
@@ -78,10 +78,13 @@ static class Opts extends ConfigOpts {
boolean prepare = false;
@Parameter(names = "--start",
- description = "Start an upgrade of an Accumulo instance. This will
check that 'accumulo upgrade --prepare'"
- + " was run on the instance after it was shut down, perform
pre-upgrade validation, and perform any"
- + " upgrade steps that need to occur before the Manager is
started. Finally, it creates a mandatory"
- + " marker in ZooKeeper that enables the Manager to perform an
upgrade.")
+ description = """
+ Start an upgrade of an Accumulo instance. The 'start' step is
intended to be run on the \
+ instance with the new version of software before any server
processes are started. Server processes \
+ should fail to start if this step is not run. This will check that
'accumulo upgrade --prepare' \
+ was run on the instance after it was shut down, perform
pre-upgrade validation, and perform any \
+ upgrade steps that need to occur before the Manager is started.
Finally, it creates a mandatory \
+ marker in ZooKeeper that enables the Manager to complete an
upgrade.""")
Review Comment:
I'm not sure exactly what to say, but "finally" here doesn't quite fit when
the previous sentences did not appear to be a step-by-step thing (as in "First,
.... Then, .... Finally, ...."
I think instead of "Finally,", it could say "Upon successfully starting the
upgrade, it will create" (or similar)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
