Add missing deprecation notice to deprecated code (#437)

v2fly · Nov 20, 2020 · 231f5bf · 231f5bf
1 parent 9c1f251
commit 231f5bf
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 96 deletions.
diff --git a/features/inbound/inbound.go b/features/inbound/inbound.go
@@ -16,7 +16,7 @@ type Handler interface {
 	// The tag of this handler.
 	Tag() string
 
-	// Deprecated. Do not use in new code.
+	// Deprecated: Do not use in new code.
 	GetRandomInboundProxy() (interface{}, net.Port, int)
 }
 

diff --git a/infra/conf/v2ray.go b/infra/conf/v2ray.go
@@ -329,16 +329,32 @@ func (c *StatsConfig) Build() (*stats.Config, error) {
 }
 
 type Config struct {
-	Port            uint16                 `json:"port"` // Port of this Point server. Deprecated.
+	// Port of this Point server.
+	// Deprecated: Port exists for historical compatibility
+	// and should not be used.
+	Port uint16 `json:"port"`
+
+	// Deprecated: InboundConfig exists for historical compatibility
+	// and should not be used.
+	InboundConfig *InboundDetourConfig `json:"inbound"`
+
+	// Deprecated: OutboundConfig exists for historical compatibility
+	// and should not be used.
+	OutboundConfig *OutboundDetourConfig `json:"outbound"`
+
+	// Deprecated: InboundDetours exists for historical compatibility
+	// and should not be used.
+	InboundDetours []InboundDetourConfig `json:"inboundDetour"`
+
+	// Deprecated: OutboundDetours exists for historical compatibility
+	// and should not be used.
+	OutboundDetours []OutboundDetourConfig `json:"outboundDetour"`
+
 	LogConfig       *LogConfig             `json:"log"`
 	RouterConfig    *RouterConfig          `json:"routing"`
 	DNSConfig       *DNSConfig             `json:"dns"`
 	InboundConfigs  []InboundDetourConfig  `json:"inbounds"`
 	OutboundConfigs []OutboundDetourConfig `json:"outbounds"`
-	InboundConfig   *InboundDetourConfig   `json:"inbound"`        // Deprecated.
-	OutboundConfig  *OutboundDetourConfig  `json:"outbound"`       // Deprecated.
-	InboundDetours  []InboundDetourConfig  `json:"inboundDetour"`  // Deprecated.
-	OutboundDetours []OutboundDetourConfig `json:"outboundDetour"` // Deprecated.
 	Transport       *TransportConfig       `json:"transport"`
 	Policy          *PolicyConfig          `json:"policy"`
 	API             *APIConfig             `json:"api"`

diff --git a/transport/config.pb.go b/transport/config.pb.go
diff --git a/transport/config.proto b/transport/config.proto
@@ -11,5 +11,6 @@ import "transport/internet/config.proto";
 // Global transport settings. This affects all type of connections that go
 // through V2Ray. Deprecated. Use each settings in StreamConfig.
 message Config {
+  option deprecated = true;
   repeated v2ray.core.transport.internet.TransportConfig transport_settings = 1;
 }