debian-mirror-gitlab/doc/user/search/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

146 lines
5.7 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
2022-07-23 23:45:48 +05:30
stage: Data Stores
group: Global Search
2022-03-02 08:16:31 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2022-01-26 12:08:38 +05:30
# Searching in GitLab **(FREE)**
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
GitLab has two types of searches available: _basic_ and _advanced_.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
Both types of search are the same, except when you are searching through code.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
- When you use basic search to search code, your search includes one project at a time.
- When you use [advanced search](advanced_search.md) to search code, your search includes all projects at once.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
## Basic search
Use basic search to find:
- Projects
- Issues
- Merge requests
- Milestones
- Users
- Epics (when searching in a group only)
- Code
- Comments
- Commits
- Wiki
## Perform a search
To start a search, type your search query in the search bar on the top-right of the screen.
You must type at least two characters.
![basic search](img/basic_search_v15_1.png)
After the results are displayed, you can modify the search, select a different type of data to
search, or choose a specific group or project.
![basic_search_results](img/basic_search_results_v15_1.png)
## Search in code
To search through code or other documents in a project:
1. On the top bar, select **Menu > Projects** and find your project.
1. On the top bar, in the search field, type the string you want to search for.
1. Press **Enter**.
Code search shows only the first result in the file.
2021-04-29 21:17:54 +05:30
2022-07-23 23:45:48 +05:30
To search across all of GitLab, ask your administrator to enable [advanced search](advanced_search.md).
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
### View Git blame from code search
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
After you find search results, you can view who made the last change to the line
where the results were found.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
1. From the code search result, hover over the line number.
1. On the left, select **View blame**.
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
![code search results](img/code_search_git_blame_v15_1.png)
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
## Search for a SHA
2020-03-13 15:44:24 +05:30
2022-07-23 23:45:48 +05:30
You can search for a commit SHA.
2021-03-08 18:12:59 +05:30
2022-07-23 23:45:48 +05:30
1. On the top bar, select **Menu > Projects** and find your project.
1. On the top bar, in the search field, type the SHA.
2020-03-13 15:44:24 +05:30
2022-07-23 23:45:48 +05:30
If a single result is returned, GitLab redirects to the commit result
and gives you the option to return to the search results page.
2020-03-13 15:44:24 +05:30
2022-07-23 23:45:48 +05:30
![project SHA search redirect](img/project_search_sha_redirect.png)
2017-08-17 22:00:37 +05:30
2022-07-23 23:45:48 +05:30
## Searching for specific terms
2018-03-17 18:26:18 +05:30
You can filter issues and merge requests by specific terms included in titles or descriptions.
2019-03-02 22:35:43 +05:30
- Syntax
2021-03-08 18:12:59 +05:30
- Searches look for all the words in a query, in any order. For example: searching
issues for `display bug` returns all issues matching both those words, in any order.
2019-10-12 21:52:04 +05:30
- To find the exact term, use double quotes: `"display bug"`
2019-03-02 22:35:43 +05:30
- Limitation
2021-03-08 18:12:59 +05:30
- For performance reasons, terms shorter than 3 chars are ignored. For example: searching
2019-10-12 21:52:04 +05:30
issues for `included in titles` is same as `included titles`
2020-03-13 15:44:24 +05:30
- Search is limited to 4096 characters and 64 terms per query.
2018-03-17 18:26:18 +05:30
2022-07-23 23:45:48 +05:30
## Retrieve search results as feed
2021-11-11 11:23:49 +05:30
> Feeds for merge requests were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66336) in GitLab 14.3.
GitLab provides RSS feeds of search results for your project. To subscribe to the
RSS feed of search results:
1. Go to your project's page.
1. On the left sidebar, select **Issues** or **Merge requests**.
2022-07-23 23:45:48 +05:30
1. Perform a search.
2021-11-11 11:23:49 +05:30
1. Select the feed symbol **{rss}** to display the results as an RSS feed in Atom format.
The URL of the result contains both a feed token, and your search query.
You can add this URL to your feed reader.
2017-08-17 22:00:37 +05:30
## Search history
2021-03-11 19:13:27 +05:30
Search history is available for issues and merge requests, and is stored locally
in your browser. To run a search from history:
2017-08-17 22:00:37 +05:30
2022-05-07 20:08:51 +05:30
1. In the top menu, select **Issues** or **Merge requests**.
2022-07-23 23:45:48 +05:30
1. To the left of the search bar, select **Recent searches**, and select a search from the list.
2017-08-17 22:00:37 +05:30
## Removing search filters
2020-04-22 19:07:51 +05:30
Individual filters can be removed by clicking on the filter's (x) button or backspacing. The entire search filter can be cleared by clicking on the search box's (x) button or via <kbd></kbd> (Mac) + <kbd></kbd>.
2021-03-08 18:12:59 +05:30
To delete filter tokens one at a time, the <kbd></kbd> (Mac) / <kbd>Control</kbd> + <kbd></kbd> keyboard combination can be used.
2017-08-17 22:00:37 +05:30
2022-01-26 12:08:38 +05:30
## Autocomplete suggestions
2021-01-03 14:25:43 +05:30
2022-01-26 12:08:38 +05:30
In the search bar, you can view autocomplete suggestions for:
2021-01-03 14:25:43 +05:30
- Projects and groups
- Various help pages (try and type **API help**)
- Project feature pages (try and type **milestones**)
- Various settings pages (try and type **user settings**)
- Recently viewed issues (try and type some word from the title of a recently viewed issue)
- Recently viewed merge requests (try and type some word from the title of a recently viewed merge request)
- Recently viewed epics (try and type some word from the title of a recently viewed epic)
2022-06-21 17:19:12 +05:30
- [GitLab Flavored Markdown](../markdown.md#gitlab-specific-references) (GLFM) for issues in a project (try and type a GLFM reference for an issue)
2021-01-03 14:25:43 +05:30
2021-04-17 20:07:23 +05:30
## Search settings
2021-03-08 18:12:59 +05:30
2021-12-11 22:18:48 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292941) in GitLab 13.8 [with a flag](../../administration/feature_flags.md) named `search_settings_in_page`. Disabled by default.
2022-05-07 20:08:51 +05:30
> - [Added](https://gitlab.com/groups/gitlab-org/-/epics/4842) to Group, Administrator, and User settings in GitLab 13.9.
2021-12-11 22:18:48 +05:30
> - [Feature flag `search_settings_in_page` removed](https://gitlab.com/gitlab-org/gitlab/-/issues/294025) in GitLab 13.11.
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/294025) in GitLab 13.11.
2021-03-08 18:12:59 +05:30
2021-10-27 15:23:28 +05:30
You can search inside a Project, Group, Administrator, or User's settings by entering
2021-04-17 20:07:23 +05:30
a search term in the search box located at the top of the page. The search results
2021-03-08 18:12:59 +05:30
appear highlighted in the sections that match the search term.
![Search project settings](img/project_search_general_settings_v13_8.png)