diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/.gitignore | 3 | ||||
| -rw-r--r-- | Documentation/fdl-1.3.texi | 505 | ||||
| -rw-r--r-- | Documentation/piem.texi | 599 |
3 files changed, 1107 insertions, 0 deletions
diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 0000000..8257c93 --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1,3 @@ +*.html +*.info + diff --git a/Documentation/fdl-1.3.texi b/Documentation/fdl-1.3.texi new file mode 100644 index 0000000..cb71f05 --- /dev/null +++ b/Documentation/fdl-1.3.texi @@ -0,0 +1,505 @@ +@c The GNU Free Documentation License. +@center Version 1.3, 3 November 2008 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +@uref{http://fsf.org/} + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, La@TeX{} input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The ``publisher'' means any person or entity that distributes copies +of the Document to the public. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +@item +RELICENSING + +``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +site means any set of copyrightable works thus published on the MMC +site. + +``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +``Incorporate'' means to publish or republish a Document, in whole or +in part, as part of another Document. + +An MMC is ``eligible for relicensing'' if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.''@: line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: diff --git a/Documentation/piem.texi b/Documentation/piem.texi new file mode 100644 index 0000000..aa48705 --- /dev/null +++ b/Documentation/piem.texi @@ -0,0 +1,599 @@ +\input texinfo @c -*-texinfo-*- + +@set VERSION 0.2.0 (unreleased) + +@setfilename piem.info +@documentencoding UTF-8 +@documentlanguage en +@settitle Emacs tools and glue for working with public-inbox archives + +@copying +Copyright @copyright{} 2020--2021 all contributors <piem@@inbox.kyleam.com> + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A +copy of the license is included in the section entitled ``GNU Free +Documentation License''. +@end copying + +@dircategory Emacs +@direntry +* piem: (piem). Emacs tools and glue for working with public-inbox archives +@end direntry + +@finalout +@titlepage +@title piem reference manual +@subtitle for version @value{VERSION} +@author Kyle Meyer +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents +@* + +@ifnottex +@node Top +@top piem + +This manual is for piem version @value{VERSION}. +@end ifnottex + + +@menu +* Overview:: +* Getting started:: +* Applying patches:: +* Miscellaneous functionality:: +* Contributing:: +* Related projects and tools:: + +Appendices +* GNU Free Documentation License:: The license for this documentation. + +Indices +* Key Index:: +* Variable Index:: +* Lisp Function Index:: +* Concept Index:: +@end menu + + +@node Overview +@chapter Overview + +piem is a collection of Emacs libraries for working with public-inbox +archives. As much of the hard work here is already done by other Emacs +libraries---things like mail clients, news readers, Git interfaces, and +even web browsers---piem is mostly about bridging some of these parts +for convenience. + +@node public-inbox +@section public-inbox +@cindex public-inbox +@cindex lore + +@url{https://public-inbox.org/README.html,public-inbox} is software for +archiving public mailing lists. Archives can be exposed over HTTP. As +examples, @url{https://public-inbox.org/meta} serves public-inbox's own +mailing list, and @url{https://lore.kernel.org/lists.html} hosts the +archives of many Linux development mailing lists. + +@cindex pull methods +These web archives are good for searching, particularly if you don't +have all of the list's messages on your local machine, or for linking to +a message. On the other hand, the web interface isn't convenient when +you want to follow new activity on a list. To do that, you could of +course subscribe to the mailing list, but public-inbox offers a few +``pull methods'' that you can use instead: + +@itemize +@item +an atom feed for the list as a whole or for specific searches +@item +read-only NNTP +@item +read-only IMAP (new in upcoming public-inbox v1.6.0) +@end itemize + +Finally, archives are exposed as one or more Git repositories, +facilitating replication (see +@url{https://public-inbox.org/reproducibility.html}). For example, you +can clone the mailing list archives of @samp{git.vger.kernel.org} with + +@example +git clone --mirror https://lore.kernel.org/git/0 git/git/0.git +@end example + +@noindent +After the initial clone, new messages can be retrieved with +@code{git fetch}. Unsurprisingly @code{git log} is not a pleasant way +to read a mailing list; instead this method is useful for mirroring the +archive or bulk importing of the messages. (See +@url{https://public-inbox.org/clients.html} for a list of some tools +designed to work with public-inbox archives.) + + +@node Getting started +@chapter Getting started +@findex piem-dispatch + +@code{piem-dispatch} transient +(see +@ifinfo +@ref{Top,,,transient} +@end ifinfo +@ifnotinfo +@url{https://magit.vc/manual/transient/} +@end ifnotinfo +) +provides an entry point to piem commands. +It's recommended to bind @code{piem-dispatch} to a key. However, before +most of those commands do anything useful, you need to register inboxes +and activate at least one minor mode. + +@node Registering inboxes +@section Registering inboxes +@cindex coderepo +@cindex inbox +@vindex piem-inboxes + +A public-inbox archive, referred to as an @dfn{inbox}, is registered by +adding an entry to @code{piem-inboxes}. Here's an example entry for the +Git project's mailing list: + +@lisp +("git" + :url "https://lore.kernel.org/git/" + :address "git@@vger.kernel.org" + :listid "git.vger.kernel.org" + :coderepo "~/src/git/") +@end lisp + +@noindent +The first element is a name for the inbox and will typically match the +name at the end of the @code{:url} value. Specifying either +@code{:listid} or @code{:address} is important so that a message in a +buffer can be mapped to an inbox in @code{piem-inboxes}. + +@code{:coderepo} points to a local Git repository that contains code +related to that archive (in the example above, a local clone of +@url{https://git.kernel.org/pub/scm/git/git.git/}). This information is +required to apply patches from an archive to a local code repository +(@pxref{Applying patches}). + +@node Enabling integration libraries +@section Enabling integration libraries +@findex piem-elfeed-mode +@findex piem-eww-mode +@findex piem-gnus-mode +@findex piem-notmuch-mode + +With inboxes defined, the next step is to enable minor modes that teach +particular Emacs modes to link a buffer with a registered inbox. piem +currently has libraries to support + +@itemize +@item EWW +@item Elfeed +@item Gnus +@item Notmuch +@end itemize + +For example, if you use notmuch.el to read your mail, you can add +support for applying patches from a Notmuch message buffer by enabling +@code{piem-notmuch-mode} (@pxref{Applying patches}): + +@lisp +(piem-notmuch-mode 1) +@end lisp + +Help adding support for other modes, especially other mail clients, is +welcome. + + +@node Applying patches +@chapter Applying patches +@cindex am-ready mbox +@cindex applying patches +@cindex git-am + +With @code{piem-inboxes} configured and appropriate integration +libraries enabled, a buffer that can be linked to an inbox can be mapped +to a code repository. When reading a message in a +@code{notmuch-show-mode} buffer, for example, the list ID can be used to +identify the inbox and thus the associated local code repository. + +There are two commands for applying patches: + +@table @code + +@item piem-am +@findex piem-am +This command tries to extract a patch from the current Notmuch or Gnus +message buffer and can handle an inline patch as well as one or more +patch attachments. + +@item piem-b4-am +@findex piem-b4-am +This command relies on the b4 command-line tool to do more sophisticated +processing of the @emph{full thread} (e.g., pulling out the latest +reroll of a series) to generate an mbox that can be fed to @code{git +am}. It is only compatible with inline patches. + +@end table + +@node Applying patches contained in a message +@section Applying patches contained in a message + +@table @kbd +@findex piem-am +@item M-x piem-am @key{RET} @var{branch} @key{RET} @var{base} +Apply the patch or patches in the current buffer to the associated code +repository. Before applying, checkout a new branch @var{branch} +starting at @var{base}. +@end table + +@findex piem-name-branch-who-what-v +@vindex piem-default-branch-function +You'll be queried for the name of the new branch. The default name +offered is generated by @code{piem-name-branch-who-what-v}, which uses +the @samp{From:} and @samp{Subject:} headers to construct branch names +like @samp{km/b4-short-subj__v3}. To use a different function to +generate the completion default, configure +@code{piem-default-branch-function}. + +Next you'll be queried for the base to use as the starting point for the +branch. If the sender specified a base commit for the series, that will +be provided as the default completion candidate. Entering an empty base +signals to use the current branch of the repository as the base. + +@vindex piem-am-create-worktree +@vindex piem-am-read-worktree-function +Rather than applying the patches directly to the associated code +repository, you can create a dedicated worktree by setting +@code{piem-am-create-worktree} to a non-nil value. Giving a prefix +argument to @code{piem-am} inverts the meaning of +@code{piem-am-create-worktree}; that is, by default a prefix argument is +useful if you generally prefer to work within the configured code +repository but would like to trigger the one-off creation of a worktree +for a particular call. + +@cindex magit +@vindex piem-use-magit +When piem loads, it detects whether Magit is loaded and sets +@code{piem-use-magit} accordingly. If that option is non-nil, piem uses +Magit for some operations, particularly those that are user-facing. +This includes jumping to the Magit status buffer for a code repository +after applying a patch. + +@findex piem-am-ready-mbox +Note that the @code{piem-am} command works only for buffers from which +@code{piem-am-ready-mbox} can generate an am-ready mbox, which depends +on the enabled integration libraries. Currently @code{piem-notmuch} and +@code{piem-gnus} implement the necessary functionality. + +@node Using b4 to apply patches +@section Using b4 to apply patches +@cindex b4 +@cindex lore + +@url{https://git.kernel.org/pub/scm/utils/b4/b4.git,b4} is a +command-line tool for interacting with public-inbox archives. While +useful for public-inbox archives in general, it is written for Linux +kernel development and focuses on the public-inbox archives hosted at +@url{https://lore.kernel.org}. + +It's a fast moving target at the moment, but some of its current +capabilities include + +@itemize +@item +downloading the mbox for a thread based on a given message ID +@item +extracting patches from a thread's mbox that can be fed to @code{git am} +@item +submitting and verifying cryptographic attestation for patches +@item +fetching a pull request found in a message ID +@item +generating a thanks email for patches +@end itemize + +@noindent +The second item is the focus for piem, though at least some degree of +support for all of the above features will likely be added. +The entry point to applying patches with b4 is the @code{piem-b4-am} +transient. (See +@ifinfo +@ref{Top,,,transient} +@end ifinfo +@ifnotinfo +@url{https://magit.vc/manual/transient/} +@end ifnotinfo +for more information on using Transient.) + +@findex piem-b4-am +@code{piem-b4-am} offers the following actions: + +@table @kbd + +@item a +@itemx M-x piem-b4-am-from-mid +@findex piem-b4-am-from-mid +@findex piem-mid +@vindex piem-am-create-worktree +@vindex piem-am-read-worktree-function +Generate or download a thread's mbox for the current buffer's message +ID, process it into an am-ready mbox with b4, and then feed it to +@code{git am} called within an associated Git repository. If a message +ID of the current buffer is not known (i.e. @code{piem-mid} returns +nil), one is read from the caller. The caller is also queried for the +branch name and base, as described for @code{piem-am} (@pxref{Applying +patches contained in a message}). And, as with @code{piem-am}, a +worktree can be created by configuring @code{piem-am-create-worktree} to +a non-nil value or by giving a prefix argument. + +@findex piem-mid-to-thread-functions +To generate the input thread, first any functions in +@code{piem-mid-to-thread-functions} are tried. This allows for a thread +to be retrieved from a local store (e.g., the Notmuch database). If +that fails, the thread is downloaded from the public-inbox URL +associated with the current buffer. Finally, if an inbox's entry in +@code{piem-inboxes} doesn't specify a URL, @code{b4 am} is called +without a local mbox, letting it download the thread according to its +own configuration. + +@item i +@itemx M-x piem-b4-am-ready-from-mid +@findex piem-b4-am-ready-from-mid +Call @code{b4 am} with a given message ID. This differs from +@code{piem-b4-am-from-mid} in that it is a direct wrapper around a +command-line call to @code{b4 am}. The caller is always queried for the +message ID, and the final product is an am-ready mbox. @code{b4} is +responsible for downloading the thread, so the caller must point b4's +configuration option @code{b4.midmask} to the appropriate public-inbox +URL. + +@item b +@itemx M-x piem-b4-am-ready-from-mbox +@findex piem-b4-am-ready-from-mbox +Like @code{piem-b4-am-ready-from-mid}, but process a local mbox rather +than identifying the thread based on the specified message ID. + +@end table + +@node Applying patches without a public-inbox archive +@section Applying patches without a public-inbox archive + +Much of the functionality described in the previous sections can work +even if messages aren't available in a public-inbox archive. +@code{piem-am} and @code{piem-b4-am-from-mid} try to generate the +am-ready mbox from a local source (e.g., via Notmuch or Gnus) before +falling back to downloading the thread from a public-inbox archive. + +@cindex mailscripts +Also, for those not working with public-inbox archives, it's worth +checking out @url{https://git.spwhitton.name/mailscripts/,mailscripts}, +a nice set of Debian-focused tools by Sean Whitton that provides, among +other things, functionality for applying patch series, including +b4-inspired patch extraction. + + +@node Miscellaneous functionality +@chapter Miscellaneous functionality + +@node Injecting messages into a Maildir directory +@section Injecting messages into a Maildir directory +@cindex Maildir + +public-inbox allows you to follow lists through several mechanisms +(@pxref{public-inbox}). You may prefer different methods for different +projects depending on things like how actively you are following the +development and how high traffic the list is. For a project you +maintain, perhaps you want to receive every message as regular mail. +For a project you actively follow and occasionally contribute to, you +may prefer to not clutter your local mail store and instead follow via +read-only NNTP or IMAP in Gnus (which may or may not be your MUA). And +for a project you're new to or are digging into for a particular reason, +HTTP via EWW may be all you need. + +@findex piem-inject-thread-into-maildir +@vindex piem-maildir-directory +Depending on your mail setup, a problem with this approach is that it +can be inconvenient to start participating in a thread that you aren't +reading in your regular MUA (e.g., if you use notmuch.el to read your +regular mail but are following a project via NNTP in Gnus). In this +case, you can use the command @code{piem-inject-thread-into-maildir} to +move the thread's messages into a local Maildir directory +(@code{piem-maildir-directory}). By default the command downloads the +entire thread for the message ID associated with the current buffer. A +prefix argument restricts the download to only the message. + +@vindex piem-after-mail-injection-functions +After the messages are injected, each function in +@code{piem-after-mail-injection-functions} is called with the message ID +that was used to identify the thread. This can be used to pop to the +message in your mail client. For example, Notmuch users may want +something like this: + +@lisp +(defun my/notmuch-new-and-show (mid) + (message "Running notmuch new") + (call-process notmuch-command nil nil nil "new") + (notmuch-show (concat "id:" mid))) + +(add-hook 'piem-after-mail-injection-functions + #'my/notmuch-new-and-show) +@end lisp + +@vindex piem-mail-injection-skipif-predicate +@findex piem-notmuch-known-mid-p +To prevent duplicate messages from being written on subsequent calls to +@code{piem-inject-thread-into-maildir}, you can set +@code{piem-mail-injection-skipif-predicate} to a function that returns +non-nil if a message ID is known and should be skipped. For Notmuch, +@code{piem-notmuch} provides a function that works for this purpose, +@code{piem-notmuch-known-mid-p}: + +@lisp +(setq piem-mail-injection-skipif-predicate + #'piem-notmuch-known-mid-p) +@end lisp + +@node Copying public-inbox URLs +@section Copying public-inbox URLs + +@findex piem-copy-mid-url +When referring to a message from a public-inbox archive, a common format +to use is a URL that points to a specific archive and ends with +@code{/$INBOX/$MESSAGE_ID}, e.g., +@url{https://public-inbox.org/meta/20190108015420.GA28903@@dcvr}. +Calling @code{piem-copy-mid-url} (available in the @code{piem-dispatch} +transient) constructs such a URL, using the message ID and inbox +asscociated with the current buffer, and then copies the URL to the kill +ring. When a prefix agument is given, @code{browse-url} is called after +copying the URL. + +@vindex piem-browse-url-browser-function +Note that EWW works nicely with public-inbox's HTTP interface. If you'd +prefer it to be invoked even though it's not your default browser (as +configured by @code{browse-url-browser-function}), you can set +@code{piem-browse-url-browser-function} to @code{eww-browse-url}. + +@findex piem-notmuch-mode +@findex piem-notmuch-show-get-public-inbox-link +For notmuch.el users, there's an additional entry point for copying +public-inbox URLs: enabling @code{piem-notmuch-mode} adds a ``piem'' +candidate to archives offered by +@code{notmuch-show-stash-mlarchive-link} and +@code{notmuch-show-stash-mlarchive-link-and-go}. + + +@node Contributing +@chapter Contributing + +Patches, bug reports, and other feedback are welcome. Please send a +plain-text email to @email{piem@@inbox.kyleam.com}. Messages that +include this address are public and available as public-inbox archives +at @url{https://inbox.kyleam.com/piem}. Note that this is not a mailing +list. Updates can be followed through one of public-inbox's pull +methods (@pxref{public-inbox}). This means it is particularly important +to @emph{not} drop participants when replying. + +You can, unsurprisingly, use piem to work on piem by adding an entry +like this to @code{piem-inboxes}. + +@lisp +("piem" + :coderepo "<path/to/local/clone>" + :address "piem@@inbox.kyleam.com" + :url "https://inbox.kyleam.com/piem/") +@end lisp + +The source repository is available at @url{https://git.kyleam.com/piem}. +Here are some guidelines for sending patches: + +@itemize +@item Please send patches inline rather than as attachments. + +If you're using @code{git send-email}, you may want to set +@code{sendemail.to} to @code{piem@@inbox.kyleam.com} in your local +repository. + +@item Specify the base commit. + +This can be done via the @code{--base=} option of @code{git +format-patch} or by configuring @code{format.useAutoBase}. + +@item Keep rerolls in the same thread. + +In general, prefer to keep iterations of a patch series in the same +thread, labeling rerolls with an appropriate version. + +@item Consider adding a range-diff to the cover letter of rerolls. + +For a multi-patch series, @code{git range-diff} can often provide a nice +overview of the changes between the previous and last iteration. Note +that @code{git format-patch} has a @code{--range-diff} convenience +option. + +@end itemize + + +@node Related projects and tools +@chapter Related projects and tools + +Here's a (short and incomplete) list of tools that you, as someone that +cared to look at piem's manual, may be interested in---things that +either have some connection to public-inbox or to using an email-based +development workflow in Emacs. Corrections and additions are welcome. + +@itemize + +@item +git-email provides an Emacs interface for preparing and sending patches. + +@url{https://sr.ht/~yoctocell/git-email/} + +@cindex magit +@item +@code{git range-diff} is a built-in Git command for comparing iterations +of a patch series. If you use Magit, the +@url{https://github.com/magit/magit-tbdiff,magit-tbdiff} extension +provides an interface for @code{git range-diff}. + +@url{https://kernel.org/pub/software/scm/git/docs/git-range-diff.html} + +@item +grokmirror enables efficient replication of large Git repository +collections. The HTTP interface for public-inbox exposes a +grokmirror-compatible manifest.js.gz endpoint. + +@url{https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git} + +@cindex mailscripts +@item +mailscripts, mentioned earlier in the manual (@pxref{Applying patches +without a public-inbox archive}), is a ``collection of scripts for +manipulating e-mail on Debian'', including b4-inspired patch extraction +and an Emacs interface for some of the functionality. + +@url{https://git.spwhitton.name/mailscripts/} + +@end itemize + +A list of more public-inbox-related tools is at +@url{https://public-inbox.org/clients.txt}. + + +@node GNU Free Documentation License +@chapter GNU Free Documentation License +@include fdl-1.3.texi + +@node Key Index +@unnumbered Key Index + +@printindex ky + +@node Variable Index +@unnumbered Variable Index + +@printindex vr + +@node Lisp Function Index +@unnumbered Function Index + +@printindex fn + +@node Concept Index +@unnumbered Concept Index + +@printindex cp + + +@bye |