snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-30 09:04:59 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

update the readme

Browse Source
This commit is contained in:
Tamo 2021-11-04 14:43:36 +01:00
parent b165c77fa7
commit d0fe9dea61
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
filter_parser/README.md
View File

@ -2,7 +2,7 @@
This workspace is dedicated to the parsing of the MeiliSearch filters. This workspace is dedicated to the parsing of the MeiliSearch filters.
Most of the code and explanation are in the [src/lib.rs]. Especially, the BNF of the filters at the top of this file. Most of the code and explanation are in the [`lib.rs`](./src/lib.rs). Especially, the BNF of the filters at the top of this file.
The parser use [nom](https://docs.rs/nom/) to do most of its work and [nom-locate](https://docs.rs/nom_locate/) to keep track of what we were doing when we encountered an error. The parser use [nom](https://docs.rs/nom/) to do most of its work and [nom-locate](https://docs.rs/nom_locate/) to keep track of what we were doing when we encountered an error.
@ -31,5 +31,6 @@ cargo fuzz run parse
## What to do if you find a bug in the parser ## What to do if you find a bug in the parser
- Write a test at the end of the [src/lib.rs] to ensure it never happens again. - Write a test at the end of the [`lib.rs`](./src/lib.rs) to ensure it never happens again.
- Add a file in [fuzz/corpus/parse/] with your filter to help the fuzzer finding new bug. - Add a file in [the corpus directory](./fuzz/corpus/parse/) with your filter to help the fuzzer finding new bug. Since this directory is going to be heavily polluted by the execution of the fuzzer it's in the gitignore and you'll need to force push your new test.
Since this directory is going to be heavily polluted by the execution of the fuzzer it's in the gitignore and you'll need to force add your new test.