Skip to content

Commit b37abb8

Browse files
committed
docs: update Compatibility and add Testing section to README
1 parent 5cb13b0 commit b37abb8

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ based on `NodeTag` and provide some other utilities.
88

99
## Features
1010

11-
More info you can find in documentation for [pg variables view](docs/pg_variables.md).
11+
More info you can find in documentation for [`PG Variables` view](docs/pg_variables.md).
1212

1313
### Investigate real type of `Node *`
1414

@@ -23,7 +23,7 @@ variables.
2323

2424
### Show contents of containers
2525

26-
Extension support showing contents of containers: `List` (including Oid, TransactionId, int and custom user pointer types) and `Bitmapset`.
26+
Extension support showing contents of containers: `List` (including `Oid`, `TransactionId`, `int` and non-Node types) and `Bitmapset`.
2727

2828
![List * expansion](resources/list.gif)
2929

@@ -245,36 +245,32 @@ There are 4 settings:
245245

246246
## Compatibility
247247

248-
Extension tries to be compatible with multiple versions of both VS Code and
249-
PostgreSQL.
248+
Compatibility is ensured using testing. Minimal supported versions are **PostgreSQL 9.6** and **VS Code 1.70**.
249+
But actually it can support PostgreSQL down to 8.0 and VS Code 1.30, but testing is not done due to large test matrix - for these versions testing is done manually.
250250

251-
Minimal supported version of:
251+
There are 2 supported debugger extensions: [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) and [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
252+
Extension always tested on *latest version of debugger* and do not tries to be compatible with old ones due to *possible* large/breaking changes in behavior (most features implemented using hacks).
253+
Minimal supported version for **C/C++ 1.12** and **CodeLLDB 11.0**.
252254

253-
- `VS Code` - 1.30
254-
- `PostgreSQL` - 8.0
255-
256-
> It is tested manually and not all use cases might be covered. If you found
257-
> bug specific to some version please [create issue](https://github.com/ashenBlade/postgres-dev-helper/issues).
255+
For using formatter minimal supported version Postgres is `10`.
258256

259-
Also, extension will target latest VS Code version and try to use the full functionality of new versions.
260-
So, use latest VS Code versions to get new features earlier.
257+
## Testing
261258

262-
For using formatter minimal supported version Postgres is `10`.
259+
Directory [`./src/test`](./src/test) contains multiple staff for extension testing.
260+
You can read [README](./src/test/README.md) to look at testing process.
263261

264-
> WARN: I *do not stand* that all extension features will work as expected on all versions
262+
In short, only variable expansion is tested using large test matrix: PG Version x VS Code Version x Debugger.
263+
Each dimension contains all supported values: 9 (PG Versions) x 4 (VS Code Versions) x 2 (Debuggers) = 72 tests in total.
265264

266265
## Known Issues
267266

268267
Known issues:
269268

270269
- If in pointer variable was garbage, extension will not detect it and expand this variable (may be garbage).
271270
Usually, this will not lead to fatal errors, just note this.
272-
- To get NodeTags extension reads all available NodeTag files (from settings),
271+
- To get `NodeTag`s extension reads all available NodeTag files (from settings),
273272
but these files may be not created (./configure or make not run). I assume by
274273
time of debugging start files will be created, so extension catch them and process.
275-
- Works only with [ms-vscode.cpptools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
276-
extension. Currently, no support for other DAP adapters (i.e. Code LLDB).
277-
Reason: strongly tied to output format of this extension (not only expression evaluation, but stack trace format i.e.)
278274
- Sometimes formatting can misbehave. This is due to `pg_bsd_indent` internal
279275
logic. If formatting is not applied try run command again. If file after
280276
formatting is a mess this can be due to errors in logic.

0 commit comments

Comments
 (0)