From 0e936d58e2cf6f7db43aa32d660fbc9ed305d42e Mon Sep 17 00:00:00 2001 From: "data-plane-api(CircleCI)" Date: Mon, 21 Oct 2019 21:25:23 +0000 Subject: [PATCH] spelling: improve camel case handling, disallow run-together words (#8696) Modifies the pedantic spell checker to better handle camel-case words. Each part the word is now treated as a separate error in both the check and fix modes. Disables run-together mode for aspell, which allowed typos such as "mananger" (man + anger). Fixes the resulting spelling errors. Miscellaneous other fixes: * Provides an option to replace a word without adding the word to the dictionary (in case aspell's suggestions do not contain the correct replacement). * Fixes a bug in the script when no suggestions are returned by aspell. * Checks the dictionary and added words for invalid characters that cause aspell errors at dictionary load time. * Sets the mark flag when in CI runs so that misspelled words are indicated. * Culls words from the dictionary that are no longer in the codebase, or are otherwise not needed. Risk Level: low (comments only) Testing: n/a Doc Changes: n/a Release Notes: n/a Fixes: #8481 Signed-off-by: Stephan Zuercher Mirrored from https://github.com/envoyproxy/envoy @ de70fe54cdba6b022b3971379afa535f402f2ffe --- envoy/admin/v2alpha/clusters.proto | 4 ++-- envoy/admin/v3alpha/clusters.proto | 4 ++-- envoy/api/v2/cds.proto | 2 +- envoy/api/v2/route/route.proto | 2 +- envoy/api/v3alpha/cds.proto | 2 +- envoy/api/v3alpha/route/route.proto | 2 +- .../v2/http_connection_manager.proto | 2 +- .../v3alpha/http_connection_manager.proto | 2 +- .../config/filter/network/redis_proxy/v2/redis_proxy.proto | 6 +++--- .../filter/network/redis_proxy/v3alpha/redis_proxy.proto | 6 +++--- envoy/service/auth/v2/attribute_context.proto | 2 +- envoy/service/auth/v3alpha/attribute_context.proto | 2 +- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/envoy/admin/v2alpha/clusters.proto b/envoy/admin/v2alpha/clusters.proto index af4d9a47..05218f81 100644 --- a/envoy/admin/v2alpha/clusters.proto +++ b/envoy/admin/v2alpha/clusters.proto @@ -53,7 +53,7 @@ message ClusterStatus { // The success rate threshold used in the last interval when only locally originated failures were // taken into account and externally originated errors were treated as success. - // This field should be interpretted only when + // This field should be interpreted only when // :ref:`outlier_detection.split_external_local_origin_errors` // is *true*. The threshold is used to eject hosts based on their success rate. // See :ref:`Cluster outlier detection ` documentation for @@ -108,7 +108,7 @@ message HostStatus { // Request success rate for this host over the last calculated // interval when only locally originated errors are taken into account and externally originated // errors were treated as success. - // This field should be interpretted only when + // This field should be interpreted only when // :ref:`outlier_detection.split_external_local_origin_errors` // is *true*. // See :ref:`Cluster outlier detection ` documentation for diff --git a/envoy/admin/v3alpha/clusters.proto b/envoy/admin/v3alpha/clusters.proto index ca0a7aa2..607e1774 100644 --- a/envoy/admin/v3alpha/clusters.proto +++ b/envoy/admin/v3alpha/clusters.proto @@ -53,7 +53,7 @@ message ClusterStatus { // The success rate threshold used in the last interval when only locally originated failures were // taken into account and externally originated errors were treated as success. - // This field should be interpretted only when + // This field should be interpreted only when // :ref:`outlier_detection.split_external_local_origin_errors` // is *true*. The threshold is used to eject hosts based on their success rate. // See :ref:`Cluster outlier detection ` documentation for @@ -108,7 +108,7 @@ message HostStatus { // Request success rate for this host over the last calculated // interval when only locally originated errors are taken into account and externally originated // errors were treated as success. - // This field should be interpretted only when + // This field should be interpreted only when // :ref:`outlier_detection.split_external_local_origin_errors` // is *true*. // See :ref:`Cluster outlier detection ` documentation for diff --git a/envoy/api/v2/cds.proto b/envoy/api/v2/cds.proto index 5cf42fa1..5aabb7fe 100644 --- a/envoy/api/v2/cds.proto +++ b/envoy/api/v2/cds.proto @@ -278,7 +278,7 @@ message Cluster { // When used with locality_weight_aware, scales the weight of each locality by the ratio // of hosts in the subset vs hosts in the original subset. This aims to even out the load - // going to an individual locality if said locality is disproportionally affected by the + // going to an individual locality if said locality is disproportionately affected by the // subset predicate. bool scale_locality_weight = 5; diff --git a/envoy/api/v2/route/route.proto b/envoy/api/v2/route/route.proto index d0de3217..937a511f 100644 --- a/envoy/api/v2/route/route.proto +++ b/envoy/api/v2/route/route.proto @@ -620,7 +620,7 @@ message RouteAction { ConnectionProperties connection_properties = 3; } - // The flag that shortcircuits the hash computing. This field provides a + // The flag that short-circuits the hash computing. This field provides a // 'fallback' style of configuration: "if a terminal policy doesn't work, // fallback to rest of the policy list", it saves time when the terminal // policy works. diff --git a/envoy/api/v3alpha/cds.proto b/envoy/api/v3alpha/cds.proto index 77918198..a0f6897e 100644 --- a/envoy/api/v3alpha/cds.proto +++ b/envoy/api/v3alpha/cds.proto @@ -273,7 +273,7 @@ message Cluster { // When used with locality_weight_aware, scales the weight of each locality by the ratio // of hosts in the subset vs hosts in the original subset. This aims to even out the load - // going to an individual locality if said locality is disproportionally affected by the + // going to an individual locality if said locality is disproportionately affected by the // subset predicate. bool scale_locality_weight = 5; diff --git a/envoy/api/v3alpha/route/route.proto b/envoy/api/v3alpha/route/route.proto index fcdbf00c..f1540406 100644 --- a/envoy/api/v3alpha/route/route.proto +++ b/envoy/api/v3alpha/route/route.proto @@ -573,7 +573,7 @@ message RouteAction { ConnectionProperties connection_properties = 3; } - // The flag that shortcircuits the hash computing. This field provides a + // The flag that short-circuits the hash computing. This field provides a // 'fallback' style of configuration: "if a terminal policy doesn't work, // fallback to rest of the policy list", it saves time when the terminal // policy works. diff --git a/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto b/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto index d21c2735..01fba7f1 100644 --- a/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto +++ b/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto @@ -351,7 +351,7 @@ message HttpConnectionManager { // .. NOTE:: // To be useful in avoiding the race condition described above, this timeout must be set // to *at least* +<100ms to account for - // a reasonsable "worst" case processing time for a full iteration of Envoy's event loop>. + // a reasonable "worst" case processing time for a full iteration of Envoy's event loop>. // // .. WARNING:: // A value of 0 will completely disable delayed close processing. When disabled, the downstream diff --git a/envoy/config/filter/network/http_connection_manager/v3alpha/http_connection_manager.proto b/envoy/config/filter/network/http_connection_manager/v3alpha/http_connection_manager.proto index 1544c968..c936d98b 100644 --- a/envoy/config/filter/network/http_connection_manager/v3alpha/http_connection_manager.proto +++ b/envoy/config/filter/network/http_connection_manager/v3alpha/http_connection_manager.proto @@ -338,7 +338,7 @@ message HttpConnectionManager { // .. NOTE:: // To be useful in avoiding the race condition described above, this timeout must be set // to *at least* +<100ms to account for - // a reasonsable "worst" case processing time for a full iteration of Envoy's event loop>. + // a reasonable "worst" case processing time for a full iteration of Envoy's event loop>. // // .. WARNING:: // A value of 0 will completely disable delayed close processing. When disabled, the downstream diff --git a/envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto b/envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto index e68ace55..76a2eb62 100644 --- a/envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto +++ b/envoy/config/filter/network/redis_proxy/v2/redis_proxy.proto @@ -211,8 +211,8 @@ message RedisProxy { // // When using the above routes, the following prefixes would be sent to: // - // * 'get abc:users' would retrive the key 'abc:users' from cluster_b. - // * 'get ab:users' would retrive the key 'ab:users' from cluster_a. + // * 'get abc:users' would retrieve the key 'abc:users' from cluster_b. + // * 'get ab:users' would retrieve the key 'ab:users' from cluster_a. // * 'get z:users' would return a NoUpstreamHost error. A :ref:`catch-all // route` // would have retrieved the key from that cluster instead. @@ -237,7 +237,7 @@ message RedisProxy { // :ref:`extension_protocol_options`, keyed // by the name `envoy.redis_proxy`. message RedisProtocolOptions { - // Upstream server password as defined by the `requirepass directive + // Upstream server password as defined by the `requirepass` directive // `_ in the server's configuration file. api.v2.core.DataSource auth_password = 1; } diff --git a/envoy/config/filter/network/redis_proxy/v3alpha/redis_proxy.proto b/envoy/config/filter/network/redis_proxy/v3alpha/redis_proxy.proto index b792ac02..83b1ac2a 100644 --- a/envoy/config/filter/network/redis_proxy/v3alpha/redis_proxy.proto +++ b/envoy/config/filter/network/redis_proxy/v3alpha/redis_proxy.proto @@ -199,8 +199,8 @@ message RedisProxy { // // When using the above routes, the following prefixes would be sent to: // - // * 'get abc:users' would retrive the key 'abc:users' from cluster_b. - // * 'get ab:users' would retrive the key 'ab:users' from cluster_a. + // * 'get abc:users' would retrieve the key 'abc:users' from cluster_b. + // * 'get ab:users' would retrieve the key 'ab:users' from cluster_a. // * 'get z:users' would return a NoUpstreamHost error. A :ref:`catch-all // route` // would have retrieved the key from that cluster instead. @@ -225,7 +225,7 @@ message RedisProxy { // :ref:`extension_protocol_options`, // keyed by the name `envoy.redis_proxy`. message RedisProtocolOptions { - // Upstream server password as defined by the `requirepass directive + // Upstream server password as defined by the `requirepass` directive // `_ in the server's configuration file. api.v3alpha.core.DataSource auth_password = 1; } diff --git a/envoy/service/auth/v2/attribute_context.proto b/envoy/service/auth/v2/attribute_context.proto index 90c42c6f..6fd24ea1 100644 --- a/envoy/service/auth/v2/attribute_context.proto +++ b/envoy/service/auth/v2/attribute_context.proto @@ -92,7 +92,7 @@ message AttributeContext { // The HTTP request headers. If multiple headers share the same key, they // must be merged according to the HTTP spec. All header keys must be - // lowercased, because HTTP header keys are case-insensitive. + // lower-cased, because HTTP header keys are case-insensitive. map headers = 3; // The request target, as it appears in the first line of the HTTP request. This includes diff --git a/envoy/service/auth/v3alpha/attribute_context.proto b/envoy/service/auth/v3alpha/attribute_context.proto index 4a3a23e8..24214aa2 100644 --- a/envoy/service/auth/v3alpha/attribute_context.proto +++ b/envoy/service/auth/v3alpha/attribute_context.proto @@ -92,7 +92,7 @@ message AttributeContext { // The HTTP request headers. If multiple headers share the same key, they // must be merged according to the HTTP spec. All header keys must be - // lowercased, because HTTP header keys are case-insensitive. + // lower-cased, because HTTP header keys are case-insensitive. map headers = 3; // The request target, as it appears in the first line of the HTTP request. This includes