From: Kyle Meyer <kyle@kyleam.com>
To: meta@public-inbox.org
Subject: [PATCH 1/9] doc lei blob: avoid combined description of separate options
Date: Sun, 16 May 2021 23:35:20 -0400 [thread overview]
Message-ID: <20210517033528.18966-2-kyle@kyleam.com> (raw)
In-Reply-To: <20210517033528.18966-1-kyle@kyleam.com>
The next commit will update the manpages to split each option's
variants into separate items. This change won't mix well with
--oid-a, --path-a, and --path-b. These different options all share a
single description, and, if each form is on its own line, the link
between the variants of each option would no longer be clear.
Use a dedicated description for each option to avoid confusion.
---
Documentation/lei-blob.pod | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/Documentation/lei-blob.pod b/Documentation/lei-blob.pod
index bb316e71..341b5505 100644
--- a/Documentation/lei-blob.pod
+++ b/Documentation/lei-blob.pod
@@ -33,12 +33,15 @@ C<--oid-a>, C<--path-a>, and C<--path-b>.
=item -A OID-A, --oid-a=OID-A
+Provide pre-image object ID as a hint for reconstructing C<OID>.
+
=item -a PATH-A, --path-a=PATH-A
+Provide pre-image pathname as a hint for reconstructing C<OID>.
+
=item -b PATH-B, --path-b=PATH-B
-Provide pre-image object ID, pre-image pathname, or post-image
-pathname as a hint for reconstructing C<OID>.
+Provide post-image pathname as a hint for reconstructing C<OID>.
=for comment
TODO: The below options are shared with lei-q. Any good approaches to
--
2.31.1
next prev parent reply other threads:[~2021-05-17 3:35 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-17 3:35 [PATCH 0/9] doc: lei manpages, round 5 Kyle Meyer
2021-05-17 3:35 ` Kyle Meyer [this message]
2021-05-17 3:35 ` [PATCH 2/9] doc: split option variants into separate items Kyle Meyer
2021-05-17 3:35 ` [PATCH 3/9] doc lei blob: point to lei-q for shared options Kyle Meyer
2021-05-17 3:35 ` [PATCH 4/9] doc lei: resort lei-tag entries Kyle Meyer
2021-05-17 3:35 ` [PATCH 5/9] doc lei q: fix a typo Kyle Meyer
2021-05-17 3:35 ` [PATCH 6/9] doc lei q: add missing value for --lock Kyle Meyer
2021-05-17 3:35 ` [PATCH 7/9] doc lei: add manpage for convert Kyle Meyer
2021-05-17 3:35 ` [PATCH 8/9] doc lei: add manpages for new commands Kyle Meyer
2021-05-17 8:09 ` Eric Wong
2021-05-17 23:24 ` Kyle Meyer
2021-05-17 3:35 ` [PATCH 9/9] doc lei: update manpages with new options Kyle Meyer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210517033528.18966-2-kyle@kyleam.com \
--to=kyle@kyleam.com \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).