averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Describe using git grep in FAQ.

Browse Source 
Also changed the grep example to use long flag names for clarity.
This commit is contained in:
Varun Gandhi
2020-09-09 13:42:31 -07:00
parent 296d25294b
commit b6558fd9ed
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/HowToGuides/FAQ.md
View File

@@ -64,8 +64,14 @@ This very depends on what X is, but some broad guidelines are:
1. Do a case-insensitive recursive string search. 1. Do a case-insensitive recursive string search.
- Use a specialized tool like [ripgrep](https://github.com/BurntSushi/ripgrep) - Use a specialized tool like [ripgrep](https://github.com/BurntSushi/ripgrep)
or [ag](https://github.com/ggreer/the_silver_searcher). or [ag](https://github.com/ggreer/the_silver_searcher).
- Use `git grep --ignore-case "mypattern"`. `git grep` also supports helpful
flags which provide more context:
- `--show-function`: Tries to print the function name that a match was
found in.
- `--function-context`: Tries to print the entire surrounding function
containing the match.
- Use 'Find in Workspace' in Xcode (<kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd>). - Use 'Find in Workspace' in Xcode (<kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>F</kbd>).
- Use `grep -i -r "mypattern" .`. - Use `grep --ignore-case --recursive "mypattern" .`.
2. Go through the [Documentation Index](/docs/README.md). 2. Go through the [Documentation Index](/docs/README.md).
### How do I build the documentation as HTML? ### How do I build the documentation as HTML?