Skip to content

Commit 244112b

Browse files
authored
Remove stale TiDB references from documentation (#12)
1 parent aea9ff6 commit 244112b

2 files changed

Lines changed: 8 additions & 21 deletions

File tree

SECURITY.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Security Vulnerability Disclosure and Response Process
22

3-
The primary goal of this process is to reduce the total exposure time of users to publicly known vulnerabilities. TiDB security team is responsible for the entire vulnerability management process, including internal communication and external disclosure.
4-
5-
If you find a vulnerability or encounter a security incident involving vulnerabilities of this repository, please report it as soon as possible to the TiDB security team (security@tidb.io).
3+
If you find a vulnerability or encounter a security incident involving this
4+
repository, please report it privately via GitHub's "Report a vulnerability"
5+
feature on the repository's Security tab.
66

77
Please kindly help provide as much vulnerability information as possible in the following format:
88

@@ -22,7 +22,8 @@ The asterisk (*) indicates the required field.
2222

2323
# Response Time
2424

25-
The TiDB security team will confirm the vulnerabilities and contact you within 2 working days after your submission.
25+
We will confirm the vulnerabilities and contact you within a reasonable time
26+
after your submission.
2627

2728
We will publicly thank you after fixing the security vulnerability. To avoid negative impact, please keep the vulnerability confidential until we fix it. We would appreciate it if you could obey the following code of conduct:
2829

docs/quickstart.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,12 @@ touch main.go
1919

2020
## Import Dependencies
2121

22-
First, you need to use `go get` to fetch the dependencies through git hash. The git hashes are available in [release page](https://github.com/pingcap/tidb/releases). Take `v7.5.0` as an example:
22+
First, you need to use `go get` to fetch the dependency:
2323

2424
```bash
25-
go get -v github.com/sqlc-dev/marino@069631e
25+
go get -v github.com/sqlc-dev/marino
2626
```
2727

28-
> **NOTE**
29-
>
30-
> The parser was merged into TiDB repo since v5.3.0. So you can only choose version v5.3.0 or higher in this TiDB repo.
31-
>
32-
> You may want to use advanced API on expressions (a kind of AST node), such as numbers, string literals, booleans, nulls, etc. It is strongly recommended using the `types` package in TiDB repo with the following command:
33-
>
34-
> ```bash
35-
> go get -v github.com/pingcap/tidb/pkg/types/parser_driver@069631e
36-
> ```
37-
> and import it in your golang source code:
38-
> ```go
39-
> import _ "github.com/pingcap/tidb/pkg/types/parser_driver"
40-
> ```
41-
4228
Your directory should contain the following three files:
4329
```
4430
.
@@ -104,7 +90,7 @@ If the parser runs properly, you should get a result like this:
10490
> Here are a few things you might want to know:
10591
> - To use a parser, a `parser_driver` is required. It decides how to parse the basic data types in SQL.
10692
>
107-
> You can use [`github.com/sqlc-dev/marino/test_driver`](https://pkg.go.dev/github.com/sqlc-dev/marino/test_driver) as the `parser_driver` for test. Again, if you need advanced features, please use the `parser_driver` in TiDB (run `go get -v github.com/pingcap/tidb/types/parser_driver@069631e` and import it).
93+
> You can use [`github.com/sqlc-dev/marino/test_driver`](https://pkg.go.dev/github.com/sqlc-dev/marino/test_driver) as the `parser_driver`.
10894
> - The instantiated parser object is not goroutine safe and not lightweight. It is better to keep it in a single goroutine, and reuse it if possible.
10995
> - Warning: the `parser.result` object is being reused without being properly reset or copied. This can cause unexpected behavior or errors if the object is used for multiple parsing operations or concurrently in multiple goroutines. To avoid these issues, make a copy of `parser.result` object before calling `parser.Parse()` again or before using it in another goroutine, or create a new `parser` object altogether for each new parsing operation.
11096

0 commit comments

Comments
 (0)