Skip to content

Commit e2a6e2c

Browse files
committed
iproto: add min version to feature comments
Currently, the only way to find the IPROTO protocol version where a particular feature first appeared is to read the Git history, which is inconvenient. Let's add this information to comments. NO_DOC=comment NO_TEST=comment NO_CHANGELOG=comment
1 parent 9942499 commit e2a6e2c

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

src/box/iproto_features.h

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,15 @@ extern "C" {
1919
#define IPROTO_FEATURES(_) \
2020
/**
2121
* Streams support: IPROTO_STREAM_ID header key.
22+
*
23+
* Available since IPROTO protocol version 1.
2224
*/ \
2325
_(STREAMS, 0) \
2426
/**
2527
* Transactions in the protocol:
2628
* IPROTO_BEGIN, IPROTO_COMMIT, IPROTO_ROLLBACK commands.
29+
*
30+
* Available since IPROTO protocol version 1.
2731
*/ \
2832
_(TRANSACTIONS, 1) \
2933
/**
@@ -36,17 +40,23 @@ extern "C" {
3640
* converted to a string error message). If the feature bit is set and
3741
* encode_errors_as_ext is true, errors will be encoded as MP_ERROR
3842
* MsgPack extension.
43+
*
44+
* Available since IPROTO protocol version 2.
3945
*/ \
4046
_(ERROR_EXTENSION, 2) \
4147
/**
4248
* Remote watchers support:
4349
* IPROTO_WATCH, IPROTO_UNWATCH, IPROTO_EVENT commands.
50+
*
51+
* Available since IPROTO protocol version 3.
4452
*/ \
4553
_(WATCHERS, 3) \
4654
/**
4755
* Pagination support:
4856
* IPROTO_AFTER_POSITION, IPROTO_AFTER_TUPLE, IPROTO_FETCH_POSITION
4957
* request fields and IPROTO_POSITION response field.
58+
*
59+
* Available since IPROTO protocol version 4.
5060
*/ \
5161
_(PAGINATION, 4) \
5262
/**
@@ -55,41 +65,59 @@ extern "C" {
5565
* IPROTO_UPDATE and IPROTO_DELETE request body;
5666
* IPROTO_SPACE_NAME field in IPROTO_INSERT, IPROTO_REPLACE,
5767
* IPROTO_UPDATE and IPROTO_UPSERT request body.
68+
*
69+
* Available since IPROTO protocol version 5.
5870
*/ \
5971
_(SPACE_AND_INDEX_NAMES, 5) \
60-
/** IPROTO_WATCH_ONCE request support. */ \
72+
/**
73+
* IPROTO_WATCH_ONCE request support.
74+
*
75+
* Available since IPROTO protocol version 6.
76+
*/ \
6177
_(WATCH_ONCE, 6) \
6278
/**
6379
* Tuple format in DML request responses support:
6480
* Tuples in IPROTO_DATA response field are encoded as MP_TUPLE and
6581
* tuple format is sent in IPROTO_TUPLE_FORMATS field.
82+
*
83+
* Available since IPROTO protocol version 7.
6684
*/ \
6785
_(DML_TUPLE_EXTENSION, 7) \
6886
/**
6987
* Tuple format in call and eval request responses support:
7088
* Tuples in IPROTO_DATA response field are encoded as MP_TUPLE and
7189
* tuple formats are sent in IPROTO_TUPLE_FORMATS field.
90+
*
91+
* Available since IPROTO protocol version 7.
7292
*/ \
7393
_(CALL_RET_TUPLE_EXTENSION, 8) \
7494
/**
7595
* Tuple format in call and eval request arguments support:
7696
* Tuples in IPROTO_TUPLE request field are encoded as MP_TUPLE and
7797
* tuple formats are received in IPROTO_TUPLE_FORMATS field.
98+
*
99+
* Available since IPROTO protocol version 7.
78100
*/ \
79101
_(CALL_ARG_TUPLE_EXTENSION, 9) \
80102
/**
81103
* Cursor (for checkpoint join) in FETCH_SNAPSHOT support:
82104
* IPROTO_IS_CHECKPOINT_JOIN, IPROTO_CHECKPOINT_VCLOCK and
83105
* IRPOTO_CHECKPOINT_LSN.
106+
*
107+
* Available since IPROTO protocol version 8.
84108
*/ \
85109
_(FETCH_SNAPSHOT_CURSOR, 10) \
86110
/**
87111
* Synchronous transaction support:
88112
* IS_SYNC flag in IPROTO_BEGIN, IPROTO_COMMIT
113+
*
114+
* Available since IPROTO protocol version 9.
89115
*/ \
90116
_(IS_SYNC, 11) \
91117
/**
92118
* Support of data insertion in Arrow format.
119+
*
120+
* Available since IPROTO protocol version 10.
93121
*/ \
94122
_(INSERT_ARROW, 12) \
95123

0 commit comments

Comments
 (0)