foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
Code Issues Activity

Add screenshots for code search (#715)

Browse source 
reflect changes made in forgejo/forgejo#4134

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/715
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Shiny Nematoda <snematoda.751k2@aleeas.com>
Co-committed-by: Shiny Nematoda <snematoda.751k2@aleeas.com>
This commit is contained in:
Shiny Nematoda 2024-06-22 20:01:14 +00:00 committed by Earl Warren
parent 9383360c7c
commit 9a59b851f3
3 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_images/user/code-search/gitgrep.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 51 KiB

BIN
docs/_images/user/code-search/indexer.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 48 KiB

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

@ -7,6 +7,8 @@ Forgejo supports code search through an indexer and `git-grep` as a fallback whe
# Basic (git-grep) # Basic (git-grep)
![Code search results page using git-grep](../_images/user/code-search/gitgrep.png)
If `REPO_INDEXER_ENABLED` is set to `false`, the code search function will be limited to a single repository and will use [`git-grep`](https://git-scm.com/docs/git-grep). If `REPO_INDEXER_ENABLED` is set to `false`, the code search function will be limited to a single repository and will use [`git-grep`](https://git-scm.com/docs/git-grep).
Currently, only fixed strings are supported and any case differences are ignored. The search results will include the matched line, along with a single line before and after the match. Currently, only fixed strings are supported and any case differences are ignored. The search results will include the matched line, along with a single line before and after the match.
@ -15,6 +17,8 @@ Since, the searches are performed in the fly they may be performed on any valid
# Indexer # Indexer
For advanced search queries and searching across an entire organization or instance, `REPO_INDEXER_ENABLED: true` enables code search via bleve/elasticsearch. ![Code search results page using indexer](../_images/user/code-search/indexer.png)
For advanced search queries and searching across an entire organisation or instance, `REPO_INDEXER_ENABLED: true` enables code search via bleve/elasticsearch.
However, search results are limited to the HEAD of the repository. However, search results are limited to the HEAD of the repository.