about summary refs log tree commit homepage
path: root/Documentation/lei-blob.pod
DateCommit message (Collapse)
2022-08-11doc: spell out "PROTOCOL" in examples
"PROTO" is probably ambiguous, and we'll use the same terminology as used in curl(1) documentation.
2021-10-28doc: lei blob: wording fixups, describe --remote
There's no current way to retrieve blobs by OID directly from remote externals. Maybe the $INBOX_NAME/$OID/s/raw.eml endpoint could be overloaded for that.
2021-09-25doc: lei blob+rediff+p2q: add notes about git directory
Try to clarify these commands are intended to be useful for git-using (usually software) projects (and not the bare git repos we use internally). We'll also document some commonly useful git-diff switches in the lei-rediff man page to highlight the usefulness of the command.
2021-05-17doc lei: update manpages with new options
2021-05-17doc lei blob: point to lei-q for shared options
lei-blob shares a good number of options with lei-q. Refer to lei-q's manpage rather than repeating the descriptions. Also, add lei-q to lei-blob's "see also" section. Link: https://public-inbox.org/meta/YGFImEcWX1mCJJwv@dcvr/
2021-05-17doc: split option variants into separate items
e226f18934eb7291 modified the lei-q manpage so that each variant of an option gets a dedicated =item to make L</--xyz> look nicer and to follow the Perl core documentation. Do the same for the other manpages. Note that this still leaves the variants of an option grouped in one scenario: when a list of options without descriptions is presented as a pointer to another location. Splitting the variants in that case would make it harder for the reader to tell what the distinct options are.
2021-05-17doc lei blob: avoid combined description of separate options
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.
2021-05-04treewide: update to v3 Tor onions
v2 onions are insecure, deprecated and going away. v3 names are unfortunately longer and more difficult to remember, but should be more resistant to attack than v2 ones.
2021-03-29doc lei: add manpages for new commands