cleanup: remove proto comment next free annotation (#8675)

Signed-off-by: Yi Tang <ssnailtang@gmail.com>

Mirrored from https://github.com/envoyproxy/envoy @ 06e104ccdde9480ca0b1c8d5b2fdab1f64ce1443
master-ci-test
data-plane-api(CircleCI) 5 years ago
parent 4aff546b7d
commit 365f0db9f0
  1. 7
      STYLE.md
  2. 1
      envoy/api/v2/cds.proto
  3. 1
      envoy/api/v2/core/config_source.proto
  4. 1
      envoy/api/v2/core/health_check.proto
  5. 1
      envoy/api/v2/core/protocol.proto
  6. 1
      envoy/api/v2/lds.proto
  7. 1
      envoy/api/v2/rds.proto
  8. 6
      envoy/api/v2/route/route.proto
  9. 1
      envoy/api/v2/srds.proto
  10. 1
      envoy/api/v3alpha/cds.proto
  11. 1
      envoy/api/v3alpha/core/config_source.proto
  12. 1
      envoy/api/v3alpha/core/health_check.proto
  13. 1
      envoy/api/v3alpha/core/protocol.proto
  14. 1
      envoy/api/v3alpha/lds.proto
  15. 1
      envoy/api/v3alpha/rds.proto
  16. 6
      envoy/api/v3alpha/route/route.proto
  17. 1
      envoy/api/v3alpha/srds.proto
  18. 2
      envoy/config/filter/network/dubbo_proxy/v2alpha1/dubbo_proxy.proto
  19. 5
      envoy/config/filter/network/dubbo_proxy/v2alpha1/route.proto
  20. 2
      envoy/config/filter/network/dubbo_proxy/v3alpha/dubbo_proxy.proto
  21. 5
      envoy/config/filter/network/dubbo_proxy/v3alpha/route.proto
  22. 2
      envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
  23. 2
      envoy/config/filter/network/http_connection_manager/v3alpha/http_connection_manager.proto
  24. 4
      envoy/config/filter/network/thrift_proxy/v2alpha1/route.proto
  25. 3
      envoy/config/filter/network/thrift_proxy/v2alpha1/thrift_proxy.proto
  26. 4
      envoy/config/filter/network/thrift_proxy/v3alpha/route.proto
  27. 3
      envoy/config/filter/network/thrift_proxy/v3alpha/thrift_proxy.proto
  28. 1
      envoy/config/filter/thrift/rate_limit/v2alpha1/rate_limit.proto
  29. 1
      envoy/config/filter/thrift/rate_limit/v3alpha/rate_limit.proto
  30. 1
      envoy/config/metrics/v2/stats.proto
  31. 1
      envoy/config/metrics/v3alpha/stats.proto

@ -81,12 +81,7 @@ In addition, the following conventions should be followed:
pattern forces developers to explicitly choose the correct enum value for
their use case, and avoid misunderstanding of the default behavior.
* Proto fields should be sorted logically, not by field number. For large protos, place a comment
at the top that specifies the next free field number. E.g.,
```
// [#comment:next free field: 28]
```
* Proto fields should be sorted logically, not by field number.
## Package organization

@ -47,7 +47,6 @@ service ClusterDiscoveryService {
}
// Configuration for a single upstream cluster.
// [#comment:next free field: 45]
// [#next-free-field: 45]
message Cluster {
// Refer to :ref:`service discovery type <arch_overview_service_discovery_types>`

@ -102,7 +102,6 @@ message RateLimitSettings {
// <arch_overview_service_discovery>` etc. may either be sourced from the
// filesystem or from an xDS API source. Filesystem configs are watched with
// inotify for updates.
// [#comment:next free field: 6]
// [#next-free-field: 6]
message ConfigSource {
oneof config_source_specifier {

@ -63,7 +63,6 @@ message HealthCheck {
}
}
// [#comment:next free field: 10]
// [#next-free-field: 11]
message HttpHealthCheck {
// The value of the host header in the HTTP health check request. If

@ -53,7 +53,6 @@ message Http1ProtocolOptions {
string default_host_for_http_10 = 3;
}
// [#comment:next free field: 13]
// [#next-free-field: 13]
message Http2ProtocolOptions {
// `Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_

@ -42,7 +42,6 @@ service ListenerDiscoveryService {
}
}
// [#comment:next free field: 21]
// [#next-free-field: 21]
message Listener {
enum DrainType {

@ -56,7 +56,6 @@ service VirtualHostDiscoveryService {
}
}
// [#comment:next free field: 11]
// [#next-free-field: 11]
message RouteConfiguration {
// The name of the route configuration. For example, it might match

@ -28,7 +28,6 @@ import "validate/validate.proto";
// host header. This allows a single listener to service multiple top level domain path trees. Once
// a virtual host is selected based on the domain, the routes are processed in order to see which
// upstream cluster to route to or whether to perform a redirect.
// [#comment:next free field: 18]
// [#next-free-field: 18]
message VirtualHost {
enum TlsRequirementType {
@ -155,7 +154,6 @@ message VirtualHost {
//
// Envoy supports routing on HTTP method via :ref:`header matching
// <envoy_api_msg_route.HeaderMatcher>`.
// [#comment:next free field: 15]
// [#next-free-field: 16]
message Route {
reserved 6;
@ -240,7 +238,6 @@ message Route {
// multiple upstream clusters along with weights that indicate the percentage of
// traffic to be forwarded to each cluster. The router selects an upstream cluster based on the
// weights.
// [#comment:next free field: 11]
message WeightedCluster {
// [#next-free-field: 11]
message ClusterWeight {
@ -428,7 +425,6 @@ message RouteMatch {
TlsContextMatchOptions tls_context = 11;
}
// [#comment:next free field: 11]
// [#next-free-field: 12]
message CorsPolicy {
// Specifies the origins that will be allowed to do CORS requests.
@ -502,7 +498,6 @@ message CorsPolicy {
core.RuntimeFractionalPercent shadow_enabled = 10;
}
// [#comment:next free field: 30]
// [#next-free-field: 30]
message RouteAction {
enum ClusterNotFoundResponseCode {
@ -860,7 +855,6 @@ message RouteAction {
}
// HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
// [#comment:next free field: 10]
// [#next-free-field: 11]
message RetryPolicy {
message RetryPriority {

@ -97,7 +97,6 @@ service ScopedRoutesDiscoveryService {
// would result in the routing table defined by the `route-config1`
// RouteConfiguration being assigned to the HTTP request/stream.
//
// [#comment:next free field: 4]
message ScopedRouteConfiguration {
// Specifies a key which is matched against the output of the
// :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>`

@ -47,7 +47,6 @@ service ClusterDiscoveryService {
}
// Configuration for a single upstream cluster.
// [#comment:next free field: 45]
// [#next-free-field: 45]
message Cluster {
// Refer to :ref:`service discovery type <arch_overview_service_discovery_types>`

@ -102,7 +102,6 @@ message RateLimitSettings {
// <arch_overview_service_discovery>` etc. may either be sourced from the
// filesystem or from an xDS API source. Filesystem configs are watched with
// inotify for updates.
// [#comment:next free field: 6]
// [#next-free-field: 6]
message ConfigSource {
oneof config_source_specifier {

@ -63,7 +63,6 @@ message HealthCheck {
}
}
// [#comment:next free field: 10]
// [#next-free-field: 11]
message HttpHealthCheck {
reserved 7;

@ -53,7 +53,6 @@ message Http1ProtocolOptions {
string default_host_for_http_10 = 3;
}
// [#comment:next free field: 13]
// [#next-free-field: 13]
message Http2ProtocolOptions {
// `Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_

@ -42,7 +42,6 @@ service ListenerDiscoveryService {
}
}
// [#comment:next free field: 21]
// [#next-free-field: 21]
message Listener {
enum DrainType {

@ -57,7 +57,6 @@ service VirtualHostDiscoveryService {
}
}
// [#comment:next free field: 11]
// [#next-free-field: 11]
message RouteConfiguration {
// The name of the route configuration. For example, it might match

@ -28,7 +28,6 @@ import "validate/validate.proto";
// host header. This allows a single listener to service multiple top level domain path trees. Once
// a virtual host is selected based on the domain, the routes are processed in order to see which
// upstream cluster to route to or whether to perform a redirect.
// [#comment:next free field: 18]
// [#next-free-field: 18]
message VirtualHost {
enum TlsRequirementType {
@ -155,7 +154,6 @@ message VirtualHost {
//
// Envoy supports routing on HTTP method via :ref:`header matching
// <envoy_api_msg_api.v3alpha.route.HeaderMatcher>`.
// [#comment:next free field: 15]
// [#next-free-field: 16]
message Route {
reserved 6;
@ -240,7 +238,6 @@ message Route {
// specification of multiple upstream clusters along with weights that indicate the percentage of
// traffic to be forwarded to each cluster. The router selects an upstream cluster based on the
// weights.
// [#comment:next free field: 11]
message WeightedCluster {
// [#next-free-field: 11]
message ClusterWeight {
@ -413,7 +410,6 @@ message RouteMatch {
TlsContextMatchOptions tls_context = 11;
}
// [#comment:next free field: 11]
// [#next-free-field: 12]
message CorsPolicy {
reserved 1, 8, 7;
@ -465,7 +461,6 @@ message CorsPolicy {
core.RuntimeFractionalPercent shadow_enabled = 10;
}
// [#comment:next free field: 30]
// [#next-free-field: 30]
message RouteAction {
enum ClusterNotFoundResponseCode {
@ -814,7 +809,6 @@ message RouteAction {
}
// HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
// [#comment:next free field: 10]
// [#next-free-field: 11]
message RetryPolicy {
message RetryPriority {

@ -97,7 +97,6 @@ service ScopedRoutesDiscoveryService {
// would result in the routing table defined by the `route-config1`
// RouteConfiguration being assigned to the HTTP request/stream.
//
// [#comment:next free field: 4]
message ScopedRouteConfiguration {
// Specifies a key which is matched against the output of the
// :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v3alpha.ScopedRoutes.scope_key_builder>`

@ -27,7 +27,6 @@ enum SerializationType {
Hessian2 = 0;
}
// [#comment:next free field: 6]
// [#next-free-field: 6]
message DubboProxy {
// The human readable prefix to use when emitting statistics.
@ -50,7 +49,6 @@ message DubboProxy {
}
// DubboFilter configures a Dubbo filter.
// [#comment:next free field: 3]
message DubboFilter {
// The name of the filter to instantiate. The name must match a supported
// filter.

@ -17,7 +17,6 @@ import "validate/validate.proto";
// [#protodoc-title: Dubbo Proxy Route Configuration]
// Dubbo Proxy :ref:`configuration overview <config_network_filters_dubbo_proxy>`.
// [#comment:next free field: 6]
// [#next-free-field: 6]
message RouteConfiguration {
// The name of the route configuration. Reserved for future use in asynchronous route discovery.
@ -37,7 +36,6 @@ message RouteConfiguration {
repeated Route routes = 5;
}
// [#comment:next free field: 3]
message Route {
// Route matching parameters.
RouteMatch match = 1 [(validate.rules).message = {required: true}];
@ -46,7 +44,6 @@ message Route {
RouteAction route = 2 [(validate.rules).message = {required: true}];
}
// [#comment:next free field: 3]
message RouteMatch {
// Method level routing matching.
MethodMatch method = 1;
@ -58,7 +55,6 @@ message RouteMatch {
repeated api.v2.route.HeaderMatcher headers = 2;
}
// [#comment:next free field: 3]
message RouteAction {
oneof cluster_specifier {
option (validate.required) = true;
@ -74,7 +70,6 @@ message RouteAction {
}
}
// [#comment:next free field: 5]
message MethodMatch {
// The parameter matching type.
message ParameterMatchSpecifier {

@ -27,7 +27,6 @@ enum SerializationType {
Hessian2 = 0;
}
// [#comment:next free field: 6]
// [#next-free-field: 6]
message DubboProxy {
// The human readable prefix to use when emitting statistics.
@ -50,7 +49,6 @@ message DubboProxy {
}
// DubboFilter configures a Dubbo filter.
// [#comment:next free field: 3]
message DubboFilter {
// The name of the filter to instantiate. The name must match a supported
// filter.

@ -17,7 +17,6 @@ import "validate/validate.proto";
// [#protodoc-title: Dubbo Proxy Route Configuration]
// Dubbo Proxy :ref:`configuration overview <config_network_filters_dubbo_proxy>`.
// [#comment:next free field: 6]
// [#next-free-field: 6]
message RouteConfiguration {
// The name of the route configuration. Reserved for future use in asynchronous route discovery.
@ -37,7 +36,6 @@ message RouteConfiguration {
repeated Route routes = 5;
}
// [#comment:next free field: 3]
message Route {
// Route matching parameters.
RouteMatch match = 1 [(validate.rules).message = {required: true}];
@ -46,7 +44,6 @@ message Route {
RouteAction route = 2 [(validate.rules).message = {required: true}];
}
// [#comment:next free field: 3]
message RouteMatch {
// Method level routing matching.
MethodMatch method = 1;
@ -58,7 +55,6 @@ message RouteMatch {
repeated api.v3alpha.route.HeaderMatcher headers = 2;
}
// [#comment:next free field: 3]
message RouteAction {
oneof cluster_specifier {
option (validate.required) = true;
@ -74,7 +70,6 @@ message RouteAction {
}
}
// [#comment:next free field: 5]
message MethodMatch {
// The parameter matching type.
message ParameterMatchSpecifier {

@ -23,7 +23,6 @@ import "validate/validate.proto";
// [#protodoc-title: HTTP connection manager]
// HTTP connection manager :ref:`configuration overview <config_http_conn_man>`.
// [#comment:next free field: 36]
// [#next-free-field: 36]
message HttpConnectionManager {
enum CodecType {
@ -148,7 +147,6 @@ message HttpConnectionManager {
bool unix_sockets = 1;
}
// [#comment:next free field: 7]
// [#next-free-field: 7]
message SetCurrentClientCertDetails {
reserved 2;

@ -23,7 +23,6 @@ import "validate/validate.proto";
// [#protodoc-title: HTTP connection manager]
// HTTP connection manager :ref:`configuration overview <config_http_conn_man>`.
// [#comment:next free field: 36]
// [#next-free-field: 36]
message HttpConnectionManager {
enum CodecType {
@ -143,7 +142,6 @@ message HttpConnectionManager {
bool unix_sockets = 1;
}
// [#comment:next free field: 7]
// [#next-free-field: 7]
message SetCurrentClientCertDetails {
reserved 2;

@ -16,7 +16,6 @@ import "validate/validate.proto";
// [#protodoc-title: Thrift Proxy Route Configuration]
// Thrift Proxy :ref:`configuration overview <config_network_filters_thrift_proxy>`.
// [#comment:next free field: 3]
message RouteConfiguration {
// The name of the route configuration. Reserved for future use in asynchronous route discovery.
string name = 1;
@ -26,7 +25,6 @@ message RouteConfiguration {
repeated Route routes = 2;
}
// [#comment:next free field: 3]
message Route {
// Route matching parameters.
RouteMatch match = 1 [(validate.rules).message = {required: true}];
@ -35,7 +33,6 @@ message Route {
RouteAction route = 2 [(validate.rules).message = {required: true}];
}
// [#comment:next free field: 5]
message RouteMatch {
oneof match_specifier {
option (validate.required) = true;
@ -72,7 +69,6 @@ message RouteMatch {
repeated api.v2.route.HeaderMatcher headers = 4;
}
// [#comment:next free field: 5]
message RouteAction {
oneof cluster_specifier {
option (validate.required) = true;

@ -54,7 +54,6 @@ enum ProtocolType {
TWITTER = 4;
}
// [#comment:next free field: 6]
// [#next-free-field: 6]
message ThriftProxy {
// Supplies the type of transport that the Thrift proxy should use. Defaults to
@ -79,7 +78,6 @@ message ThriftProxy {
}
// ThriftFilter configures a Thrift filter.
// [#comment:next free field: 3]
message ThriftFilter {
// The name of the filter to instantiate. The name must match a supported
// filter. The built-in filters are:
@ -101,7 +99,6 @@ message ThriftFilter {
// ThriftProtocolOptions specifies Thrift upstream protocol options. This object is used in
// in :ref:`extension_protocol_options<envoy_api_field_Cluster.extension_protocol_options>`, keyed
// by the name `envoy.filters.network.thrift_proxy`.
// [#comment:next free field: 3]
message ThriftProtocolOptions {
// Supplies the type of transport that the Thrift proxy should use for upstream connections.
// Selecting

@ -16,7 +16,6 @@ import "validate/validate.proto";
// [#protodoc-title: Thrift Proxy Route Configuration]
// Thrift Proxy :ref:`configuration overview <config_network_filters_thrift_proxy>`.
// [#comment:next free field: 3]
message RouteConfiguration {
// The name of the route configuration. Reserved for future use in asynchronous route discovery.
string name = 1;
@ -26,7 +25,6 @@ message RouteConfiguration {
repeated Route routes = 2;
}
// [#comment:next free field: 3]
message Route {
// Route matching parameters.
RouteMatch match = 1 [(validate.rules).message = {required: true}];
@ -35,7 +33,6 @@ message Route {
RouteAction route = 2 [(validate.rules).message = {required: true}];
}
// [#comment:next free field: 5]
message RouteMatch {
oneof match_specifier {
option (validate.required) = true;
@ -72,7 +69,6 @@ message RouteMatch {
repeated api.v3alpha.route.HeaderMatcher headers = 4;
}
// [#comment:next free field: 5]
message RouteAction {
oneof cluster_specifier {
option (validate.required) = true;

@ -54,7 +54,6 @@ enum ProtocolType {
TWITTER = 4;
}
// [#comment:next free field: 6]
// [#next-free-field: 6]
message ThriftProxy {
// Supplies the type of transport that the Thrift proxy should use. Defaults to
@ -79,7 +78,6 @@ message ThriftProxy {
}
// ThriftFilter configures a Thrift filter.
// [#comment:next free field: 3]
message ThriftFilter {
// The name of the filter to instantiate. The name must match a supported
// filter. The built-in filters are:
@ -102,7 +100,6 @@ message ThriftFilter {
// in
// :ref:`extension_protocol_options<envoy_api_field_api.v3alpha.Cluster.extension_protocol_options>`,
// keyed by the name `envoy.filters.network.thrift_proxy`.
// [#comment:next free field: 3]
message ThriftProtocolOptions {
// Supplies the type of transport that the Thrift proxy should use for upstream connections.
// Selecting

@ -15,7 +15,6 @@ import "validate/validate.proto";
// [#protodoc-title: Rate limit]
// Rate limit :ref:`configuration overview <config_thrift_filters_rate_limit>`.
// [#comment:next free field: 5]
// [#next-free-field: 6]
message RateLimit {
// The rate limit domain to use in the rate limit service request.

@ -15,7 +15,6 @@ import "validate/validate.proto";
// [#protodoc-title: Rate limit]
// Rate limit :ref:`configuration overview <config_thrift_filters_rate_limit>`.
// [#comment:next free field: 5]
// [#next-free-field: 6]
message RateLimit {
// The rate limit domain to use in the rate limit service request.

@ -288,7 +288,6 @@ message StatsdSink {
// The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_
// compatible tags. Tags are configurable via :ref:`StatsConfig
// <envoy_api_msg_config.metrics.v2.StatsConfig>`.
// [#comment:next free field: 3]
message DogStatsdSink {
reserved 2;

@ -289,7 +289,6 @@ message StatsdSink {
// The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_
// compatible tags. Tags are configurable via :ref:`StatsConfig
// <envoy_api_msg_config.metrics.v3alpha.StatsConfig>`.
// [#comment:next free field: 3]
message DogStatsdSink {
reserved 2;

Loading…
Cancel
Save