foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2025-01-21 02:12:15 -05:00
Code Issues Activity

user/code-search: update directory search

Browse source
This commit is contained in:
Shiny Nematoda 2024-12-30 12:41:44 +00:00
parent 2f15734bac
commit f93ebc57e7
1 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/user/code-search.md
View file

@ -15,7 +15,7 @@ When `REPO_INDEXER_ENABLED` is set to `false`, code search is restricted to a si
The following options are currently available for code search while using `git-grep`.
- **Match**: Perform an exact match on the provided expression.
- **Exact**: Perform an exact match on the provided expression.
- **Union**: Conduct a union match, returning results that contain at least one of the specified keywords. For example, a search query containing `hello world` will yield results with either `hello` or `world`.
- **RegExp**: Utilize the provided regular expression to perform a pattern-based match (matches will not be highlighted).
@ -23,6 +23,22 @@ The following options are currently available for code search while using `git-g
Since `git-grep` is performed on the fly, they can be executed on any valid branch or tag. The currently active branch/tag is displayed as the default value in the dropdown menu above the search bar, allowing users to easily switch between branches and tags.
Searching within a specific directory (or file) executes `git-grep` using a [literal pathspec](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec) for the given path. If `REPO_INDEXER_INCLUDE` has been set by the administrator the filter is added if and only if it matches one of the globs.
### Example
Performing a search for `foo` at `/{user}/{repo}/src/branch/main/src` returns results that belong to the branch `main` inside the directory `/src`
```
main
├── docs -> [...]
└── src
└── main.go
└── utils.go
```
In the above figure the search would matches results for `foo`, in `main.go` and `utils.go`, but not from `docs/*`.
# Indexer
![Code search results page using indexer](../_images/user/code-search/indexer.png)
@ -33,7 +49,7 @@ For complex searches or cross-repository queries across an entire organization o
The following options are currently available for code search while using an indexer.
- **Match**: Perform an exact match on the provided expression.
- **Exact**: Perform an exact match on the provided expression.
- **Fuzzy**: Conduct a fuzzy search, returning results that contain the keyword within a maximum edit-distance of 2. For example, a search query containing `hello` will yield results with
- **edit distance of 0**: `hello`
- **edit distance of 1**: For example, `hllo` (delete), `helloo` (add), `hallo` (modify).
@ -41,3 +57,5 @@ The following options are currently available for code search while using an ind
## Scope
Please note that when using the repository indexer, search results are limited to the contents of the HEAD branch of each repository.
Similar to basic search, searching within a directory (or file) is also possible for advanced search. However, unlike basic search the search is more granular as it applies the filter, but selectively includes/excludes files depending on `REPO_INDEXER_INCLUDE`/`REPO_INDEXER_EXCLUDE`