diff options
author | Roger Shimizu <rosh@debian.org> | 2021-06-20 21:41:05 +0900 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2021-07-16 20:11:41 +0000 |
commit | 0a1f533e2835c856473e3e4046341a4d2f66764b (patch) | |
tree | 0902c039b76525f1c6785cec561df46265fdb787 /man/repo-grep.1 | |
parent | 927d29a8afa26a3f1aec841f2150c65e3931ef9b (diff) | |
download | git-repo-0a1f533e2835c856473e3e4046341a4d2f66764b.tar.gz |
Add script 'release/update-manpages' to generate manpages
Debian package started to ship manpages for repo since 2.8 [1]
And it's about for one year. So I think it should be upstreamed.
The script depends on help2man, which is available in both debian [2]
and ubuntu [3].
[1] https://tracker.debian.org/news/1150858/accepted-repo-28-1-source-into-unstable
[2] https://tracker.debian.org/pkg/help2man
[3] https://launchpad.net/ubuntu/+source/help2man
Change-Id: Ide2b356d0944ebde34cc96c6d5a782655bd72288
Signed-off-by: Roger Shimizu <rosh@debian.org>
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/309782
Reviewed-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'man/repo-grep.1')
-rw-r--r-- | man/repo-grep.1 | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/man/repo-grep.1 b/man/repo-grep.1 new file mode 100644 index 00000000..fb515a7b --- /dev/null +++ b/man/repo-grep.1 | |||
@@ -0,0 +1,118 @@ | |||
1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man. | ||
2 | .TH REPO "1" "July 2021" "repo grep" "Repo Manual" | ||
3 | .SH NAME | ||
4 | repo \- repo grep - manual page for repo grep | ||
5 | .SH SYNOPSIS | ||
6 | .B repo | ||
7 | \fI\,grep {pattern | -e pattern} \/\fR[\fI\,<project>\/\fR...] | ||
8 | .SH DESCRIPTION | ||
9 | Summary | ||
10 | .PP | ||
11 | Print lines matching a pattern | ||
12 | .SH OPTIONS | ||
13 | .TP | ||
14 | \fB\-h\fR, \fB\-\-help\fR | ||
15 | show this help message and exit | ||
16 | .TP | ||
17 | \fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR | ||
18 | number of jobs to run in parallel (default: 4) | ||
19 | .SS Logging options: | ||
20 | .TP | ||
21 | \fB\-\-verbose\fR | ||
22 | show all output | ||
23 | .TP | ||
24 | \fB\-q\fR, \fB\-\-quiet\fR | ||
25 | only show errors | ||
26 | .SS Sources: | ||
27 | .TP | ||
28 | \fB\-\-cached\fR | ||
29 | Search the index, instead of the work tree | ||
30 | .TP | ||
31 | \fB\-r\fR TREEish, \fB\-\-revision\fR=\fI\,TREEish\/\fR | ||
32 | Search TREEish, instead of the work tree | ||
33 | .SS Pattern: | ||
34 | .TP | ||
35 | \fB\-e\fR PATTERN | ||
36 | Pattern to search for | ||
37 | .TP | ||
38 | \fB\-i\fR, \fB\-\-ignore\-case\fR | ||
39 | Ignore case differences | ||
40 | .TP | ||
41 | \fB\-a\fR, \fB\-\-text\fR | ||
42 | Process binary files as if they were text | ||
43 | .TP | ||
44 | \fB\-I\fR | ||
45 | Don't match the pattern in binary files | ||
46 | .TP | ||
47 | \fB\-w\fR, \fB\-\-word\-regexp\fR | ||
48 | Match the pattern only at word boundaries | ||
49 | .TP | ||
50 | \fB\-v\fR, \fB\-\-invert\-match\fR | ||
51 | Select non\-matching lines | ||
52 | .TP | ||
53 | \fB\-G\fR, \fB\-\-basic\-regexp\fR | ||
54 | Use POSIX basic regexp for patterns (default) | ||
55 | .TP | ||
56 | \fB\-E\fR, \fB\-\-extended\-regexp\fR | ||
57 | Use POSIX extended regexp for patterns | ||
58 | .TP | ||
59 | \fB\-F\fR, \fB\-\-fixed\-strings\fR | ||
60 | Use fixed strings (not regexp) for pattern | ||
61 | .SS Pattern Grouping: | ||
62 | .TP | ||
63 | \fB\-\-all\-match\fR | ||
64 | Limit match to lines that have all patterns | ||
65 | .TP | ||
66 | \fB\-\-and\fR, \fB\-\-or\fR, \fB\-\-not\fR | ||
67 | Boolean operators to combine patterns | ||
68 | .TP | ||
69 | \-(, \-) | ||
70 | Boolean operator grouping | ||
71 | .SS Output: | ||
72 | .TP | ||
73 | \fB\-n\fR | ||
74 | Prefix the line number to matching lines | ||
75 | .TP | ||
76 | \fB\-C\fR CONTEXT | ||
77 | Show CONTEXT lines around match | ||
78 | .TP | ||
79 | \fB\-B\fR CONTEXT | ||
80 | Show CONTEXT lines before match | ||
81 | .TP | ||
82 | \fB\-A\fR CONTEXT | ||
83 | Show CONTEXT lines after match | ||
84 | .TP | ||
85 | \fB\-l\fR, \fB\-\-name\-only\fR, \fB\-\-files\-with\-matches\fR | ||
86 | Show only file names containing matching lines | ||
87 | .TP | ||
88 | \fB\-L\fR, \fB\-\-files\-without\-match\fR | ||
89 | Show only file names not containing matching lines | ||
90 | .PP | ||
91 | Run `repo help grep` to view the detailed manual. | ||
92 | .SH DETAILS | ||
93 | .PP | ||
94 | Search for the specified patterns in all project files. | ||
95 | .PP | ||
96 | Boolean Options | ||
97 | .PP | ||
98 | The following options can appear as often as necessary to express the pattern to | ||
99 | locate: | ||
100 | .HP | ||
101 | \fB\-e\fR PATTERN | ||
102 | .HP | ||
103 | \fB\-\-and\fR, \fB\-\-or\fR, \fB\-\-not\fR, \-(, \-) | ||
104 | .PP | ||
105 | Further, the \fB\-r\fR/\-\-revision option may be specified multiple times in order to | ||
106 | scan multiple trees. If the same file matches in more than one tree, only the | ||
107 | first result is reported, prefixed by the revision name it was found under. | ||
108 | .PP | ||
109 | Examples | ||
110 | .PP | ||
111 | Look for a line that has '#define' and either 'MAX_PATH or 'PATH_MAX': | ||
112 | .IP | ||
113 | repo grep \fB\-e\fR '#define' \fB\-\-and\fR \-\e( \fB\-e\fR MAX_PATH \fB\-e\fR PATH_MAX \e) | ||
114 | .PP | ||
115 | Look for a line that has 'NODE' or 'Unexpected' in files that contain a line | ||
116 | that matches both expressions: | ||
117 | .IP | ||
118 | repo grep \fB\-\-all\-match\fR \fB\-e\fR NODE \fB\-e\fR Unexpected | ||