Skip to content

Commit 74bcfcb

Browse files
vladimirpetrovsudo87harikrishna-patnala
authored andcommitted
Fix terms, typos and grammar mistakes in the API, error messages, events, etc. (apache#7857)
This PR aligns the use of terminology, renaming VM / virtual machine references to 'Instance' and also capitalising the terms Templates, Network, Snapshot, User, Account in CloudStack APIs, error and log messages, events, tooltips, etc. Many typos, grammar and spelling mistakes were fixed, also terms like IPv4, VPN, VPC, etc. were properly capitalised. Some error messages were cleaned for better readability. The test cases, expecting some exception strings were adjusted accordingly. Here is the wiki page, describing the changes in details: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Object+Naming+and+Title+Case+Convention --------- Co-authored-by: Manoj Kumar <manojkr.itbhu@gmail.com> Co-authored-by: Harikrishna <harikrishna.patnala@gmail.com>
1 parent 2a0815b commit 74bcfcb

File tree

1,048 files changed

+5546
-5546
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,048 files changed

+5546
-5546
lines changed

agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,12 +175,12 @@ private Answer executeProxyLoadScan(final Command cmd, final long proxyVmId, fin
175175
try {
176176
is.close();
177177
} catch (final IOException e) {
178-
logger.warn("Exception when closing , console proxy address : {}", proxyManagementIp);
178+
logger.warn("Exception when closing , console proxy address: {}", proxyManagementIp);
179179
success = false;
180180
}
181181
}
182182
} catch (final IOException e) {
183-
logger.warn("Unable to open console proxy command port url, console proxy address : {}", proxyManagementIp);
183+
logger.warn("Unable to open console proxy command port url, console proxy address: {}", proxyManagementIp);
184184
success = false;
185185
}
186186

api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ public class ListRecurringSnapshotScheduleCmd extends BaseListCmd {
3535
//////////////// API parameters /////////////////////
3636
/////////////////////////////////////////////////////
3737

38-
@Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "lists recurring snapshots by snapshot policy ID")
38+
@Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "Lists recurring Snapshots by Snapshot policy ID")
3939
private Long snapshotPolicyId;
4040

41-
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "list recurring snapshots by volume ID")
41+
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "List recurring Snapshots by volume ID")
4242
private Long volumeId;
4343

4444
/////////////////////////////////////////////////////

api/src/main/java/com/cloud/network/Ipv6Service.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public interface Ipv6Service extends PluggableService, Configurable {
4545
static final ConfigKey<Boolean> Ipv6OfferingCreationEnabled = new ConfigKey<Boolean>("Advanced", Boolean.class,
4646
"ipv6.offering.enabled",
4747
"false",
48-
"Indicates whether creation of IPv6 network/VPC offering is enabled or not.",
48+
"Indicates whether creation of IPv6 Network/VPC offering is enabled or not.",
4949
true);
5050

5151
static final ConfigKey<Integer> Ipv6PrefixSubnetCleanupInterval = new ConfigKey<Integer>("Advanced", Integer.class,

api/src/main/java/com/cloud/network/Network.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ enum Event {
325325

326326
public enum State {
327327

328-
Allocated("Indicates the network configuration is in allocated but not setup"), Setup("Indicates the network configuration is setup"), Implementing(
329-
"Indicates the network configuration is being implemented"), Implemented("Indicates the network configuration is in use"), Shutdown(
330-
"Indicates the network configuration is being destroyed"), Destroy("Indicates that the network is destroyed");
328+
Allocated("Indicates the Network configuration is in allocated but not setup"), Setup("Indicates the Network configuration is setup"), Implementing(
329+
"Indicates the Network configuration is being implemented"), Implemented("Indicates the Network configuration is in use"), Shutdown(
330+
"Indicates the Network configuration is being destroyed"), Destroy("Indicates that the Network is destroyed");
331331

332332
protected static final StateMachine2<State, Network.Event, Network> s_fsm = new StateMachine2<State, Network.Event, Network>();
333333

api/src/main/java/com/cloud/network/NetworkService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public interface NetworkService {
8181
true, ConfigKey.Scope.Zone);
8282

8383
public static final ConfigKey<Boolean> AllowUsersToSpecifyVRMtu = new ConfigKey<>("Advanced", Boolean.class,
84-
"allow.end.users.to.specify.vr.mtu", "false", "Allow end users to specify VR MTU",
84+
"allow.end.users.to.specify.vr.mtu", "false", "Allow end Users to specify VR MTU",
8585
true, ConfigKey.Scope.Zone);
8686

8787
List<? extends Network> getIsolatedNetworksOwnedByAccountInZone(long zoneId, Account owner);

api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public static State fromValue(String state) {
4343
} else if (state.equalsIgnoreCase("scaling")) {
4444
return SCALING;
4545
} else {
46-
throw new IllegalArgumentException("Unexpected AutoScale VM group state : " + state);
46+
throw new IllegalArgumentException("Unexpected AutoScale Instance group state : " + state);
4747
}
4848
}
4949
}

api/src/main/java/com/cloud/user/ResourceLimitService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
public interface ResourceLimitService {
3535

3636
static final ConfigKey<Long> MaxAccountSecondaryStorage = new ConfigKey<>("Account Defaults", Long.class, "max.account.secondary.storage", "400",
37-
"The default maximum secondary storage space (in GiB) that can be used for an account", false);
37+
"The default maximum secondary storage space (in GiB) that can be used for an Account", false);
3838
static final ConfigKey<Long> MaxProjectSecondaryStorage = new ConfigKey<>("Project Defaults", Long.class, "max.project.secondary.storage", "400",
3939
"The default maximum secondary storage space (in GiB) that can be used for a project", false);
4040
static final ConfigKey<Long> ResourceCountCheckInterval = new ConfigKey<>("Advanced", Long.class, "resourcecount.check.interval", "300",

api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,47 +34,47 @@
3434
public class AffinityGroupResponse extends BaseResponse implements ControlledViewEntityResponse {
3535

3636
@SerializedName(ApiConstants.ID)
37-
@Param(description = "the ID of the affinity group")
37+
@Param(description = "The ID of the affinity group")
3838
private String id;
3939

4040
@SerializedName(ApiConstants.NAME)
41-
@Param(description = "the name of the affinity group")
41+
@Param(description = "The name of the affinity group")
4242
private String name;
4343

4444
@SerializedName(ApiConstants.DESCRIPTION)
45-
@Param(description = "the description of the affinity group")
45+
@Param(description = "The description of the affinity group")
4646
private String description;
4747

4848
@SerializedName(ApiConstants.ACCOUNT)
49-
@Param(description = "the account owning the affinity group")
49+
@Param(description = "The account owning the affinity group")
5050
private String accountName;
5151

5252
@SerializedName(ApiConstants.DOMAIN_ID)
53-
@Param(description = "the domain ID of the affinity group")
53+
@Param(description = "The domain ID of the affinity group")
5454
private String domainId;
5555

5656
@SerializedName(ApiConstants.DOMAIN)
57-
@Param(description = "the domain name of the affinity group")
57+
@Param(description = "The domain name of the affinity group")
5858
private String domainName;
5959

6060
@SerializedName(ApiConstants.DOMAIN_PATH)
6161
@Param(description = "path of the Domain the affinity group belongs to", since = "4.19.2.0")
6262
private String domainPath;
6363

6464
@SerializedName(ApiConstants.PROJECT_ID)
65-
@Param(description = "the project ID of the affinity group")
65+
@Param(description = "The project ID of the affinity group")
6666
private String projectId;
6767

6868
@SerializedName(ApiConstants.PROJECT)
69-
@Param(description = "the project name of the affinity group")
69+
@Param(description = "The project name of the affinity group")
7070
private String projectName;
7171

7272
@SerializedName(ApiConstants.TYPE)
73-
@Param(description = "the type of the affinity group")
73+
@Param(description = "The type of the affinity group")
7474
private String type;
7575

7676
@SerializedName("virtualmachineIds")
77-
@Param(description = "virtual machine IDs associated with this affinity group")
77+
@Param(description = "Instance IDs associated with this affinity group")
7878
private List<String> vmIdList;
7979

8080
@SerializedName("dedicatedresources")

api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupTypeResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
public class AffinityGroupTypeResponse extends BaseResponse {
3030

3131
@SerializedName(ApiConstants.TYPE)
32-
@Param(description = "the type of the affinity group")
32+
@Param(description = "The type of the affinity group")
3333
private String type;
3434

3535
public AffinityGroupTypeResponse() {

api/src/main/java/org/apache/cloudstack/api/AbstractGetUploadParamsCmd.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,28 @@
2929
public abstract class AbstractGetUploadParamsCmd extends BaseCmd {
3030

3131

32-
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the volume/template/iso")
32+
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Volume/Template/ISO")
3333
private String name;
3434

35-
@Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, required = true, description = "the format for the volume/template/iso. Possible values include QCOW2, OVA, "
35+
@Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, required = true, description = "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, "
3636
+ "and VHD.")
3737
private String format;
3838

39-
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the ID of the zone the volume/template/iso is "
39+
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The ID of the zone the Volume/Template/ISO is "
4040
+ "to be hosted on")
4141
private Long zoneId;
4242

43-
@Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "the checksum value of this volume/template/iso " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
43+
@Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "The checksum value of this Volume/Template/ISO " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
4444
private String checksum;
4545

46-
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
46+
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional accountName. Must be used with domainId.")
4747
private String accountName;
4848

49-
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "an optional domainId. If the account parameter is used, "
49+
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "An optional domainId. If the Account parameter is used, "
5050
+ "domainId must also be used.")
5151
private Long domainId;
5252

53-
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Upload volume/template/iso for the project")
53+
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Upload Volume/Template/ISO for the project")
5454
private Long projectId;
5555

5656
public String getName() {

0 commit comments

Comments
 (0)