Merge branch '457498-update-zoekt-syntax-documentation' into 'master'

Zoekt: Update syntax documentation

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150320



Merged-by: Dmitry Gruzd <dgruzd@gitlab.com>
Approved-by: Ashraf Khamis <akhamis@gitlab.com>
Approved-by: Terri Chu <tchu@gitlab.com>
Reviewed-by: Dmitry Gruzd <dgruzd@gitlab.com>

doc/drawers/exact_code_search_syntax.md

@@ -7,17 +7,18 @@ source: /doc/user/search/exact_code_search.md
 
 # Search tips
 
-| Query                | Description                                                                           |
-| -------------------- |-------------------------------------------------------------------------------------- |
-| `foo`                | Returns files that contain `foo`                                                      |
-| `"class foo"`        | Returns files that contain the exact string `class foo`                               |
-| `class foo`          | Returns files that contain both `class` and `foo`                                     |
-| `foo or bar`         | Returns files that contain either `foo` or `bar`                                      |
-| `class Foo`          | Returns files that contain `class` (case insensitive) and `Foo` (case sensitive)      |
-| `class Foo case:yes` | Returns files that contain `class` and `Foo` (both case sensitive)                    |
-| `foo -bar`           | Returns files that contain `foo` but not `bar`                                        |
-| `foo file:js`        | Searches for `foo` in files with names that contain `js`                              |
-| `foo -file:test`     | Searches for `foo` in files with names that do not contain `test`                     |
-| `foo lang:ruby`      | Searches for `foo` in Ruby source code                                                |
-| `foo f:\.js$`        | Searches for `foo` in files with names that end with `.js`                            |
-| `foo.*bar`           | Searches for strings that match the regular expression `foo.*bar`                     |
+| Query                | Regular expression mode                               | Exact match mode               |
+| -------------------- | ----------------------------------------------------- | ------------------------------ |
+| `"foo"`              | `foo`                                                 | `"foo"`                        |
+| `foo file:^doc/`     | `foo` in directories that start with `/doc`           | `foo` in directories that start with `/doc` |
+| `"class foo"`        | `class foo`                                           | `"class foo"`                  |
+| `class foo`          | `class` and `foo`                                     | `class foo`                    |
+| `foo or bar`         | `foo` or `bar`                                        | `foo or bar`                   |
+| `class Foo`          | `class` (case insensitive) and `Foo` (case sensitive) | `class Foo` (case insensitive) |
+| `class Foo case:yes` | `class` and `Foo` (both case sensitive)               | `class Foo` (case sensitive)   |
+| `foo -bar`           | `foo` but not `bar`                                   | `foo -bar`                     |
+| `foo file:js`        | `foo` in files with names that contain `js`           | `foo` in files with names that contain `js` |
+| `foo -file:test`     | `foo` in files with names that do not contain `test`  | `foo` in files with names that do not contain `test` |
+| `foo lang:ruby`      | `foo` in Ruby source code                             | `foo` in Ruby source code      |
+| `foo file:\.js$`     | `foo` in files with names that end with `.js`         | `foo` in files with names that end with `.js` |
+| `foo.*bar`           | `foo.*bar` (regular expression)                       | None                           |

doc/user/search/exact_code_search.md

@@ -60,22 +60,37 @@ Use this feature to search code across the entire GitLab instance.
 Global code search does not perform well on large GitLab instances.
 If you enable this feature for instances with more than 20,000 projects, your search might time out.
 
-## Syntax
-
-This table shows some example queries for exact code search.
-
-| Query                | Description                                                                       |
-|----------------------|-----------------------------------------------------------------------------------|
-| `foo`                | Returns files that contain `foo`.                                                 |
-| `foo file:^doc/`     | Returns files that contain `foo` in directories that start with `doc/`.           |
-| `"class foo"`        | Returns files that contain the exact string `class foo`.                          |
-| `class foo`          | Returns files that contain both `class` and `foo`.                                |
-| `foo or bar`         | Returns files that contain either `foo` or `bar`.                                 |
-| `class Foo`          | Returns files that contain `class` (case insensitive) and `Foo` (case sensitive). |
-| `class Foo case:yes` | Returns files that contain `class` and `Foo` (both case sensitive).               |
-| `foo -bar`           | Returns files that contain `foo` but not `bar`.                                   |
-| `foo file:js`        | Searches for `foo` in files with names that contain `js`.                         |
-| `foo -file:test`     | Searches for `foo` in files with names that do not contain `test`.                |
-| `foo lang:ruby`      | Searches for `foo` in Ruby source code.                                           |
-| `foo file:\.js$`     | Searches for `foo` in files with names that end with `.js`.                       |
-| `foo.*bar`           | Searches for strings that match the regular expression `foo.*bar`.                |
+## Search modes
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/434417) in GitLab 16.8 [with a flag](../../administration/feature_flags.md) named `zoekt_exact_search`. Disabled by default.
+
+FLAG:
+The availability of this feature is controlled by a feature flag.
+For more information, see the history.
+
+When you enable `zoekt_exact_search`, you can switch between two search modes:
+
+- **Regular expression mode:** supports regular and boolean expressions.
+- **Exact match mode:** returns results that exactly match the query.
+
+When `zoekt_exact_search` is disabled, the regular expression mode is used by default.
+
+### Syntax
+
+This table shows some example queries for regular expression and exact match modes.
+
+| Query                | Regular expression mode                               | Exact match mode               |
+| -------------------- | ----------------------------------------------------- | ------------------------------ |
+| `"foo"`              | `foo`                                                 | `"foo"`                        |
+| `foo file:^doc/`     | `foo` in directories that start with `/doc`           | `foo` in directories that start with `/doc` |
+| `"class foo"`        | `class foo`                                           | `"class foo"`                  |
+| `class foo`          | `class` and `foo`                                     | `class foo`                    |
+| `foo or bar`         | `foo` or `bar`                                        | `foo or bar`                   |
+| `class Foo`          | `class` (case insensitive) and `Foo` (case sensitive) | `class Foo` (case insensitive) |
+| `class Foo case:yes` | `class` and `Foo` (both case sensitive)               | `class Foo` (case sensitive)   |
+| `foo -bar`           | `foo` but not `bar`                                   | `foo -bar`                     |
+| `foo file:js`        | `foo` in files with names that contain `js`           | `foo` in files with names that contain `js` |
+| `foo -file:test`     | `foo` in files with names that do not contain `test`  | `foo` in files with names that do not contain `test` |
+| `foo lang:ruby`      | `foo` in Ruby source code                             | `foo` in Ruby source code      |
+| `foo file:\.js$`     | `foo` in files with names that end with `.js`         | `foo` in files with names that end with `.js` |
+| `foo.*bar`           | `foo.*bar` (regular expression)                       | None                           |

ee/config/feature_flags/gitlab_com_derisk/zoekt_exact_search.yml

 ---
 name: zoekt_exact_search
-feature_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/389745
+feature_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/434417
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140346
 rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/436457
 milestone: '16.8'