diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-03-28 23:11:15 -0400 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-03-29 03:15:42 +0000 |
commit | 510b02746ca53e80b9bfed82ab589f43e20bacab (patch) | |
tree | 9b1d814a5cf1a12973a0655e26d7e063a0c9bb9e /Documentation/lei-p2q.pod | |
parent | 752f1a1c6c3220911bd11e879b24caf660e24058 (diff) | |
download | public-inbox-510b02746ca53e80b9bfed82ab589f43e20bacab.tar.gz |
Diffstat (limited to 'Documentation/lei-p2q.pod')
-rw-r--r-- | Documentation/lei-p2q.pod | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod new file mode 100644 index 00000000..cc342bd5 --- /dev/null +++ b/Documentation/lei-p2q.pod @@ -0,0 +1,79 @@ +=head1 NAME + +lei-p2q - use a patch to generate a lei-q query + +=head1 SYNOPSIS + +lei p2q [OPTIONS] (FILE|COMMIT) + +lei p2q [OPTIONS] (--stdin|-) + +=head1 DESCRIPTION + +Given a patch, create a query that can be fed on stdin to L<lei-q(1)>. +This is useful for mapping the patch to associated messages of an +inbox. + +The patch can be provided on stdin or as a file. Alternatively, when +an argument is given that does not point to an existing file, it is +taken as a reference to a commit in the current repository, and +L<git-format-patch(1)> is used to generate the patch. + +=head1 OPTIONS + +=over + +=item -w PREFIX[,PREFIX], --want=PREFIX[,PREFIX] + +Search prefixes to use. C<dfpost> (post-image git blob ID) and C<dfn> +(file names from the diff) are the most useful. Other available +values are C<dfa>, C<dfb>, C<dfctx>, C<dfhh>, and C<dfpre>. + +=for comment +TODO: Put a table of prefixes somewhere and reference that (at least +here and in lei-q)? + +Appending an integer to C<dfpost> or C<dfpre> indicates a minimum ID +length, and the generated query will be for that value up through the +default abbreviation length. For example, if the repository's +C<core.abbrev> is set to C<auto> and git calculates the default +abbreviation length as 7, C<dfpost6> will expand a post-image blob ID +of e7b4b32 (seven characters) into C<dfpost:e7b4b32 OR dfpost:e7b4b3>. + +This option may be given multiple times. + +Default: C<dfpost7> + +=item --stdin + +Read patch from stdin. + +=item --debug + +Dump output that shows the information collected for every prefix. +This information can be useful for seeing how a patch is processed, +but the format should not be considered stable. + +=item -q, --quiet + +Suppress feedback messages. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + + +=head1 SEE ALSO + +L<lei-add-external(1)> |