Emacs tools and glue for working with public-inbox archives

Table of Contents


Next: , Up: (dir)   [Contents][Index]

piem

This manual is for piem version 0.2.0 (unreleased).


Next: , Previous: , Up: Top   [Contents][Index]

1 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.


Up: Overview   [Contents][Index]

1.1 public-inbox

public-inbox is software for archiving public mailing lists. Archives can be exposed over HTTP. As examples, https://public-inbox.org/meta serves public-inbox’s own mailing list, and https://lore.kernel.org/lists.html hosts the archives of many Linux development mailing lists.

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:

Finally, archives are exposed as one or more Git repositories, facilitating replication (see https://public-inbox.org/reproducibility.html). For example, you can clone the mailing list archives of ‘git.vger.kernel.org’ with

git clone --mirror https://lore.kernel.org/git/0 git/git/0.git

After the initial clone, new messages can be retrieved with via git fetch. Unsurprisingly 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 https://public-inbox.org/clients.html for a list of some tools designed to work with public-inbox archives.)


Next: , Previous: , Up: Top   [Contents][Index]

2 Getting started

piem-dispatch transient (see https://magit.vc/manual/transient/ ) provides an entry point to piem commands. It’s recommended to bind 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.


Next: , Up: Getting started   [Contents][Index]

2.1 Registering inboxes

A public-inbox archive, referred to as an inbox, is registered by adding an entry to piem-inboxes. Here’s an example entry for the Git project’s mailing list:

("git"
 :url "https://lore.kernel.org/git/"
 :address "git@vger.kernel.org"
 :listid "git.vger.kernel.org"
 :coderepo "~/src/git/")

The first element is a name for the inbox and will typically match the name at the end of the :url value. Specifying either :listid or :address is important so that a message in a buffer can be mapped to an inbox in piem-inboxes.

:coderepo points to a local Git repository that contains code related to that archive (in the example above, a local clone of https://git.kernel.org/pub/scm/git/git.git/). This information is required to apply patches from an archive to a local code repository (see Applying patches).


Previous: , Up: Getting started   [Contents][Index]

2.2 Enabling integration libraries

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

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 piem-notmuch-mode (see Applying patches):

(piem-notmuch-mode 1)

Help adding support for other modes, especially other mail clients, is welcome.


Next: , Previous: , Up: Top   [Contents][Index]

3 Applying patches

With 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 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:

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.

piem-b4-am

This command relies on the b4 command-line tool to do more sophisticated processing of the full thread (e.g., pulling out the latest reroll of a series) to generate an mbox that can be fed to git am. It is only compatible with inline patches.


Next: , Up: Applying patches   [Contents][Index]

3.1 Applying patches contained in a message

M-x piem-am RET branch RET base

Apply the patch or patches in the current buffer to the associated code repository. Before applying, checkout a new branch branch starting at base.

You’ll be queried for the name of the new branch. The default name offered is generated by piem-name-branch-who-what-v, which uses the ‘From:’ and ‘Subject:’ headers to construct branch names like ‘km/b4-short-subj__v3’. To use a different function to generate the completion default, configure 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.

Rather than applying the patches directly to the associated code repository, you can create a dedicated worktree by setting piem-am-create-worktree to a non-nil value. Giving a prefix argument to piem-am inverts the meaning of 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.

When piem loads, it detects whether Magit is loaded and sets 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.

Note that the piem-am command works only for buffers from which piem-am-ready-mbox can generate an am-ready mbox, which depends on the enabled integration libraries. Currently piem-notmuch and piem-gnus implement the necessary functionality.


Next: , Previous: , Up: Applying patches   [Contents][Index]

3.2 Using b4 to apply patches

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 https://lore.kernel.org.

It’s a fast moving target at the moment, but some of its current capabilities include

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 piem-b4-am transient. (See https://magit.vc/manual/transient/ for more information on using Transient.)

piem-b4-am offers the following actions:

a
M-x piem-b4-am-from-mid

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 git am called within an associated Git repository. If a message ID of the current buffer is not known (i.e. piem-mid returns nil), one is read from the caller. The caller is also queried for the branch name and base, as described for piem-am (see Applying patches contained in a message). And, as with piem-am, a worktree can be created by configuring piem-am-create-worktree to a non-nil value or by giving a prefix argument.

To generate the input thread, first any functions in 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 piem-inboxes doesn’t specify a URL, b4 am is called without a local mbox, letting it download the thread according to its own configuration.

i
M-x piem-b4-am-ready-from-mid

Call b4 am with a given message ID. This differs from piem-b4-am-from-mid in that it is a direct wrapper around a command-line call to b4 am. The caller is always queried for the message ID, and the final product is an am-ready mbox. b4 is responsible for downloading the thread, so the caller must point b4’s configuration option b4.midmask to the appropriate public-inbox URL.

b
M-x piem-b4-am-ready-from-mbox

Like piem-b4-am-ready-from-mid, but process a local mbox rather than identifying the thread based on the specified message ID.


Previous: , Up: Applying patches   [Contents][Index]

3.3 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. piem-am and 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.

Note, however, that the piem-notmuch integration library is currently the only library that can generate an entire thread from a given message ID. As a result, if you’re not a Notmuch user and are working with a project that doesn’t have a public-inbox archive, you’re unlikely to find the piem-b4-am-from-mid command useful.

Also, for those not working with public-inbox archives, it’s worth checking out 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.


Next: , Previous: , Up: Top   [Contents][Index]

4 Injecting messages into a Maildir directory

public-inbox allows you to follow lists through several mechanisms (see 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.

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 piem-inject-thread-into-maildir to move the thread’s messages into a local Maildir directory (piem-maildir-directory). By default the command downloads entire thread for the message ID associated with the current buffer. A prefix argument restricts the download to only the message.

After the messages are injected, each function in 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:

(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)

To prevent duplicate messages from being written on subsequent calls to piem-inject-thread-into-maildir, you can set piem-mail-injection-skipif-predicate to a function that returns non-nil if a message ID is known and should be skipped. For Notmuch, piem-notmuch provides a function that works for this purpose, piem-notmuch-known-mid-p:

(setq piem-mail-injection-skipif-predicate
      #'piem-notmuch-known-mid-p)

Next: , Previous: , Up: Top   [Contents][Index]

5 Contributing

Patches, bug reports, and other feedback are welcome. Please send a plain-text email to piem@inbox.kyleam.com. Messages that include this address are public and available as public-inbox archives at https://inbox.kyleam.com/piem. Note that this is not a mailing list, and there are no subcribers. Updates can be followed through one of public-inbox’s pull methods (see public-inbox). This means it is particularly important to not drop participants when replying 1.

You can, unsurprisingly, use piem to work on piem by adding an entry like this to piem-inboxes.

("piem"
 :coderepo "<path/to/local/clone>"
 :address "piem@inbox.kyleam.com"
 :url "https://inbox.kyleam.com/piem/")

The source repository is available at https://git.kyleam.com/piem. Here are some guidelines for sending patches:


Next: , Previous: , Up: Top   [Contents][Index]

6 GNU Free Documentation License

Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document 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.

  2. 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, LaTeX 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.

  3. 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.

  4. 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.

  5. 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:

    1. 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.
    2. 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.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. 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.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. 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.
    10. 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.
    11. 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.
    12. 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.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    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.

  6. 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.”

  7. 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.

  8. 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.

  9. 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.

  10. 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.

  11. 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 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.

  12. 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.

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:

  Copyright (C)  year  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''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

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.


Next: , Previous: , Up: Top   [Contents][Index]

Key Index


Next: , Previous: , Up: Top   [Contents][Index]

Variable Index

Jump to:   P  
Index Entry  Section

P
piem-after-mail-injection-functions: Injecting messages into a Maildir directory
piem-am-create-worktree: Applying patches contained in a message
piem-am-create-worktree: Using b4 to apply patches
piem-am-read-worktree-function: Applying patches contained in a message
piem-am-read-worktree-function: Using b4 to apply patches
piem-default-branch-function: Applying patches contained in a message
piem-inboxes: Registering inboxes
piem-mail-injection-skipif-predicate: Injecting messages into a Maildir directory
piem-maildir-directory: Injecting messages into a Maildir directory
piem-use-magit: Applying patches contained in a message

Jump to:   P  

Next: , Previous: , Up: Top   [Contents][Index]

Function Index

Jump to:   P  
Index Entry  Section

P
piem-am: Applying patches
piem-am: Applying patches contained in a message
piem-am-ready-mbox: Applying patches contained in a message
piem-b4-am: Applying patches
piem-b4-am: Using b4 to apply patches
piem-b4-am-from-mid: Using b4 to apply patches
piem-b4-am-ready-from-mbox: Using b4 to apply patches
piem-b4-am-ready-from-mid: Using b4 to apply patches
piem-dispatch: Getting started
piem-elfeed-mode: Enabling integration libraries
piem-eww-mode: Enabling integration libraries
piem-gnus-mode: Enabling integration libraries
piem-inject-thread-into-maildir: Injecting messages into a Maildir directory
piem-mid: Using b4 to apply patches
piem-mid-to-thread-functions: Using b4 to apply patches
piem-name-branch-who-what-v: Applying patches contained in a message
piem-notmuch-known-mid-p: Injecting messages into a Maildir directory
piem-notmuch-mode: Enabling integration libraries

Jump to:   P  

Previous: , Up: Top   [Contents][Index]

Concept Index

Jump to:   A   B   C   G   I   L   M   P  
Index Entry  Section

A
am-ready mbox: Applying patches
applying patches: Applying patches

B
b4: Using b4 to apply patches

C
coderepo: Registering inboxes

G
git-am: Applying patches

I
inbox: Registering inboxes

L
lore: public-inbox
lore: Using b4 to apply patches

M
magit: Applying patches contained in a message
Maildir: Injecting messages into a Maildir directory
mailscripts: Applying patches without a public-inbox archive

P
public-inbox: public-inbox
pull methods: public-inbox

Jump to:   A   B   C   G   I   L   M   P  

Footnotes

(1)

… and in this author’s opinion, doing so is a bad practice anyway.