Skip to content
Browse files

Cleanup and convert to Markdown

  • Loading branch information...
1 parent 716d4a9 commit 6a5224bf898eb5e33fcccb506c44bc16515d056d @RaimoNiskanen RaimoNiskanen committed Feb 18, 2010
Showing with 7,409 additions and 6,766 deletions.
  1. +210 −210 eeps/eep-0001.md
  2. +225 −225 eeps/eep-0002.md
  3. +626 −626 eeps/eep-0003.md
  4. +21 −11 eeps/eep-0004.md
  5. +43 −26 eeps/eep-0005.md
  6. +49 −30 eeps/eep-0006.md
  7. +251 −223 eeps/eep-0007.md
  8. +19 −14 eeps/eep-0008.md
  9. +24 −16 eeps/eep-0009.md
  10. +22 −20 eeps/eep-0010.md
  11. +609 −293 eeps/eep-0011.md
  12. +22 −14 eeps/eep-0012.md
  13. +282 −248 eeps/eep-0013.md
  14. +172 −168 eeps/eep-0014.md
  15. +240 −237 eeps/eep-0015.md
  16. +170 −160 eeps/eep-0016.md
  17. +162 −159 eeps/eep-0017.md
  18. +941 −897 eeps/eep-0018.md
  19. +222 −214 eeps/eep-0019.md
  20. +222 −220 eeps/eep-0020.md
  21. +126 −121 eeps/eep-0021.md
  22. +199 −196 eeps/eep-0022.md
  23. +84 −78 eeps/eep-0023.md
  24. +105 −101 eeps/eep-0024.md
  25. +136 −131 eeps/eep-0025.md
  26. +243 −236 eeps/eep-0026.md
  27. +79 −65 eeps/eep-0027.md
  28. +216 −207 eeps/eep-0028.md
  29. +700 −667 eeps/eep-0029.md
  30. +135 −129 eeps/eep-0030.md
  31. +350 −328 eeps/eep-0031.md
  32. +504 −496 eeps/eep-0032.md
View
420 eeps/eep-0001.md
@@ -1,25 +1,26 @@
-EEP: 1
-Title: EEP Purpose and Guidelines
-Version: $Revision$
-Last-Modified: $Date$
-Author: Per Gustafsson [pergu(at)it(dot)uu(dot)se]
-Status: Draft
-Type: Process
-Content-Type: text/x-rst
-Created: 29-Jan-2007
-Post-History: 29-Jan-2007
-
-
-What is a EEP?
-==============
-
-EEP stands for Erlang Enhancement Proposal. It is a concept borrowed
-from the Python language [1]_ to facilitate community involvement in
-developing Erlang. This document is heavily based on PEP 1 [2]_. An EEP is
-a design document providing information to the Erlang community, or
-describing a new feature for Erlang or its processes or environment.
-The EEP should provide a concise technical specification of the
-feature and a rationale for the feature.
+ Author: Per Gustafsson <pergu(at)it(dot)uu(dot)se>,
+ Raimo Niskanen <raimo(at)erlang(dot)org>
+ Status: Draft
+ Type: Process
+ Created: 29-Jan-2007
+ Post-History: 29-Jan-2007
+****
+EEP 1: EEP Purpose and Guidelines
+----
+
+
+
+What is an EEP?
+===============
+
+EEP stands for Erlang Extension Proposal, or Erlang Enhancement
+Process. It is a concept borrowed from the [Python][] language to
+facilitate community involvement in developing Erlang. This document
+is heavily based on [PEP 1][]. An EEP is a design document providing
+information to the Erlang community, or describing a new feature for
+Erlang or its processes or environment. The EEP should provide a
+concise technical specification of the feature and a rationale for the
+feature.
We intend EEPs to be the primary mechanisms for proposing new
features, for collecting community input on an issue, and for
@@ -28,27 +29,29 @@ author is responsible for building consensus within the community and
documenting dissenting opinions.
Because the EEPs are maintained as text files in a versioned
-repository, their revision history is the historical record of the
-feature proposal [3]_.
+repository, their [revision history][VCS] is the historical record of
+the feature proposal.
+
EEP Types
=========
There are two kinds of EEPs:
-1. A **Standards Track** EEP describes a new feature or implementation
- for Erlang.
+1. A **Standards Track** EEP describes a new feature or implementation
+ for Erlang.
+
+2. A **Process** EEP describes a process surrounding Erlang, or
+ proposes a change to (or an event in) a process. Process EEPs are
+ like Standards Track EEPs but apply to areas other than the Erlang
+ language itself. They may propose an implementation, but not to
+ Erlang's codebase; they often require community consensus; they are
+ more than recommendations, and users are typically not free to ignore
+ them. Examples include release schedules, procedures, guidelines,
+ changes to the decision-making process, and changes to the tools or
+ environment used in Erlang development.
-2. A **Process** EEP describes a process surrounding Erlang, or
- proposes a change to (or an event in) a process. Process EEPs are
- like Standards Track EEPs but apply to areas other than the Erlang
- language itself. They may propose an implementation, but not to
- Erlang's codebase; they often require community consensus; they are
- more than recommendations, and users are typically not free to ignore
- them. Examples include release schedules, procedures, guidelines,
- changes to the decision-making process, and changes to the tools or
- environment used in Erlang development.
EEP Work Flow
@@ -59,8 +62,8 @@ send all EEP-related email to <eeps@erlang.org>.
The EEP process begins with a new idea for Erlang. It is highly
recommended that a single EEP contain a single key proposal or new
-idea. The more focused the EEP, the more successful it tends to
-be. The EEP editor reserves the right to reject EEP proposals if they
+idea. The more focused the EEP, the more successful it tends to
+be. The EEP editor reserves the right to reject EEP proposals if they
appear too unfocused or too broad. If in doubt, split your EEP into
several well-focused ones.
@@ -69,40 +72,40 @@ style and format described below, shepherds the discussions in the
appropriate forums, and attempts to build community consensus around
the idea. The EEP champion (a.k.a. Author) should first attempt to
ascertain whether the idea is EEP-able. Posting to the
-erlang-questions@erlang.org mailing list is recommended. Small
+<erlang-questions@erlang.org> mailing list is recommended. Small
enhancements or patches often don't need a EEP and can be injected
into the Erlang development work flow by sending a patch to
-erlang-patches@erlang.org.
-
-The EEP champion writes a rough but fleshed out draft of the EEP,
-with a proposed title. This draft must be written in EEP style
-as described below. Then, after subscribing to the email list
-<eeps@erlang.org>, the EEP champion sends the EEP to that list.
-Note that the list has a size limit for posts,
-at the time of writing 128 KByte, so EEPs with attachments
-that are too large will bounce. Large attachments can be put
-on a suitable web page and then be referred to from the EEP.
-If that is not possible, ask on the list how to
-submit the large EEP in question.
-
-If the EEP editor approves, he will assign the EEP a number, label it
-as Standards Track or Process, give it status "Draft",
-and create and check-in the initial draft of the EEP. The EEP editor
-will not unreasonably deny a EEP. Reasons for denying EEP status
-include duplication of effort, being technically unsound, not
-providing proper motivation or addressing backwards compatibility, or
-not in keeping with the Erlang philosophy.
+<erlang-patches@erlang.org>.
+
+The EEP champion writes a rough but fleshed out draft of the EEP, with
+a proposed title. This draft must be written in EEP style as described
+below. Then, after subscribing to the email list <eeps@erlang.org>,
+the EEP champion sends the EEP to that list. Note that the list has a
+size limit for posts, at the time of writing 128 KByte, so EEPs with
+attachments that are too large will bounce. Large attachments can be
+put on a suitable web page and then be referred to from the EEP. If
+that is not possible, ask on the list how to submit the large EEP in
+question.
+
+If the EEP editor approves, she/he will assign the EEP a number, label
+it as Standards Track or Process, give it status "Draft", and create
+and check-in the initial draft of the EEP. The EEP editor will not
+unreasonably deny a EEP. Reasons for denying EEP status include
+duplication of effort, being technically unsound, not providing proper
+motivation or addressing backwards compatibility, or not in keeping
+with the Erlang philosophy.
If a pre-EEP is rejected, the author may elect to take the pre-EEP to
-the erlang-questions@erlang.org mailing list to help flesh it out,
+the <erlang-questions@erlang.org> mailing list to help flesh it out,
gain feedback and consensus from the community at large, and improve
the EEP for re-submission.
The author of the EEP is then responsible for posting the EEP to the
community forums, and marshaling community support for it. As updates
are necessary, the EEP author can check in new versions if they have
-SVN commit permissions, or can email new EEP versions to the EEP
-editor for committing.
+commit permissions, can email new EEP versions or diffs to the EEP
+editor for committing, or submit changes in any other suitable
+way for the version control system.
Standards Track EEPs consist of two parts, a design document and a
reference implementation. The EEP should be reviewed and accepted
@@ -113,157 +116,155 @@ or a URL to same -- before it can be considered Final.
EEP authors are responsible for collecting community feedback on a EEP
before submitting it for review. A EEP that has not been discussed on
-the erlang mailing list will not be
-accepted. However, wherever possible, long open-ended discussions on
-public mailing lists should be avoided. Strategies to keep the
-discussions efficient include: setting up a separate SIG mailing list
-for the topic, having the EEP author accept private comments in the
-early design phases, setting up a wiki page, etc. EEP authors should
-use their discretion here.
+the erlang mailing list will not be accepted. However, wherever
+possible, long open-ended discussions on public mailing lists should
+be avoided. Strategies to keep the discussions efficient include:
+setting up a separate SIG mailing list for the topic, having the EEP
+author accept private comments in the early design phases, setting up
+a wiki page, etc. EEP authors should use their discretion here.
Once the authors have completed a EEP, they must inform the EEP editor
-that it is ready for review. EEPs are reviewed by a committee of
+that it is ready for review. EEPs are reviewed by a committee of
people from the Erlang/OTP and the Erlang community who may accept or
reject a EEP or send it back to the author(s) for revision. For a EEP
that is pre-determined to be acceptable (e.g., it is an obvious win
as-is and/or its implementation has already been checked in) the
Erlang/OTP team may also initiate a EEP review, first notifying the
EEP author(s) and giving them a chance to make revisions.
-The members of the committee are listed in the EEP index.
+The committee members are the internal Erlang/OTP Technical Board plus
+for the specific case summoned experts.
-For a EEP to be accepted it must meet certain minimum criteria. It
+For a EEP to be accepted it must meet certain minimum criteria. It
must be a clear and complete description of the proposed enhancement.
-The enhancement must represent a net improvement. The proposed
+The enhancement must represent a net improvement. The proposed
implementation, if applicable, must be solid and must not complicate
-the interpreter unduly. Finally, a proposed enhancement must be
+the interpreter unduly. Finally, a proposed enhancement must be
compatible with the Erlang philosophy in order to be accepted.
Once a EEP has been accepted, the reference implementation must be
-completed. When the reference implementation is complete and
-accepted, the status will be changed to "Final".
+completed. When the reference implementation is complete and accepted,
+the status will be changed to "Final".
-A EEP can also be assigned status "Deferred". The EEP author or
-editor can assign the EEP this status when no progress is being made
-on the EEP. Once a EEP is deferred, the EEP editor can re-assign it
-to draft status.
+A EEP can also be assigned status "Deferred". The EEP author or editor
+can assign the EEP this status when no progress is being made on the
+EEP. Once a EEP is deferred, the EEP editor can re-assign it to draft
+status.
-A EEP can also be "Rejected". Perhaps after all is said and done it
-was not a good idea. It is still important to have a record of this
+A EEP can also be "Rejected". Perhaps after all is said and done it
+was not a good idea. It is still important to have a record of this
fact.
EEPs can also be replaced by a different EEP, rendering the original
-obsolete.
+obsolete.
EEP work flow is as follows:
-.. image:: eep-0001-1.png
+![EEP Work Flow][]
Some Process EEPs may also have a status of "Active"
-if they are never meant to be completed. E.g. EEP 1 (this EEP).
+if they are never meant to be completed. E.g. [EEP 1][] (this EEP).
+
What belongs in a successful EEP?
=================================
Each EEP should have the following parts:
-1. Preamble -- RFC 822 style headers containing meta-data about the
- EEP, including the EEP number, a short descriptive title (limited
- to a maximum of 44 characters), the names, and optionally the
- contact info for each author, etc.
+1. Preamble -- RFC 822 style headers containing meta-data about the
+ EEP, including the EEP number, a short descriptive title (limited
+ to a maximum of 44 characters), the names, and optionally the
+ contact info for each author, etc.
-2. Abstract -- a short (~200 word) description of the technical issue
- being addressed.
+2. Abstract -- a short (~200 word) description of the technical issue
+ being addressed.
-3. Copyright/public domain -- Each EEP must either be explicitly
- labelled as placed in the public domain (see this EEP as an
- example) or licensed under the `Open Publication License`_,
- or the `Creative Commons Attribution 3.0 License`_.
+3. Copyright/public domain -- Each EEP must either be explicitly
+ labelled as placed in the public domain (see this EEP as an
+ example) or licensed under the [Open Publication License][OPL], or
+ the [Creative Commons Attribution 3.0 License][CCA3.0].
-4. Specification -- The technical specification should describe the
- syntax and semantics of any new language feature. The
- specification should be detailed enough to allow competing,
- interoperable implementations.
+4. Specification -- The technical specification should describe the
+ syntax and semantics of any new language feature. The
+ specification should be detailed enough to allow competing,
+ interoperable implementations.
-5. Motivation -- The motivation is critical for EEPs that want to
- change the Erlang language. It should clearly explain why the
- existing language specification is inadequate to address the
- problem that the EEP solves. EEP submissions without sufficient
- motivation may be rejected outright.
+5. Motivation -- The motivation is critical for EEPs that want to
+ change the Erlang language. It should clearly explain why the
+ existing language specification is inadequate to address the
+ problem that the EEP solves. EEP submissions without sufficient
+ motivation may be rejected outright.
-6. Rationale -- The rationale fleshes out the specification by
- describing what motivated the design and why particular design
- decisions were made. It should describe alternate designs that
- were considered and related work, e.g. how the feature is supported
- in other languages.
+6. Rationale -- The rationale fleshes out the specification by
+ describing what motivated the design and why particular design
+ decisions were made. It should describe alternate designs that
+ were considered and related work, e.g. how the feature is
+ supported in other languages.
- The rationale should provide evidence of consensus within the
- community and discuss important objections or concerns raised
- during discussion.
+ The rationale should provide evidence of consensus within the
+ community and discuss important objections or concerns raised
+ during discussion.
-7. Backwards Compatibility -- All EEPs that introduce backwards
- incompatibilities must include a section describing these
- incompatibilities and their severity. The EEP must explain how the
- author proposes to deal with these incompatibilities. EEP
- submissions without a sufficient backwards compatibility treatise
- may be rejected outright.
+7. Backwards Compatibility -- All EEPs that introduce backwards
+ incompatibilities must include a section describing these
+ incompatibilities and their severity. The EEP must explain how
+ the author proposes to deal with these incompatibilities. EEP
+ submissions without a sufficient backwards compatibility treatise
+ may be rejected outright.
-8. Reference Implementation -- The reference implementation must be
- completed before any EEP is given status "Final", but it need not
- be completed before the EEP is accepted. It is better to finish
- the specification and rationale first and reach consensus on it
- before writing code.
+8. Reference Implementation -- The reference implementation must be
+ completed before any EEP is given status "Final", but it need not
+ be completed before the EEP is accepted. It is better to finish
+ the specification and rationale first and reach consensus on it
+ before writing code.
- The final implementation must include test code and documentation
- appropriate for either the Erlang language reference or the
- standard library reference.
+ The final implementation must include test code and documentation
+ appropriate for either the Erlang language reference or the
+ standard library reference.
-EEP Formats and Templates
-=========================
-There are two EEP formats available to authors: plaintext and
-reStructuredText_. Both are UTF-8-encoded text files.
+EEP Format and Template
+=======================
-Plaintext EEPs are written with minimal structural markup that adheres
-to a rigid style. EEP 2 contains a instructions and a template [4]_
-you can use to get started writing your plaintext EEP.
+An EEP is written as an UTF-8-encoded text file in [Markdown][] format.
+[EEP 33][] is a template and contains an instruction of how to write
+an EEP.
-ReStructuredText_ EEPs allow for rich markup that is still quite easy
-to read, but results in much better-looking and more functional HTML.
-EEP 3 contains instructions and a template [5]_ for reStructuredText
-EEPs.
+In the [repository][VCS] there is also a version of the [Markdown][]
+Perl program, a Makefile and a Perl script for building the [EEP index][EEP].
+Just give the command `make` in the toplevel directory.
-There is a Python script that converts both styles of EEPs to HTML for
-viewing on the web [6]_. Parsing and conversion of plaintext EEPs is
-self-contained within the script. reStructuredText EEPs are parsed
-and converted by Docutils_ code called from the script.
EEP Header Preamble
===================
-Each EEP must begin with an RFC 822 style header preamble. The headers
-must appear in the following order. Headers marked with "*" are
-optional and are described below. All other headers are required. ::
-
- EEP: <eep number>
- Title: <eep title>
- Version: <svn version string>
- Last-Modified: <svn date string>
- Author: <list of authors' real names and optionally, email addrs>
- * Discussions-To: <email address>
- Status: <Draft | Active | Accepted | Deferred | Rejected |
- Final | Replaced>
- Type: <Standards Track | Process>
- * Content-Type: <text/plain | text/x-rst>
- * Requires: <eep numbers>
- Created: <date created on, in dd-mmm-yyyy format>
- * Erlang-Version: <version number>
- Post-History: <dates of postings to erlang-questions>
- * Replaces: <eep number>
- * Replaced-By: <eep number>
+Each EEP must begin with an RFC 822 style header preamble all indented
+four spaces to make them [Markdown][] code style. The headers must
+appear in the following order. Headers marked with "*" are optional
+and are described below. All other headers are required:
+
+ Author: <list of authors' real names and optionally, email addrs>
+ * Discussions-To: <email address>
+ Status: <Draft | Active | Accepted | Deferred | Rejected |
+ Final | Replaced>
+ Type: <Standards Track | Process>
+ * Content-Type: <text/plain | text/x-rst>
+ * Requires: <eep numbers>
+ Created: <date created on, in dd-mmm-yyyy format>
+ * Erlang-Version: <version number>
+ Post-History: <dates of postings to erlang-questions>
+ * Replaces: <eep number, ...>
+ * Replaced-By: <eep number, ...>
+
+Then follows a Markdown horizontal rule, the EEP number and title
+as a Markdown header 2, and a blank line, all required:
+ ****
+ EEP <eep number>: <eep title>
+ ----
+
The Author header lists the names, and optionally the email addresses
of all the authors/owners of the EEP. The format of the Author header
@@ -279,68 +280,65 @@ if the address is not given.
If there are multiple authors, each should be on a separate line
following RFC 2822 continuation line conventions. Note that personal
-email addresses in EEPs will be obscured as a defense against spam
+email addresses should be obscured as a defense against spam
harvesters.
While a EEP is in private discussions (usually during the initial
Draft phase), a Discussions-To header will indicate the mailing list
or URL where the EEP is being discussed. No Discussions-To header is
necessary if the EEP is being discussed privately with the author, or
-on the erlang mailing list. Note that email
-addresses in the Discussions-To header will not be obscured.
+on the erlang mailing list. Remember to obscure email addresses here
+to.
The Type header specifies the type of EEP: Standards Track or Process.
-The format of a EEP is specified with a Content-Type header. The
-acceptable values are "text/plain" for plaintext EEPs (see EEP 2 [3]_)
-and "text/x-rst" for reStructuredText EEPs (see EEP 3 [4]_).
-Plaintext ("text/plain") is the default if no Content-Type header is
-present.
-
The Created header records the date that the EEP was assigned a
number, while Post-History is used to record the dates of when new
-versions of the EEP are posted to erlang-questions. Both
-headers should be in dd-mmm-yyyy format, e.g. 14-Aug-2006.
+versions of the EEP are posted to erlang-questions. Both headers
+should be in dd-mmm-yyyy format, e.g. 14-Aug-2009.
Standards Track EEPs must have a Erlang-Version header which indicates
-the version of Erlang that the feature will be released with.
-Process EEPs do not need a Erlang-Version header.
+the version of Erlang that the feature will be released with. Process
+EEPs do not need a Erlang-Version header.
EEPs may have a Requires header, indicating the EEP numbers that this
-EEP depends on.
+EEP depends on..
EEPs may also have a Replaced-By header indicating that a EEP has been
-rendered obsolete by a later document; the value is the number of the
-EEP that replaces the current document. The newer EEP must have a
-Replaces header containing the number of the EEP that it rendered
-obsolete.
+rendered obsolete by later EEP(s); the value is the number(s) of the
+EEP(s) that replaces the current document. The newer EEP(s) must have
+a Replaces header containing the number(s) of the EEP(s) that it
+rendered obsolete.
+
Auxiliary Files
===============
EEPs may include auxiliary files such as diagrams. Such files must be
-named ``eep-XXXX-Y.ext``, where "XXXX" is the EEP number, "Y" is a
-serial number (starting at 1), and "ext" is replaced by the actual
-file extension (e.g. "png").
+named `eep-XXXX-Y.ext`, where "XXXX" is the EEP number, "Y" is a
+serial number (starting at 1), and ".ext" is replaced by the actual
+file extension (e.g. ".png").
+
Reporting EEP Bugs, or Submitting EEP Updates
=============================================
How you report a bug, or submit a EEP update depends on several
factors, such as the maturity of the EEP, the preferences of the EEP
-author, and the nature of your comments. For the early draft stages
+author, and the nature of your comments. For the early draft stages
of the EEP, it's probably best to send your comments and changes
-directly to the EEP author. For more mature, or finished EEPs you may
-want to submit corrections to the erlang-patches mailing list.
+directly to the EEP author. For more mature, or finished EEPs you may
+want to submit corrections to the <eeps@erlang.org> mailing list.
When in doubt about where to send your changes, please check first
with the EEP author and/or EEP editor.
EEP authors can update EEPs by submitting new versions to the editors.
+
Transferring EEP Ownership
==========================
@@ -362,34 +360,36 @@ email in a timely manner, the EEP editor will make a unilateral
decision (it's not like such decisions can't be reversed :).
-References and Footnotes
-========================
-.. [1] We are very grateful to the Python community for devising such
- a good process for language revisions and for placing their documents
- in the public domain.
+[Python]: http://www.python.org
+ "We are very grateful to the Python community for devising such a good process for language revisions and for placing their documents in the public domain"
-.. [2] PEP 1, PEP Purpose and Guidelines, Goodger, Hylton, Warsaw
- (http://www.python.org/dev/peps/pep-0001/)
+[PEP 1]: http://www.python.org/dev/peps/pep-0001/
+ "PEP 1, PEP Purpose and Guidelines, Goodger, Hylton, Warsaw"
-.. [3] This svn server has not been setup yet but should be setup
+[VCS]: http://www.github.com/erlang/eep/
+ "EEP Sources at Github"
-.. [4] EEP 2, Sample Plaintext EEP Template, Gustafsson
- (http://www.erlang.org/eeps/eep-0002.html)
+[EEP]: ./
+ "EEP Index"
-.. [5] EEP 3, Sample reStructuredText EEP Template, Gustafsson
- (http://www.erlang.org/eeps/eep-0003.html)
+[EEP 1]: eep-0001.md
+ "EEP 1, EEP Purpose and Guidelines, Gustafsson"
-.. [6] The script referred to here is eep2html.py.
+[EEP 33]: eep-0033.md
+ "EEP 33, Sample Markdown EEP Template, Niskanen"
-.. _Open Publication License: http://www.opencontent.org/openpub/
+[Markdown]: http://daringfireball.net/projects/markdown/
+ "Markdown Home Page"
-.. _Creative Commons Attribution 3.0 License:
- http://creativecommons.org/licenses/by/3.0/
+[OPL]: http://www.opencontent.org/openpub/
+ "Open Publication License"
-.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+[CCA3.0]: http://creativecommons.org/licenses/by/3.0/
+ "Creative Commons Attribution 3.0 License"
-.. _Docutils: http://docutils.sourceforge.net/
+[EEP Work Flow]: eep-0001-1.png
+ "EEP Work Flow"
Copyright
@@ -398,11 +398,11 @@ Copyright
This document has been placed in the public domain.
-..
- Local Variables:
- mode: indented-text
- indent-tabs-mode: nil
- sentence-end-double-space: t
- fill-column: 70
- coding: utf-8
- End:
+
+[EmacsVar]: <> "Local Variables:"
+[EmacsVar]: <> "mode: indented-text"
+[EmacsVar]: <> "indent-tabs-mode: nil"
+[EmacsVar]: <> "sentence-end-double-space: t"
+[EmacsVar]: <> "fill-column: 70"
+[EmacsVar]: <> "coding: utf-8"
+[EmacsVar]: <> "End:"
View
450 eeps/eep-0002.md
@@ -1,226 +1,226 @@
-EEP: 2
-Title: Sample Plaintext PEP Template
-Version: $Revision$
-Last-Modified: $Date$
-Author: Per Gustafsson [pergu(at)it(dot)uu(dot)se]
-Status: Active
-Type: Process
-Content-Type: text/plain
-Created: 14-Aug-2001
-Post-History:
-
-
-Abstract
-
- This EEP provides a boilerplate or sample template for creating
- your own plaintext EEPs. In conjunction
- with the content guidelines in EEP 1 [1], this should make it easy
- for you to conform your own EEPs to the format outlined below.
-
- Note: if you are reading this EEP via the web, you should first
- grab the plaintext source of this EEP in order to complete the
- steps below. DO NOT USE THE HTML FILE AS YOUR TEMPLATE!
-
- If you would prefer to use lightweight markup in your EEP, please
- see EEP 3, "Sample reStructuredText EEP Template" [2].
-
- This document is based on PEP 9 [3].
-
-
-Rationale
-
- EEP submissions come in a wide variety of forms, not all adhering
- to the format guidelines set forth below. Use this template, in
- conjunction with the content guidelines in EEP 1, to ensure that
- your EEP submission won't get automatically rejected because of
- form.
-
-
-How to Use This Template
-
- To use this template you must first decide whether your EEP is
- going to be an Informational or Standards Track EEP. Most EEPs
- are Standards Track because they propose a new feature for the
- Erlang language or standard library. When in doubt, read EEP 1
- for details or contact the EEP editors <eeps@erlang.org>.
-
- Once you've decided which type of EEP yours is going to be, follow
- the directions below.
-
- - Make a copy of this file (.txt file, not HTML!) and perform the
- following edits.
-
- - Replace the "EEP: 2" header with "EEP: XXX" since you don't yet
- have an EEP number assignment.
-
- - Change the Title header to the title of your EEP.
-
- - Leave the Version and Last-Modified headers alone; we'll take
- care of those when we check your EEP into the Subversion
- repository. These headers consist of keywords ("Revision" and
- "Date" enclosed in "$"-signs) which are automatically expanded
- by the repository. Please do not edit the expanded date or
- revision text.
-
- - Change the Author header to include your name, and optionally
- your email address. Be sure to follow the format carefully:
- your name must appear first, and it must not be contained in
- parentheses. Your email address may appear second (or it can be
- omitted) and if it appears, it must appear in angle brackets.
- It is okay to obfuscate your email address.
-
- - If there is a mailing list for discussion of your new feature,
- add a Discussions-To header right after the Author header. You
- should not add a Discussions-To header if the mailing list to be
- used is erlang-questions@erlang.org, or if discussions should be
- sent to you directly. Most Informational EEPs don't have a
- Discussions-To header.
-
- - Change the Status header to "Draft".
-
- - For Standards Track EEPs, change the Type header to "Standards
- Track".
-
- - For Informational EEPs, change the Type header to
- "Informational".
-
- - For Standards Track EEPs, if your feature depends on the
- acceptance of some other currently in-development EEP, add a
- Requires header right after the Type header. The value should
- be the EEP number of the EEP yours depends on. Don't add this
- header if your dependent feature is described in a Final EEP.
-
- - Change the Created header to today's date. Be sure to follow
- the format carefully: it must be in dd-mmm-yyyy format, where
- the mmm is the 3 English letter month abbreviation, e.g. one of
- Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
-
- - For Standards Track EEPs, after the Created header, add a
- Erlang-Version header and set the value to the next planned
- version of Erlang, i.e. the one your new feature will hopefully
- make its first appearance in. Thus, if the last version of
- Erlang/OTP was R11B-3 and you're hoping to get your new feature
- into R11B-4 set the version header to:
-
- Erlang-Version: R11B-4
-
- - Leave Post-History alone for now; you'll add dates to this
- header each time you post your EEP to
- erlang-questions@erlang.org. E.g. if you posted your EEP to the
- list on August 14, 2006 and September 3, 2006, the Post-History
- header would look like:
-
- Post-History: 14-Aug-2006, 03-Sept-2006
-
- You must manually add new dates and check them in. If you don't
- have check-in privileges, send your changes to the EEP editor.
-
- - Add a Replaces header if your EEP obsoletes an earlier EEP. The
- value of this header is the number of the EEP that your new EEP
- is replacing. Only add this header if the older EEP is in
- "final" form, i.e. is either Accepted, Final, or Rejected. You
- aren't replacing an older open EEP if you're submitting a
- competing idea.
-
- - Now write your Abstract, Rationale, and other content for your
- EEP, replacing all this gobbledygook with your own text. Be sure
- to adhere to the format guidelines below, specifically on the
- prohibition of tab characters and the indentation requirements.
-
- - Update your References and Copyright section. Usually you'll
- place your EEP into the public domain, in which case just leave
- the "Copyright" section alone. Alternatively, you can use the
- Open Publication License[4], but public domain is still strongly
- preferred.
-
- - Leave the little Emacs turd at the end of this file alone,
- including the formfeed character ("^L", or \f).
-
- - Send your EEP submission to the EEP editors (eeps@erlang.org),
- (Funny Joke removed :)
-
-
-Plaintext EEP Formatting Requirements
-
- EEP headings must begin in column zero and the initial letter of
- each word must be capitalized as in book titles. Acronyms should
- be in all capitals. The body of each section must be indented 4
- spaces. Code samples inside body sections should be indented a
- further 4 spaces, and other indentation can be used as required to
- make the text readable. You must use two blank lines between the
- last line of a section's body and the next section heading.
-
- You must adhere to the Emacs convention of adding two spaces at
- the end of every sentence. You should fill your paragraphs to
- column 70, but under no circumstances should your lines extend
- past column 79. If your code samples spill over column 79, you
- should rewrite them.
-
- Tab characters must never appear in the document at all. An EEP
- should include the standard Emacs stanza included by example at
- the bottom of this EEP.
-
- When referencing an external web page in the body of an EEP, you
- should include the title of the page in the text, with a
- footnote reference to the URL. Do not include the URL in the body
- text of the EEP. E.g.
-
- Refer to the Erlang Language web site [1] for more details.
- ...
- [1] http://www.erlang.org
-
- When referring to another EEP, include the EEP number in the body
- text, such as "EEP 1". The title may optionally appear. Add a
- footnote reference, a number in square brackets. The footnote
- body should include the EEP's title and author. It may optionally
- include the explicit URL on a separate line, but only in the
- References section. Note that the eep2html.py script will
- calculate URLs automatically. For example:
-
- ...
- Refer to EEP 1 [7] for more information about EEP style
+ EEP: 2
+ Title: Sample Plaintext PEP Template
+ Version: $Revision$
+ Last-Modified: $Date$
+ Author: Per Gustafsson <pergu(at)it(dot)uu(dot)se>
+ Status: Active
+ Type: Process
+ Content-Type: text/plain
+ Created: 14-Aug-2001
+ Post-History:
+
+
+ Abstract
+
+ This EEP provides a boilerplate or sample template for creating
+ your own plaintext EEPs. In conjunction
+ with the content guidelines in EEP 1 [1], this should make it easy
+ for you to conform your own EEPs to the format outlined below.
+
+ Note: if you are reading this EEP via the web, you should first
+ grab the plaintext source of this EEP in order to complete the
+ steps below. DO NOT USE THE HTML FILE AS YOUR TEMPLATE!
+
+ If you would prefer to use lightweight markup in your EEP, please
+ see EEP 3, "Sample reStructuredText EEP Template" [2].
+
+ This document is based on PEP 9 [3].
+
+
+ Rationale
+
+ EEP submissions come in a wide variety of forms, not all adhering
+ to the format guidelines set forth below. Use this template, in
+ conjunction with the content guidelines in EEP 1, to ensure that
+ your EEP submission won't get automatically rejected because of
+ form.
+
+
+ How to Use This Template
+
+ To use this template you must first decide whether your EEP is
+ going to be an Informational or Standards Track EEP. Most EEPs
+ are Standards Track because they propose a new feature for the
+ Erlang language or standard library. When in doubt, read EEP 1
+ for details or contact the EEP editors <eeps@erlang.org>.
+
+ Once you've decided which type of EEP yours is going to be, follow
+ the directions below.
+
+ - Make a copy of this file (.txt file, not HTML!) and perform the
+ following edits.
+
+ - Replace the "EEP: 2" header with "EEP: XXX" since you don't yet
+ have an EEP number assignment.
+
+ - Change the Title header to the title of your EEP.
+
+ - Leave the Version and Last-Modified headers alone; we'll take
+ care of those when we check your EEP into the Subversion
+ repository. These headers consist of keywords ("Revision" and
+ "Date" enclosed in "$"-signs) which are automatically expanded
+ by the repository. Please do not edit the expanded date or
+ revision text.
+
+ - Change the Author header to include your name, and optionally
+ your email address. Be sure to follow the format carefully:
+ your name must appear first, and it must not be contained in
+ parentheses. Your email address may appear second (or it can be
+ omitted) and if it appears, it must appear in angle brackets.
+ It is okay to obfuscate your email address.
+
+ - If there is a mailing list for discussion of your new feature,
+ add a Discussions-To header right after the Author header. You
+ should not add a Discussions-To header if the mailing list to be
+ used is erlang-questions@erlang.org, or if discussions should be
+ sent to you directly. Most Informational EEPs don't have a
+ Discussions-To header.
+
+ - Change the Status header to "Draft".
+
+ - For Standards Track EEPs, change the Type header to "Standards
+ Track".
+
+ - For Informational EEPs, change the Type header to
+ "Informational".
+
+ - For Standards Track EEPs, if your feature depends on the
+ acceptance of some other currently in-development EEP, add a
+ Requires header right after the Type header. The value should
+ be the EEP number of the EEP yours depends on. Don't add this
+ header if your dependent feature is described in a Final EEP.
+
+ - Change the Created header to today's date. Be sure to follow
+ the format carefully: it must be in dd-mmm-yyyy format, where
+ the mmm is the 3 English letter month abbreviation, e.g. one of
+ Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
+
+ - For Standards Track EEPs, after the Created header, add a
+ Erlang-Version header and set the value to the next planned
+ version of Erlang, i.e. the one your new feature will hopefully
+ make its first appearance in. Thus, if the last version of
+ Erlang/OTP was R11B-3 and you're hoping to get your new feature
+ into R11B-4 set the version header to:
+
+ Erlang-Version: R11B-4
+
+ - Leave Post-History alone for now; you'll add dates to this
+ header each time you post your EEP to
+ erlang-questions@erlang.org. E.g. if you posted your EEP to the
+ list on August 14, 2006 and September 3, 2006, the Post-History
+ header would look like:
+
+ Post-History: 14-Aug-2006, 03-Sept-2006
+
+ You must manually add new dates and check them in. If you don't
+ have check-in privileges, send your changes to the EEP editor.
+
+ - Add a Replaces header if your EEP obsoletes an earlier EEP. The
+ value of this header is the number of the EEP that your new EEP
+ is replacing. Only add this header if the older EEP is in
+ "final" form, i.e. is either Accepted, Final, or Rejected. You
+ aren't replacing an older open EEP if you're submitting a
+ competing idea.
+
+ - Now write your Abstract, Rationale, and other content for your
+ EEP, replacing all this gobbledygook with your own text. Be sure
+ to adhere to the format guidelines below, specifically on the
+ prohibition of tab characters and the indentation requirements.
+
+ - Update your References and Copyright section. Usually you'll
+ place your EEP into the public domain, in which case just leave
+ the "Copyright" section alone. Alternatively, you can use the
+ Open Publication License[4], but public domain is still strongly
+ preferred.
+
+ - Leave the little Emacs turd at the end of this file alone,
+ including the formfeed character ("^L", or \f).
+
+ - Send your EEP submission to the EEP editors (eeps@erlang.org),
+ (Funny Joke removed :)
+
+
+ Plaintext EEP Formatting Requirements
+
+ EEP headings must begin in column zero and the initial letter of
+ each word must be capitalized as in book titles. Acronyms should
+ be in all capitals. The body of each section must be indented 4
+ spaces. Code samples inside body sections should be indented a
+ further 4 spaces, and other indentation can be used as required to
+ make the text readable. You must use two blank lines between the
+ last line of a section's body and the next section heading.
+
+ You must adhere to the Emacs convention of adding two spaces at
+ the end of every sentence. You should fill your paragraphs to
+ column 70, but under no circumstances should your lines extend
+ past column 79. If your code samples spill over column 79, you
+ should rewrite them.
+
+ Tab characters must never appear in the document at all. An EEP
+ should include the standard Emacs stanza included by example at
+ the bottom of this EEP.
+
+ When referencing an external web page in the body of an EEP, you
+ should include the title of the page in the text, with a
+ footnote reference to the URL. Do not include the URL in the body
+ text of the EEP. E.g.
+
+ Refer to the Erlang Language web site [1] for more details.
...
-
- References
-
- [7] EEP 1, EEP Purpose and Guidelines, Gustafsson
- http://www.erlang.org/eeps/eep-0001.html
-
- If you decide to provide an explicit URL for an EEP, please use
- this as the URL template:
-
- http://www.erlang.org/eeps/eep-xxxx.html
-
- EEP numbers in URLs must be padded with zeros from the left, so as
- to be exactly 4 characters wide, however EEP numbers in the text
- are never padded.
-
-
-References
-
- [1] EEP 1, EEP Purpose and Guidelines, Gustafsson
- http://www.erlang.org/eeps/eep-0001.html
-
- [2] EEP 3, Sample reStructuredText EEP Template, Gustafsson
- http://www.erlang.org/eeps/eep-0003.html
-
- [3] PEP 9, Sample Plaintext PEP Template, Warsaw
- http://www.python.org/dev/peps/pep-0009/
-
- [4] http://www.opencontent.org/openpub/
-
-
-
-Copyright
-
- This document has been placed in the public domain.
-
-
-
-Local Variables:
-mode: indented-text
-indent-tabs-mode: nil
-sentence-end-double-space: t
-fill-column: 70
-coding: utf-8
-End:
+ [1] http://www.erlang.org
+
+ When referring to another EEP, include the EEP number in the body
+ text, such as "EEP 1". The title may optionally appear. Add a
+ footnote reference, a number in square brackets. The footnote
+ body should include the EEP's title and author. It may optionally
+ include the explicit URL on a separate line, but only in the
+ References section. Note that the eep2html.py script will
+ calculate URLs automatically. For example:
+
+ ...
+ Refer to EEP 1 [7] for more information about EEP style
+ ...
+
+ References
+
+ [7] EEP 1, EEP Purpose and Guidelines, Gustafsson
+ http://www.erlang.org/eeps/eep-0001.html
+
+ If you decide to provide an explicit URL for an EEP, please use
+ this as the URL template:
+
+ http://www.erlang.org/eeps/eep-xxxx.html
+
+ EEP numbers in URLs must be padded with zeros from the left, so as
+ to be exactly 4 characters wide, however EEP numbers in the text
+ are never padded.
+
+
+ References
+
+ [1] EEP 1, EEP Purpose and Guidelines, Gustafsson
+ http://www.erlang.org/eeps/eep-0001.html
+
+ [2] EEP 3, Sample reStructuredText EEP Template, Gustafsson
+ http://www.erlang.org/eeps/eep-0003.html
+
+ [3] PEP 9, Sample Plaintext PEP Template, Warsaw
+ http://www.python.org/dev/peps/pep-0009/
+
+ [4] http://www.opencontent.org/openpub/
+
+
+
+ Copyright
+
+ This document has been placed in the public domain.
+
+
+
+ Local Variables:
+ mode: indented-text
+ indent-tabs-mode: nil
+ sentence-end-double-space: t
+ fill-column: 70
+ coding: utf-8
+ End:
View
1,252 eeps/eep-0003.md
@@ -1,629 +1,629 @@
-EEP: 3
-Title: Sample reStructuredText EEP Template
-Version: $Revision$
-Last-Modified: $Date$
-Author: Per Gustafsson [pergu(at)it(dot)uu(dot)se]
-Status: Active
-Type: Process
-Content-Type: text/x-rst
-Created: 05-Aug-2002
-Post-History: 30-Aug-2002
-
-
-Abstract
-========
-
-This EEP provides a boilerplate or sample template for creating your
-own reStructuredText EEPs. In conjunction with the content guidelines
-in EEP 1 [1]_, this should make it easy for you to conform your own
-EEPs to the format outlined below.
-
-Note: if you are reading this EEP via the web, you should first grab
-the text (reStructuredText) source of this EEP in order to complete
-the steps below. **DO NOT USE THE HTML FILE AS YOUR TEMPLATE!**
-
-If you would prefer not to use markup in your EEP, please see EEP 2,
-"Sample Plaintext EEP Template" [2]_.
-
-This EEP is a slightly revised version of PEP 12 [3]_.
-
-
-Rationale
-=========
-
-ReStructuredText is offered as an alternative to plaintext EEPs, to
-allow EEP authors more functionality and expressivity, while
-maintaining easy readability in the source text. The processed HTML
-form makes the functionality accessible to readers: live hyperlinks,
-styled text, tables, images, and automatic tables of contents, among
-other advantages.
-
-
-How to Use This Template
-========================
-
-To use this template you must first decide whether your EEP is going
-to be an Informational or Standards Track EEP. Most EEPs are
-Standards Track because they propose a new feature for the Erlang
-language or standard library. When in doubt, read EEP 1 for details
-or contact the EEP editors <eeps@erlang.org>.
-
-Once you've decided which type of EEP yours is going to be, follow the
-directions below.
-
-- Make a copy of this file (``.txt`` file, **not** HTML!) and perform
- the following edits.
-
-- Replace the "EEP: 3" header with "EEP: XXX" since you don't yet have
- a EEP number assignment.
-
-- Change the Title header to the title of your EEP.
-
-- Leave the Version and Last-Modified headers alone; we'll take care
- of those when we check your EEP into the Subversion repository.
- These headers consist of keywords ("Revision" and "Date" enclosed in
- "$"-signs) which are automatically expanded by the repository.
- Please do not edit the expanded date or revision text.
-
-- Change the Author header to include your name, and optionally your
- email address. Be sure to follow the format carefully: your name
- must appear first, and it must not be contained in parentheses.
- Your email address may appear second (or it can be omitted) and if
- it appears, it must appear in angle brackets. It is okay to
- obfuscate your email address.
-
-- If there is a mailing list for discussion of your new feature, add a
- Discussions-To header right after the Author header. You should not
- add a Discussions-To header if the mailing list to be used is either
- the erlang mailing list, or if discussions
- should be sent to you directly. Most Informational EEPs don't have
- a Discussions-To header.
-
-- Change the Status header to "Draft".
-
-- For Standards Track EEPs, change the Type header to "Standards
- Track".
-
-- For Informational EEPs, change the Type header to "Informational".
-
-- For Standards Track EEPs, if your feature depends on the acceptance
- of some other currently in-development EEP, add a Requires header
- right after the Type header. The value should be the EEP number of
- the EEP yours depends on. Don't add this header if your dependent
- feature is described in a Final EEP.
-
-- Change the Created header to today's date. Be sure to follow the
- format carefully: it must be in ``dd-mmm-yyyy`` format, where the
- ``mmm`` is the 3 English letter month abbreviation, i.e. one of Jan,
- Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
-
-- For Standards Track EEPs, after the Created header, add a
- Erlang-Version header and set the value to the next planned
- version of Erlang, i.e. the one your new feature will hopefully
- make its first appearance in. Thus, if the last version of
- Erlang/OTP was R11B-3 and you're hoping to get your new feature
- into R11B-4 set the version header to:
-
- Erlang-Version: R11B-4
-
-- Leave Post-History alone for now; you'll add dates to this header
- each time you post your EEP to the Erlang Mailing list. If you posted
- your EEP to the lists on August 14, 2001 and September 3, 2001, the
- Post-History header would look like::
-
- Post-History: 14-Aug-2001, 03-Sept-2001
-
- You must manually add new dates and check them in. If you don't
- have check-in privileges, send your changes to the EEP editors.
-
-- Add a Replaces header if your EEP obsoletes an earlier EEP. The
- value of this header is the number of the EEP that your new EEP is
- replacing. Only add this header if the older EEP is in "final"
- form, i.e. is either Accepted, Final, or Rejected. You aren't
- replacing an older open EEP if you're submitting a competing idea.
-
-- Now write your Abstract, Rationale, and other content for your EEP,
- replacing all this gobbledygook with your own text. Be sure to
- adhere to the format guidelines below, specifically on the
- prohibition of tab characters and the indentation requirements.
-
-- Update your References and Copyright section. Usually you'll place
- your EEP into the public domain, in which case just leave the
- Copyright section alone. Alternatively, you can use the `Open
- Publication License`__, but public domain is still strongly
- preferred.
-
- __ http://www.opencontent.org/openpub/
-
-- Leave the Emacs stanza at the end of this file alone, including the
- formfeed character ("^L", or ``\f``).
-
-- Send your EEP submission to the EEP editors at eeps@erlang.org.
-
-
-ReStructuredText EEP Formatting Requirements
-============================================
-
-The following is a EEP-specific summary of reStructuredText syntax.
-For the sake of simplicity and brevity, much detail is omitted. For
-more detail, see `Resources`_ below. `Literal blocks`_ (in which no
-markup processing is done) are used for examples throughout, to
-illustrate the plaintext markup.
-
-
-General
--------
-
-You must adhere to the Emacs convention of adding two spaces at the
-end of every sentence. You should fill your paragraphs to column 70,
-but under no circumstances should your lines extend past column 79.
-If your code samples spill over column 79, you should rewrite them.
-
-Tab characters must never appear in the document at all. A EEP should
-include the standard Emacs stanza included by example at the bottom of
-this EEP.
-
-
-Section Headings
-----------------
-
-EEP headings must begin in column zero and the initial letter of each
-word must be capitalized as in book titles. Acronyms should be in all
-capitals. Section titles must be adorned with an underline, a single
-repeated punctuation character, which begins in column zero and must
-extend at least as far as the right edge of the title text (4
-characters minimum). First-level section titles are underlined with
-"=" (equals signs), second-level section titles with "-" (hyphens),
-and third-level section titles with "'" (single quotes or
-apostrophes). For example::
-
- First-Level Title
- =================
-
- Second-Level Title
+ EEP: 3
+ Title: Sample reStructuredText EEP Template
+ Version: $Revision$
+ Last-Modified: $Date$
+ Author: Per Gustafsson <pergu(at)it(dot)uu(dot)se>
+ Status: Active
+ Type: Process
+ Content-Type: text/x-rst
+ Created: 05-Aug-2002
+ Post-History: 30-Aug-2002
+
+
+ Abstract
+ ========
+
+ This EEP provides a boilerplate or sample template for creating your
+ own reStructuredText EEPs. In conjunction with the content guidelines
+ in EEP 1 [1]_, this should make it easy for you to conform your own
+ EEPs to the format outlined below.
+
+ Note: if you are reading this EEP via the web, you should first grab
+ the text (reStructuredText) source of this EEP in order to complete
+ the steps below. **DO NOT USE THE HTML FILE AS YOUR TEMPLATE!**
+
+ If you would prefer not to use markup in your EEP, please see EEP 2,
+ "Sample Plaintext EEP Template" [2]_.
+
+ This EEP is a slightly revised version of PEP 12 [3]_.
+
+
+ Rationale
+ =========
+
+ ReStructuredText is offered as an alternative to plaintext EEPs, to
+ allow EEP authors more functionality and expressivity, while
+ maintaining easy readability in the source text. The processed HTML
+ form makes the functionality accessible to readers: live hyperlinks,
+ styled text, tables, images, and automatic tables of contents, among
+ other advantages.
+
+
+ How to Use This Template
+ ========================
+
+ To use this template you must first decide whether your EEP is going
+ to be an Informational or Standards Track EEP. Most EEPs are
+ Standards Track because they propose a new feature for the Erlang
+ language or standard library. When in doubt, read EEP 1 for details
+ or contact the EEP editors <eeps@erlang.org>.
+
+ Once you've decided which type of EEP yours is going to be, follow the
+ directions below.
+
+ - Make a copy of this file (``.txt`` file, **not** HTML!) and perform
+ the following edits.
+
+ - Replace the "EEP: 3" header with "EEP: XXX" since you don't yet have
+ a EEP number assignment.
+
+ - Change the Title header to the title of your EEP.
+
+ - Leave the Version and Last-Modified headers alone; we'll take care
+ of those when we check your EEP into the Subversion repository.
+ These headers consist of keywords ("Revision" and "Date" enclosed in
+ "$"-signs) which are automatically expanded by the repository.
+ Please do not edit the expanded date or revision text.
+
+ - Change the Author header to include your name, and optionally your
+ email address. Be sure to follow the format carefully: your name
+ must appear first, and it must not be contained in parentheses.
+ Your email address may appear second (or it can be omitted) and if
+ it appears, it must appear in angle brackets. It is okay to
+ obfuscate your email address.
+
+ - If there is a mailing list for discussion of your new feature, add a
+ Discussions-To header right after the Author header. You should not
+ add a Discussions-To header if the mailing list to be used is either
+ the erlang mailing list, or if discussions
+ should be sent to you directly. Most Informational EEPs don't have
+ a Discussions-To header.
+
+ - Change the Status header to "Draft".
+
+ - For Standards Track EEPs, change the Type header to "Standards
+ Track".
+
+ - For Informational EEPs, change the Type header to "Informational".
+
+ - For Standards Track EEPs, if your feature depends on the acceptance
+ of some other currently in-development EEP, add a Requires header
+ right after the Type header. The value should be the EEP number of
+ the EEP yours depends on. Don't add this header if your dependent
+ feature is described in a Final EEP.
+
+ - Change the Created header to today's date. Be sure to follow the
+ format carefully: it must be in ``dd-mmm-yyyy`` format, where the
+ ``mmm`` is the 3 English letter month abbreviation, i.e. one of Jan,
+ Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
+
+ - For Standards Track EEPs, after the Created header, add a
+ Erlang-Version header and set the value to the next planned
+ version of Erlang, i.e. the one your new feature will hopefully
+ make its first appearance in. Thus, if the last version of
+ Erlang/OTP was R11B-3 and you're hoping to get your new feature
+ into R11B-4 set the version header to:
+
+ Erlang-Version: R11B-4
+
+ - Leave Post-History alone for now; you'll add dates to this header
+ each time you post your EEP to the Erlang Mailing list. If you posted
+ your EEP to the lists on August 14, 2001 and September 3, 2001, the
+ Post-History header would look like::
+
+ Post-History: 14-Aug-2001, 03-Sept-2001
+
+ You must manually add new dates and check them in. If you don't
+ have check-in privileges, send your changes to the EEP editors.
+
+ - Add a Replaces header if your EEP obsoletes an earlier EEP. The
+ value of this header is the number of the EEP that your new EEP is
+ replacing. Only add this header if the older EEP is in "final"
+ form, i.e. is either Accepted, Final, or Rejected. You aren't
+ replacing an older open EEP if you're submitting a competing idea.
+
+ - Now write your Abstract, Rationale, and other content for your EEP,
+ replacing all this gobbledygook with your own text. Be sure to
+ adhere to the format guidelines below, specifically on the
+ prohibition of tab characters and the indentation requirements.
+
+ - Update your References and Copyright section. Usually you'll place
+ your EEP into the public domain, in which case just leave the
+ Copyright section alone. Alternatively, you can use the `Open
+ Publication License`__, but public domain is still strongly
+ preferred.
+
+ __ http://www.opencontent.org/openpub/
+
+ - Leave the Emacs stanza at the end of this file alone, including the
+ formfeed character ("^L", or ``\f``).
+
+ - Send your EEP submission to the EEP editors at eeps@erlang.org.
+
+
+ ReStructuredText EEP Formatting Requirements
+ ============================================
+
+ The following is a EEP-specific summary of reStructuredText syntax.
+ For the sake of simplicity and brevity, much detail is omitted. For
+ more detail, see `Resources`_ below. `Literal blocks`_ (in which no
+ markup processing is done) are used for examples throughout, to
+ illustrate the plaintext markup.
+
+
+ General
+ -------
+
+ You must adhere to the Emacs convention of adding two spaces at the
+ end of every sentence. You should fill your paragraphs to column 70,
+ but under no circumstances should your lines extend past column 79.
+ If your code samples spill over column 79, you should rewrite them.
+
+ Tab characters must never appear in the document at all. A EEP should
+ include the standard Emacs stanza included by example at the bottom of
+ this EEP.
+
+
+ Section Headings
+ ----------------
+
+ EEP headings must begin in column zero and the initial letter of each
+ word must be capitalized as in book titles. Acronyms should be in all
+ capitals. Section titles must be adorned with an underline, a single
+ repeated punctuation character, which begins in column zero and must
+ extend at least as far as the right edge of the title text (4
+ characters minimum). First-level section titles are underlined with
+ "=" (equals signs), second-level section titles with "-" (hyphens),
+ and third-level section titles with "'" (single quotes or
+ apostrophes). For example::
+
+ First-Level Title
+ =================
+
+ Second-Level Title
+ ------------------
+
+ Third-Level Title
+ '''''''''''''''''
+
+ If there are more than three levels of sections in your EEP, you may
+ insert overline/underline-adorned titles for the first and second
+ levels as follows::
+
+ ============================
+ First-Level Title (optional)
+ ============================
+
+ -----------------------------
+ Second-Level Title (optional)
+ -----------------------------
+
+ Third-Level Title
+ =================
+
+ Fourth-Level Title
+ ------------------
+
+ Fifth-Level Title
+ '''''''''''''''''
+
+ You shouldn't have more than five levels of sections in your EEP. If
+ you do, you should consider rewriting it.
+
+ You must use two blank lines between the last line of a section's body
+ and the next section heading. If a subsection heading immediately
+ follows a section heading, a single blank line in-between is
+ sufficient.
+
+ The body of each section is not normally indented, although some
+ constructs do use indentation, as described below. Blank lines are
+ used to separate constructs.
+
+
+ Paragraphs
+ ----------
+
+ Paragraphs are left-aligned text blocks separated by blank lines.
+ Paragraphs are not indented unless they are part of an indented
+ construct (such as a block quote or a list item).
+
+
+ Inline Markup
+ -------------
+
+ Portions of text within paragraphs and other text blocks may be
+ styled. For example::
+
+ Text may be marked as *emphasized* (single asterisk markup,
+ typically shown in italics) or **strongly emphasized** (double
+ asterisks, typically boldface). ``Inline literals`` (using double
+ backquotes) are typically rendered in a monospaced typeface. No
+ further markup recognition is done within the double backquotes,
+ so they're safe for any kind of code snippets.
+
+
+ Block Quotes
+ ------------
+
+ Block quotes consist of indented body elements. For example::
+
+ This is a paragraph.
+
+ This is a block quote.
+
+ A block quote may contain many paragraphs.
+
+ Block quotes are used to quote extended passages from other sources.
+ Block quotes may be nested inside other body elements. Use 4 spaces
+ per indent level.
+
+
+ Literal Blocks
+ --------------
+
+ ..
+ In the text below, double backquotes are used to denote inline
+ literals. "``::``" is written so that the colons will appear in a
+ monospaced font; the backquotes (``) are markup, not part of the
+ text. See "Inline Markup" above.
+
+ By the way, this is a comment, described in "Comments" below.
+
+ Literal blocks are used for code samples or preformatted ASCII art. To
+ indicate a literal block, preface the indented text block with
+ "``::``" (two colons). The literal block continues until the end of
+ the indentation. Indent the text block by 4 spaces. For example::
+
+ This is a typical paragraph. A literal block follows.
+
+ ::
+
+ for a in [5,4,3,2,1]: # this is program code, shown as-is
+ print a
+ print "it's..."
+ # a literal block continues until the indentation ends
+
+ The paragraph containing only "``::``" will be completely removed from
+ the output; no empty paragraph will remain. "``::``" is also
+ recognized at the end of any paragraph. If immediately preceded by
+ whitespace, both colons will be removed from the output. When text
+ immediately precedes the "``::``", *one* colon will be removed from
+ the output, leaving only one colon visible (i.e., "``::``" will be
+ replaced by "``:``"). For example, one colon will remain visible
+ here::
+
+ Paragraph::
+
+ Literal block
+
+
+ Lists
+ -----
+
+ Bullet list items begin with one of "-", "*", or "+" (hyphen,
+ asterisk, or plus sign), followed by whitespace and the list item
+ body. List item bodies must be left-aligned and indented relative to
+ the bullet; the text immediately after the bullet determines the
+ indentation. For example::
+
+ This paragraph is followed by a list.
+
+ * This is the first bullet list item. The blank line above the
+ first list item is required; blank lines between list items
+ (such as below this paragraph) are optional.
+
+ * This is the first paragraph in the second item in the list.
+
+ This is the second paragraph in the second item in the list.
+ The blank line above this paragraph is required. The left edge
+ of this paragraph lines up with the paragraph above, both
+ indented relative to the bullet.
+
+ - This is a sublist. The bullet lines up with the left edge of
+ the text blocks above. A sublist is a new list so requires a
+ blank line above and below.
+
+ * This is the third item of the main list.
+
+ This paragraph is not part of the list.
+
+ Enumerated (numbered) list items are similar, but use an enumerator
+ instead of a bullet. Enumerators are numbers (1, 2, 3, ...), letters
+ (A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
+ iv, ...; uppercase or lowercase), formatted with a period suffix
+ ("1.", "2."), parentheses ("(1)", "(2)"), or a right-parenthesis
+ suffix ("1)", "2)"). For example::
+
+ 1. As with bullet list items, the left edge of paragraphs must
+ align.
+
+ 2. Each list item may contain multiple paragraphs, sublists, etc.
+
+ This is the second paragraph of the second list item.
+
+ a) Enumerated lists may be nested.
+ b) Blank lines may be omitted between list items.
+
+ Definition lists are written like this::
+
+ what
+ Definition lists associate a term with a definition.
+
+ how
+ The term is a one-line phrase, and the definition is one
+ or more paragraphs or body elements, indented relative to
+ the term.
+
+
+ Tables
+ ------
+
+ Simple tables are easy and compact::
+
+ ===== ===== =======
+ A B A and B
+ ===== ===== =======
+ False False False
+ True False False
+ False True False
+ True True True
+ ===== ===== =======
+
+ There must be at least two columns in a table (to differentiate from
+ section titles). Column spans use underlines of hyphens ("Inputs"
+ spans the first two columns)::
+
+ ===== ===== ======
+ Inputs Output
+ ------------ ------
+ A B A or B
+ ===== ===== ======
+ False False False
+ True False True
+ False True True
+ True True True
+ ===== ===== ======
+
+ Text in a first-column cell starts a new row. No text in the first
+ column indicates a continuation line; the rest of the cells may
+ consist of multiple lines. For example::
+
+ ===== =========================
+ col 1 col 2
+ ===== =========================
+ 1 Second column of row 1.
+ 2 Second column of row 2.
+ Second line of paragraph.
+ 3 - Second column of row 3.
+
+ - Second item in bullet
+ list (row 3, column 2).
+ ===== =========================
+
+
+ Hyperlinks
+ ----------
+
+ When referencing an external web page in the body of a EEP, you should
+ include the title of the page in the text, with either an inline
+ hyperlink reference to the URL or a footnote reference (see
+ `Footnotes`_ below). Do not include the URL in the body text of the
+ EEP.
+
+ Hyperlink references use backquotes and a trailing underscore to mark
+ up the reference text; backquotes are optional if the reference text
+ is a single word. For example::
+
+ In this paragraph, we refer to the `Erlang web site`_.
+
+ An explicit target provides the URL. Put targets in a References
+ section at the end of the EEP, or immediately after the reference.
+ Hyperlink targets begin with two periods and a space (the "explicit
+ markup start"), followed by a leading underscore, the reference text,
+ a colon, and the URL (absolute or relative)::
+
+ .. _Erlang web site: http://www.erlang.org/
+
+ The reference text and the target text must match (although the match
+ is case-insensitive and ignores differences in whitespace). Note that
+ the underscore trails the reference text but precedes the target text.
+ If you think of the underscore as a right-pointing arrow, it points
+ *away* from the reference and *toward* the target.
+
+ The same mechanism can be used for internal references. Every unique
+ section title implicitly defines an internal hyperlink target. We can
+ make a link to the Abstract section like this::
+
+ Here is a hyperlink reference to the `Abstract`_ section. The
+ backquotes are optional since the reference text is a single word;
+ we can also just write: Abstract_.
+
+ Footnotes containing the URLs from external targets will be generated
+ automatically at the end of the References section of the EEP, along
+ with footnote references linking the reference text to the footnotes.
+
+ Text of the form "EEP x" or "RFC x" (where "x" is a number) will be
+ linked automatically to the appropriate URLs.
+
+
+ Footnotes
+ ---------
+
+ Footnote references consist of a left square bracket, a number, a
+ right square bracket, and a trailing underscore::
+
+ This sentence ends with a footnote reference [1]_.
+
+ Whitespace must precede the footnote reference. Leave a space between
+ the footnote reference and the preceding word.
+
+ When referring to another EEP, include the EEP number in the body
+ text, such as "EEP 1". The title may optionally appear. Add a
+ footnote reference following the title. For example::
+
+ Refer to EEP 1 [2]_ for more information.
+
+ Add a footnote that includes the EEP's title and author. It may
+ optionally include the explicit URL on a separate line, but only in
+ the References section. Footnotes begin with ".. " (the explicit
+ markup start), followed by the footnote marker (no underscores),
+ followed by the footnote body. For example::
+
+ References
+ ==========
+
+ .. [2] EEP 1, "EEP Purpose and Guidelines", Gustafsson
+ (http://www.erlang.org/eeps/eep-0001)
+
+ If you decide to provide an explicit URL for a EEP, please use this as
+ the URL template::
+
+ http://www.erlang.org/eeps/eep-xxxx
+
+ EEP numbers in URLs must be padded with zeros from the left, so as to
+ be exactly 4 characters wide, however EEP numbers in the text are
+ never padded.
+
+ During the course of developing your EEP, you may have to add, remove,
+ and rearrange footnote references, possibly resulting in mismatched
+ references, obsolete footnotes, and confusion. Auto-numbered
+ footnotes allow more freedom. Instead of a number, use a label of the
+ form "#word", where "word" is a mnemonic consisting of alphanumerics
+ plus internal hyphens, underscores, and periods (no whitespace or
+ other characters are allowed). For example::
+
+ Refer to EEP 1 [#EEP-1]_ for more information.
+
+ References
+ ==========
+
+ .. [#EEP-1] EEP 1, "EEP Purpose and Guidelines", Gustafsson
+
+ http://www.erlang.org/eeps/eep-0001
+
+ Footnotes and footnote references will be numbered automatically, and
+ the numbers will always match. Once a EEP is finalized, auto-numbered
+ labels should be replaced by numbers for simplicity.
+
+
+ Images
+ ------
+
+ If your EEP contains a diagram, you may include it in the processed
+ output using the "image" directive::
+
+ .. image:: diagram.png
+
+ Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
+ .tiff, etc.
+
+ Since this image will not be visible to readers of the EEP in source
+ text form, you should consider including a description or ASCII art
+ alternative, using a comment (below).
+
+
+ Comments
+ --------
+
+ A comment block is an indented block of arbitrary text immediately
+ following an explicit markup start: two periods and whitespace. Leave
+ the ".." on a line by itself to ensure that the comment is not
+ misinterpreted as another explicit markup construct. Comments are not
+ visible in the processed document. For the benefit of those reading
+ your EEP in source form, please consider including a descriptions of
+ or ASCII art alternatives to any images you include. For example::
+
+ .. image:: dataflow.png
+
+ ..
+ Data flows from the input module, through the "black box"
+ module, and finally into (and through) the output module.
+
+ The Emacs stanza at the bottom of this document is inside a comment.
+
+
+ Escaping Mechanism
------------------
-
- Third-Level Title
- '''''''''''''''''
-
-If there are more than three levels of sections in your EEP, you may
-insert overline/underline-adorned titles for the first and second
-levels as follows::
-
- ============================
- First-Level Title (optional)
- ============================
-
- -----------------------------
- Second-Level Title (optional)
- -----------------------------
-
- Third-Level Title
- =================
-
- Fourth-Level Title
- ------------------
-
- Fifth-Level Title
- '''''''''''''''''
-
-You shouldn't have more than five levels of sections in your EEP. If
-you do, you should consider rewriting it.
-
-You must use two blank lines between the last line of a section's body
-and the next section heading. If a subsection heading immediately
-follows a section heading, a single blank line in-between is
-sufficient.
-
-The body of each section is not normally indented, although some
-constructs do use indentation, as described below. Blank lines are
-used to separate constructs.
-
-
-Paragraphs
-----------
-
-Paragraphs are left-aligned text blocks separated by blank lines.
-Paragraphs are not indented unless they are part of an indented
-construct (such as a block quote or a list item).
-
-
-Inline Markup
--------------
-
-Portions of text within paragraphs and other text blocks may be
-styled. For example::
-
- Text may be marked as *emphasized* (single asterisk markup,
- typically shown in italics) or **strongly emphasized** (double
- asterisks, typically boldface). ``Inline literals`` (using double
- backquotes) are typically rendered in a monospaced typeface. No
- further markup recognition is done within the double backquotes,
- so they're safe for any kind of code snippets.
-
-
-Block Quotes
-------------
-
-Block quotes consist of indented body elements. For example::
-
- This is a paragraph.
-
- This is a block quote.
-
- A block quote may contain many paragraphs.
-
-Block quotes are used to quote extended passages from other sources.
-Block quotes may be nested inside other body elements. Use 4 spaces
-per indent level.
-
-
-Literal Blocks
---------------
-
-..
- In the text below, double backquotes are used to denote inline
- literals. "``::``" is written so that the colons will appear in a
- monospaced font; the backquotes (``) are markup, not part of the
- text. See "Inline Markup" above.
-
- By the way, this is a comment, described in "Comments" below.
-
-Literal blocks are used for code samples or preformatted ASCII art. To
-indicate a literal block, preface the indented text block with
-"``::``" (two colons). The literal block continues until the end of
-the indentation. Indent the text block by 4 spaces. For example::
-
- This is a typical paragraph. A literal block follows.
-
- ::
-
- for a in [5,4,3,2,1]: # this is program code, shown as-is
- print a
- print "it's..."
- # a literal block continues until the indentation ends
-
-The paragraph containing only "``::``" will be completely removed from
-the output; no empty paragraph will remain. "``::``" is also
-recognized at the end of any paragraph. If immediately preceded by
-whitespace, both colons will be removed from the output. When text
-immediately precedes the "``::``", *one* colon will be removed from
-the output, leaving only one colon visible (i.e., "``::``" will be
-replaced by "``:``"). For example, one colon will remain visible
-here::
-
- Paragraph::
-
- Literal block
-
-
-Lists
------
-
-Bullet list items begin with one of "-", "*", or "+" (hyphen,
-asterisk, or plus sign), followed by whitespace and the list item
-body. List item bodies must be left-aligned and indented relative to
-the bullet; the text immediately after the bullet determines the
-indentation. For example::
-
- This paragraph is followed by a list.
-
- * This is the first bullet list item. The blank line above the
- first list item is required; blank lines between list items
- (such as below this paragraph) are optional.
-
- * This is the first paragraph in the second item in the list.
-
- This is the second paragraph in the second item in the list.
- The blank line above this paragraph is required. The left edge
- of this paragraph lines up with the paragraph above, both
- indented relative to the bullet.
-
- - This is a sublist. The bullet lines up with the left edge of
- the text blocks above. A sublist is a new list so requires a
- blank line above and below.
-
- * This is the third item of the main list.
-
- This paragraph is not part of the list.
-
-Enumerated (numbered) list items are similar, but use an enumerator
-instead of a bullet. Enumerators are numbers (1, 2, 3, ...), letters
-(A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
-iv, ...; uppercase or lowercase), formatted with a period suffix
-("1.", "2."), parentheses ("(1)", "(2)"), or a right-parenthesis
-suffix ("1)", "2)"). For example::
-
- 1. As with bullet list items, the left edge of paragraphs must
- align.
-
- 2. Each list item may contain multiple paragraphs, sublists, etc.
-
- This is the second paragraph of the second list item.
-
- a) Enumerated lists may be nested.
- b) Blank lines may be omitted between list items.
-
-Definition lists are written like this::
-
- what
- Definition lists associate a term with a definition.
-
- how
- The term is a one-line phrase, and the definition is one
- or more paragraphs or body elements, indented relative to
- the term.
-
-
-Tables
-------
-
-Simple tables are easy and compact::
-
- ===== ===== =======
- A B A and B
- ===== ===== =======
- False False False
- True False False
- False True False
- True True True
- ===== ===== =======
-
-There must be at least two columns in a table (to differentiate from
-section titles). Column spans use underlines of hyphens ("Inputs"
-spans the first two columns)::
-
- ===== ===== ======
- Inputs Output
- ------------ ------
- A B A or B
- ===== ===== ======
- False False False
- True False True
- False True True
- True True True
- ===== ===== ======
-
-Text in a first-column cell starts a new row. No text in the first
-column indicates a continuation line; the rest of the cells may
-consist of multiple lines. For example::
-
- ===== =========================
- col 1 col 2
- ===== =========================
- 1 Second column of row 1.
- 2 Second column of row 2.
- Second line of paragraph.
- 3 - Second column of row 3.
-
- - Second item in bullet
- list (row 3, column 2).
- ===== =========================
-
-
-Hyperlinks
-----------
-
-When referencing an external web page in the body of a EEP, you should
-include the title of the page in the text, with either an inline
-hyperlink reference to the URL or a footnote reference (see
-`Footnotes`_ below). Do not include the URL in the body text of the
-EEP.
-
-Hyperlink references use backquotes and a trailing underscore to mark
-up the reference text; backquotes are optional if the reference text
-is a single word. For example::
-
- In this paragraph, we refer to the `Erlang web site`_.
-
-An explicit target provides the URL. Put targets in a References
-section at the end of the EEP, or immediately after the reference.
-Hyperlink targets begin with two periods and a space (the "explicit
-markup start"), followed by a leading underscore, the reference text,
-a colon, and the URL (absolute or relative)::
-
- .. _Erlang web site: http://www.erlang.org/
-
-The reference text and the target text must match (although the match
-is case-insensitive and ignores differences in whitespace). Note that
-the underscore trails the reference text but precedes the target text.
-If you think of the underscore as a right-pointing arrow, it points
-*away* from the reference and *toward* the target.
-
-The same mechanism can be used for internal references. Every unique
-section title implicitly defines an internal hyperlink target. We can
-make a link to the Abstract section like this::
-
- Here is a hyperlink reference to the `Abstract`_ section. The
- backquotes are optional since the reference text is a single word;
- we can also just write: Abstract_.
-
-Footnotes containing the URLs from external targets will be generated
-automatically at the end of the References section of the EEP, along
-with footnote references linking the reference text to the footnotes.
-
-Text of the form "EEP x" or "RFC x" (where "x" is a number) will be
-linked automatically to the appropriate URLs.
-
-
-Footnotes
----------
-
-Footnote references consist of a left square bracket, a number, a
-right square bracket, and a trailing underscore::
-
- This sentence ends with a footnote reference [1]_.
-
-Whitespace must precede the footnote reference. Leave a space between
-the footnote reference and the preceding word.
-
-When referring to another EEP, include the EEP number in the body
-text, such as "EEP 1". The title may optionally appear. Add a
-footnote reference following the title. For example::
-
- Refer to EEP 1 [2]_ for more information.
-
-Add a footnote that includes the EEP's title and author. It may
-optionally include the explicit URL on a separate line, but only in
-the References section. Footnotes begin with ".. " (the explicit
-markup start), followed by the footnote marker (no underscores),
-followed by the footnote body. For example::
-
- References
- ==========
-
- .. [2] EEP 1, "EEP Purpose and Guidelines", Gustafsson
- (http://www.erlang.org/eeps/eep-0001)
-
-If you decide to provide an explicit URL for a EEP, please use this as
-the URL template::
-
- http://www.erlang.org/eeps/eep-xxxx
-
-EEP numbers in URLs must be padded with zeros from the left, so as to
-be exactly 4 characters wide, however EEP numbers in the text are
-never padded.
-
-During the course of developing your EEP, you may have to add, remove,
-and rearrange footnote references, possibly resulting in mismatched
-references, obsolete footnotes, and confusion. Auto-numbered
-footnotes allow more freedom. Instead of a number, use a label of the
-form "#word", where "word" is a mnemonic consisting of alphanumerics
-plus internal hyphens, underscores, and periods (no whitespace or
-other characters are allowed). For example::
-
- Refer to EEP 1 [#EEP-1]_ for more information.
-
+
+ reStructuredText uses backslashes ("``\``") to override the special
+ meaning given to markup characters and get the literal characters
+ themselves. To get a literal backslash, use an escaped backslash
+ ("``\\``"). There are two contexts in which backslashes have no
+ special meaning: `literal blocks`_ and inline literals (see `Inline
+ Markup`_ above). In these contexts, no markup recognition is done,
+ and a single backslash represents a literal backslash, without having
+ to double up.
+
+ If you find that you need to use a backslash in your text, consider
+ using inline literals or a literal block instead.
+
+
+ Habits to Avoid
+ ===============
+
+ Many programmers who are familiar with TeX often write quotation marks
+ like this::
+
+ `single-quoted' or ``double-quoted''
+
+ Backquotes are significant in reStructuredText, so this practice
+ should be avoided. For ordinary text, use ordinary 'single-quotes' or
+ "double-quotes". For inline literal text (see `Inline Markup`_
+ above), use double-backquotes::
+
+ ``literal text: in here, anything goes!``
+
+
+ Resources
+ =========
+
+ Many other constructs and variations are possible. For more details
+ about the reStructuredText markup, in increasing order of
+ thoroughness, please see:
+
+ * `A ReStructuredText Primer`__, a gentle introduction.
+
+ __ http://docutils.sourceforge.net/docs/rst/quickstart.html
+
+ * `Quick reStructuredText`__, a users' quick reference.
+
+ __ http://docutils.sourceforge.net/docs/rst/quickref.html
+
+ * `reStructuredText Markup Specification`__, the final authority.
+
+ __ http://docutils.sourceforge.net/spec/rst/reStructuredText.html
+
+ The processing of reStructuredText EEPs is done using Docutils_. The
+ `Docutils project web site`_ has more information.
+
+ .. _Docutils:
+ .. _Docutils project web site: http://docutils.sourceforge.net/
+
+
References
==========
-
- .. [#EEP-1] EEP 1, "EEP Purpose and Guidelines", Gustafsson
-
- http://www.erlang.org/eeps/eep-0001
-
-Footnotes and footnote references will be numbered automatically, and
-the numbers will always match. Once a EEP is finalized, auto-numbered
-labels should be replaced by numbers for simplicity.
-
-
-Images
-------
-
-If your EEP contains a diagram, you may include it in the processed
-output using the "image" directive::
-
- .. image:: diagram.png
-
-Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
-.tiff, etc.
-
-Since this image will not be visible to readers of the EEP in source
-text form, you should consider including a description or ASCII art
-alternative, using a comment (below).
-
-
-Comments
---------
-
-A comment block is an indented block of arbitrary text immediately
-following an explicit markup start: two periods and whitespace. Leave
-the ".." on a line by itself to ensure that the comment is not
-misinterpreted as another explicit markup construct. Comments are not
-visible in the processed document. For the benefit of those reading
-your EEP in source form, please consider including a descriptions of
-or ASCII art alternatives to any images you include. For example::
-
- .. image:: dataflow.png
-
- ..
- Data flows from the input module, through the "black box"
- module, and finally into (and through) the output module.
-
-The Emacs stanza at the bottom of this document is inside a comment.
-
-
-Escaping Mechanism
-------------------
-
-reStructuredText uses backslashes ("``\``") to override the special
-meaning given to markup characters and get the literal characters
-themselves. To get a literal backslash, use an escaped backslash
-("``\\``"). There are two contexts in which backslashes have no
-special meaning: `literal blocks`_ and inline literals (see `Inline
-Markup`_ above). In these contexts, no markup recognition is done,
-and a single backslash represents a literal backslash, without having
-to double up.
-
-If you find that you need to use a backslash in your text, consider
-using inline literals or a literal block instead.
-
-
-Habits to Avoid
-===============
-
-Many programmers who are familiar with TeX often write quotation marks
-like this::
-
- `single-quoted' or ``double-quoted''
-
-Backquotes are significant in reStructuredText, so this practice
-should be avoided. For ordinary text, use ordinary 'single-quotes' or
-"double-quotes". For inline literal text (see `Inline Markup`_
-above), use double-backquotes::
-
- ``literal text: in here, anything goes!``
-
-
-Resources
-=========
-
-Many other constructs and variations are possible. For more details
-about the reStructuredText markup, in increasing order of
-thoroughness, please see:
-
-* `A ReStructuredText Primer`__, a gentle introduction.
-
- __ http://docutils.sourceforge.net/docs/rst/quickstart.html
-
-* `Quick reStructuredText`__, a users' quick reference.
-
- __ http://docutils.sourceforge.net/docs/rst/quickref.html
-
-* `reStructuredText Markup Specification`__, the final authority.
-
- __ http://docutils.sourceforge.net/spec/rst/reStructuredText.html
-
-The processing of reStructuredText EEPs is done using Docutils_. The
-`Docutils project web site`_ has more information.
-
-.. _Docutils:
-.. _Docutils project web site: http://docutils.sourceforge.net/
-
-
-References
-==========
-
-.. [1] EEP 1, EEP Purpose and Guidelines, Gustafsson
- (http://www.erlang.org/eeps/eep-0001.html)
-
-.. [2] EEP 2, Sample Plaintext EEP Template, Gustafsson
- (http://www.erlang.org/eeps/eep-0002.html)
-
-.. [3] PEP 12, Sample reStructuredText PEP Template, Godger, Warsaw
- (http://www.python.org/dev/peps/pep-0012/)
-
-Copyright
-=========
-
-This document has been placed in the public domain.
-
-
-
-..
- Local Variables:
- mode: indented-text
- indent-tabs-mode: nil
- sentence-end-double-space: t
- fill-column: 70
- coding: utf-8
- End:
+
+ .. [1] EEP 1, EEP Purpose and Guidelines, Gustafsson
+ (http://www.erlang.org/eeps/eep-0001.html)
+
+ .. [2] EEP 2, Sample Plaintext EEP Template, Gustafsson
+ (http://www.erlang.org/eeps/eep-0002.html)
+
+ .. [3] PEP 12, Sample reStructuredText PEP Template, Godger, Warsaw
+ (http://www.python.org/dev/peps/pep-0012/)
+
+ Copyright
+ =========
+
+ This document has been placed in the public domain.
+
+
+
+ ..
+ Local Variables:
+ mode: indented-text
+ indent-tabs-mode: nil
+ sentence-end-double-space: t
+ fill-column: 70
+ coding: utf-8
+ End:
View
32 eeps/eep-0004.md
@@ -1,14 +1,14 @@
-EEP: 4
-Title: New BIFs for bit-level binaries (bit strings)
-Version: $Revision$
-Last-Modified: $Date$
-Author: Per Gustafsson
-Status: Draft
-Type: Standards Track
-Content-Type: text/x-rst
-Created: 10-Aug-2007
-Erlang-Version: R12B-0
-Post-History:
+ Author: Per Gustafsson <pergu(at)it(dot)uu(dot)se>
+ Status: Final/R12B-0 Proposal is implemented in OTP release R12B-0
+ Type: Standards Track
+ Created: 10-Aug-2007
+ Erlang-Version: R12B-0
+ Post-History:
+****
+EEP 4: New BIFs for bit-level binaries (bit strings)
+----
+
+
Abstract
========
@@ -125,3 +125,13 @@ bit-level binaries as we have for ordinary binaries without changing
the semantics of the BIFs for binaries such as size/1,
binary_to_list/1, list_to_binary/1 etc.. This means that all such BIFs
will throw an exception if their arguments contains bit strings.
+
+
+
+[EmacsVar]: <> "Local Variables:"
+[EmacsVar]: <> "mode: indented-text"
+[EmacsVar]: <> "indent-tabs-mode: nil"
+[EmacsVar]: <> "sentence-end-double-space: t"
+[EmacsVar]: <> "fill-column: 70"
+[EmacsVar]: <> "coding: utf-8"
+[EmacsVar]: <> "End:"
View
69 eeps/eep-0005.md
@@ -1,33 +1,34 @@
-EEP 5: More Versatile Encapsulation with export_to
-====
-
- Author: Per Gustafsson
+ Author: Per Gustafsson <pergu(at)it(dot)uu(dot)se>
Status: Draft
Type: Standards Track
- Content-Type: text/x-markdown
Created: 10-Aug-2007
Erlang-Version: R12B-0
Post-History:
+****
+EEP 5: More Versatile Encapsulation with `export_to`
+----
+
-====
Abstract
---------
+========
-This EEP describes a new directive called export_to which allows a
+This EEP describes a new directive called `export_to` which allows a
module to specify exactly which other modules that can call a function
defined in the module. This provides a very fine grained primitive for
encapsulation. Allowing the programmer to control more directly how
his code should be used.
This is an idea originally proposed by Richard O'Keefe.
+
+
Specification
--------------
+=============
-This is the syntax for the export_to directive:
+This is the syntax for the `export_to` directive:
-``-export_to(m,[f/a])``
+ -export_to(m,[f/a])
where `f` is the name of a function of arity `a` and `m` is a
module. (Perhaps we should allow a list of modules)
@@ -40,8 +41,10 @@ In addition these functions should act as exported functions to the
rest of the world i.e. calls to these functions should always be to
the latest version of the function.
+
+
Motivation
-----------
+==========
The module in Erlang have several roles. It is the unit of compilation
and code reloading. It is also the unit of encapsulation, because the
@@ -61,18 +64,20 @@ the module, but sometimes we want to have more control than this
e.g. this function should only be called from other modules in this
application, or this function should only be called from the shell.
-The export_to directive gives the programmer the possibility to
+The `export_to` directive gives the programmer the possibility to
express such restrictions that the runtime system then enforces. It
-should be noted that the export_to directive is not meant to replace
+should be noted that the `export_to` directive is not meant to replace
the export directive, but to be an alternative in the case when the
programmer knows all possible collaborators.
+
+
Rationale
----------
+=========
-There are some choices in designing the export_to syntax for example
+There are some choices in designing the `export_to` syntax for example
should m be allowed to be a list of modules or should we have an
-export_to list where each entry is a module, function/arity pair. One
+`export_to` list where each entry is a module, function/arity pair. One
reason to use the suggested syntax is that it reads pretty easily as:
export to module `m` this list of functions `[f/a]`
@@ -84,30 +89,42 @@ make it possible to apply the function or to make it possible to
update the code of the function.
Discussions about such changes is outside the scope of this EEP, we
-only note that the export_to directive makes a good building block for
+only note that the `export_to` directive makes a good building block for
creating such extensions without having to change the Erlang runtime.
- .. Other languages that have something like this?
+
Backwards Compatibility
------------------------
+=======================
-Adding an export_to directive should be totally backwards
+Adding an `export_to` directive should be totally backwards
compatible. Since writing such a directive now causes a syntax error
since it is not a legal attribute.
+
+
Implementation
---------------
+==============
This feature has not been implemented yet, but here are some goals
that we think the implementation should fulfill:
-* Ordinary static calls to an export_to function should cost the same
- as calls to other exported functions
+* Ordinary static calls to an `export_to` function should cost the same
+ as calls to other exported functions
-* The performance of other calls should not be affected by the
- introduction of export_to calls
+* The performance of other calls should not be affected by the
+ introduction of `export_to` calls
This can be archived by putting most of the machinery to handle this
feature in to the loader and only use dynamic checks for dynamic
calls.
+
+
+
+[EmacsVar]: <> "Local Variables:"
+[EmacsVar]: <> "mode: indented-text"
+[EmacsVar]: <> "indent-tabs-mode: nil"
+[EmacsVar]: <> "sentence-end-double-space: t"
+[EmacsVar]: <> "fill-column: 70"
+[EmacsVar]: <> "coding: utf-8"
+[EmacsVar]: <> "End:"
View
79 eeps/eep-0006.md
@@ -1,69 +1,88 @@
-EEP 6: New BIFs for tuple and binary sizes
-====
-
- Author: Bjorn Gustavsson
- Status: Draft
+ Author: Björn Gustavsson <bjorn(at)erlang(dot)org>
+ Status: Final/R12B-0 Proposal is implemented in OTP release R12B-0
Type: Standards Track
- Content-Type: text/x-markdown
Created: 10-Aug-2007
Erlang-Version: R12B-0
Post-History:
+**