]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-p2q.pod
doc: lei-overview: favor Maildir for mutt examples
[public-inbox.git] / Documentation / lei-p2q.pod
1 =head1 NAME
2
3 lei-p2q - use a patch to generate a lei-q query
4
5 =head1 SYNOPSIS
6
7 lei p2q [OPTIONS] (FILE|COMMIT)
8
9 lei p2q [OPTIONS] (--stdin|-)
10
11 =head1 DESCRIPTION
12
13 Given a patch, create a query that can be fed on stdin to L<lei-q(1)>.
14 This is useful for mapping the patch to associated messages of an
15 inbox.
16
17 The patch can be provided on stdin or as a file.  Alternatively, when
18 an argument is given that does not point to an existing file, it is
19 taken as a reference to a commit in the current repository, and
20 L<git-format-patch(1)> is used to generate the patch.
21
22 =head1 OPTIONS
23
24 =over
25
26 =item -w PREFIX[,PREFIX], --want=PREFIX[,PREFIX]
27
28 Search prefixes to use.  C<dfpost> (post-image git blob ID) and C<dfn>
29 (file names from the diff) are the most useful.  Other available
30 values are C<dfa>, C<dfb>, C<dfctx>, C<dfhh>, and C<dfpre>.
31
32 =for comment
33 TODO: Put a table of prefixes somewhere and reference that (at least
34 here and in lei-q)?
35
36 Appending an integer to C<dfpost> or C<dfpre> indicates a minimum ID
37 length, and the generated query will be for that value up through the
38 default abbreviation length.  For example, if the repository's
39 C<core.abbrev> is set to C<auto> and git calculates the default
40 abbreviation length as 7, C<dfpost6> will expand a post-image blob ID
41 of e7b4b32 (seven characters) into C<dfpost:e7b4b32 OR dfpost:e7b4b3>.
42
43 This option may be given multiple times.
44
45 Default: C<dfpost7>
46
47 =item --stdin
48
49 Read patch from stdin.
50
51 =item --debug
52
53 Dump output that shows the information collected for every prefix.
54 This information can be useful for seeing how a patch is processed,
55 but the format should not be considered stable.
56
57 =item -q, --quiet
58
59 Suppress feedback messages.
60
61 =back
62
63 =head1 CONTACT
64
65 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
66
67 The mail archives are hosted at L<https://public-inbox.org/meta/>
68 and L<http://hjrcffqmbrq6wope.onion/meta/>
69
70 =head1 COPYRIGHT
71
72 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
73
74 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
75
76
77 =head1 SEE ALSO
78
79 L<lei-add-external(1)>