Skip to content

Commit 0362671

Browse files
sdk: cleanup already fixed TODOs (#520)
1 parent ea818d3 commit 0362671

2 files changed

Lines changed: 4 additions & 22 deletions

File tree

villagesql/sdk/API_ABI.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -149,40 +149,28 @@ more.
149149
receive the buffer from the extension. Instead if it were typed as a char*,
150150
the extension can just write the pointer to the struct.
151151
152-
### 1. Provide idiomatic C++ builders/signatures
153-
154-
Currently a large number of the builders take only functions with signatures
155-
based on the C ABI:
156-
157-
- `encode()`
158-
- `decode()`
159-
- `compare()`
160-
- `hash()`
161-
- `prerun()`
162-
- `postrun()`
163-
164-
### 2. Remove old ABI style calls
152+
### 1. Remove old ABI style calls
165153
166154
The original calling convention exposed `vef_*_t*` argument types to VDF
167155
functions. This ABI-era pattern leaked into the API surface and is still
168156
supported by `func_builder.h`. Using it couples extension code directly to ABI
169157
types.
170158
171159
172-
### 3. Drop support for protocol v1
160+
### 2. Drop support for protocol v1
173161
174162
There is very little usage of v1, and we expect the ABI and API to continue to
175163
evolve before Beta. Because of this we expect the cost of supporting v1 will
176164
outweigh the benefit of maintaining it. Sufficient notice will be given to
177165
extension authors.
178166
179167
180-
### 4. Controls to prevent ABI breakages
168+
### 3. Controls to prevent ABI breakages
181169
182170
Add presubmit checks to warn contributors if they have broken ABI compatibility.
183171
184172
185-
### 5. Compatibility testing with extensions in other repos
173+
### 4. Compatibility testing with extensions in other repos
186174
187175
As part of the release process we should test server binaries with existing
188176
extensions that are outside of the development repo.

villagesql/sdk/include/villagesql/vsql.h

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,6 @@
3838
// int complex_compare(vsql::Span<const unsigned char> a,
3939
// vsql::Span<const unsigned char> b);
4040
//
41-
// TODO(villagesql-beta): from_string now uses the typed CustomResult
42-
// wrapper (see PARAMETERIZED TYPES). Migrate the other special VDF entry
43-
// points (to_string, compare, hash, intrinsic_default) to use CustomArg /
44-
// CustomArgWith<P> for inputs and the appropriate typed result wrappers for
45-
// outputs, replacing the raw Span<...> / size_t* shape.
46-
//
4741
// // 2. Define the type as a constexpr object
4842
// static constexpr const char kComplexTypeName[] = "COMPLEX";
4943
// constexpr auto COMPLEX = make_type<kComplexTypeName>()

0 commit comments

Comments
 (0)