[pkg] add some relevant docs
authorKali Kaneko (leap communications) <kali@leap.se>
Tue, 30 Aug 2016 15:25:27 +0000 (11:25 -0400)
committerKali Kaneko (leap communications) <kali@leap.se>
Tue, 30 Aug 2016 15:25:35 +0000 (11:25 -0400)
17 files changed:
AUTHORS [new file with mode: 0644]
LICENSE [new file with mode: 0644]
docs/core_api_contract [new file with mode: 0755]
docs/leap-autopep8.post-commit.hook [new file with mode: 0755]
docs/leap-autopep8.post-commit.hook.ADD [new file with mode: 0755]
docs/leap-commit-template [new file with mode: 0644]
docs/leap-commit-template.README [new file with mode: 0644]
docs/leap-flake8.pre-commit.hook [new file with mode: 0755]
docs/man/bitmask-root.1.rst [new file with mode: 0644]
docs/man/bitmask.1.rst [new file with mode: 0644]
docs/release_checklist.wiki [new file with mode: 0644]
docs/testing-rcs.README [new file with mode: 0644]
pkg/tools/check_code.sh [new file with mode: 0755]
pkg/tools/filter-bitmask-deps [new file with mode: 0755]
pkg/tools/get_authors.sh [new file with mode: 0755]
pkg/tools/monitor_resource.zsh [new file with mode: 0755]
release-notes.rst [new file with mode: 0644]

diff --git a/AUTHORS b/AUTHORS
new file mode 100644 (file)
index 0000000..cbd35da
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,16 @@
+Tomás Touceda <chiiph@leap.se>
+Ivan Alejandro <ivanalejandro0@gmail.com>
+Kali Kaneko <kali@leap.se>
+drebs <drebs@leap.se>
+antialias <antialias@leap.se>
+elijah <elijah@riseup.net>
+Ruben Pollan <meskio@sindominio.net>
+k clair <kclair@riseup.net>
+Jaromil <jaromil@dyne.org>
+kwadronaut <kwadronaut@leap.se>
+Duda Dornelles <ddornell@thoughtworks.com>
+Bruno Wagner Goncalves <bwagner@thoughtworks.com>
+Parménides GV <parmegv@sdf.org>
+Neissi Lima <neissi.lima@gmail.com>
+Micah Anderson <micah@riseup.net>
+irregulator <irregulator@riseup.net>
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..2ccb50e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,710 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
+--------------------------------------------------------------------------------
+We are "embedding" PastebinAPI class since currently the installation through
+pip does not work.
+
+file: src/leap/bitmask/util/pastebin.py
+License: GPL
+Author: Ian Havelock
+website: https://github.com/Morrolan/PastebinAPI
+--------------------------------------------------------------------------------
+
+Bitmask also uses third party icons:
+
+---
+data/images/Arrow-Up-32.png
+data/images/Arrow-Down-32.png
+
+Author: Liam McKay
+License: GNU General Public License - http://en.wikipedia.org/wiki/GNU_General_Public_License
+WebSite: http://wefunction.com/
+IconPackage: WooFunction icon pack - http://www.iconspedia.com/pack/woofunction-icons-4136/
+---
+data/images/oxygen-icons/
+
+The following icons were created based on 'mail-unread.png' from oxygen:
+data/images/mail-locked.png
+data/images/mail-unlocked.png
+
+License: LGPL - http://www.gnu.org/licenses/lgpl.html
+Website: http://www.oxygen-icons.org/
+--
+data/images/pastebin.png
+
+author: Marco Martin
+License: LGPL
+website: https://www.iconfinder.com/icons/7897/binary_icon
diff --git a/docs/core_api_contract b/docs/core_api_contract
new file mode 100755 (executable)
index 0000000..b70fb8f
--- /dev/null
@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# api_contract.py
+# Copyright (C) 2016 LEAP Encryption Acess Project
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+Display a human-readable representation of the methods that compound the public
+api for Bitmask Core.
+
+The values are meant to be type annotations.
+"""
+
+if __name__ == "__main__":
+    from leap.bitmask.core.service import BitmaskBackend
+    from leap.bitmask.core import api
+    backend = BitmaskBackend()
+
+    print '========= Bitmask Core API =================='
+    print
+
+    for key in api.registry:
+        human_key = key.replace('do_', '').lower()
+        value = api.registry[key]
+
+        print("{}:\t\t{}".format(
+            human_key,
+            ' '.join([x for x in value])))
+    print
+    print '============================================='
diff --git a/docs/leap-autopep8.post-commit.hook b/docs/leap-autopep8.post-commit.hook
new file mode 100755 (executable)
index 0000000..cffb1d5
--- /dev/null
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Auto pep8 correction as a post-commit hook.
+# Thanks to http://victorlin.me/posts/2014/02/05/auto-post-commit-pep8-correction
+
+echo "[+] running autopep8..."
+FILES=$(git diff HEAD^ HEAD --name-only --diff-filter=ACM | grep -e '\.py$')
+for f in $FILES
+do
+    # auto pep8 correction
+    autopep8 --in-place $f
+done
+
+git status
diff --git a/docs/leap-autopep8.post-commit.hook.ADD b/docs/leap-autopep8.post-commit.hook.ADD
new file mode 100755 (executable)
index 0000000..b6e07ae
--- /dev/null
@@ -0,0 +1,2 @@
+ #!/bin/sh
+ cd .git/hooks && ln -s ../../docs/leap-autopep8.post-commit.hook post-commit
diff --git a/docs/leap-commit-template b/docs/leap-commit-template
new file mode 100644 (file)
index 0000000..8a5c7cd
--- /dev/null
@@ -0,0 +1,7 @@
+[bug|feat|docs|style|refactor|test|pkg|i18n] ...
+...
+
+- Resolves: #XYZ
+- Related: #XYZ
+- Documentation: #XYZ
+- Releases: XYZ
diff --git a/docs/leap-commit-template.README b/docs/leap-commit-template.README
new file mode 100644 (file)
index 0000000..ce8809e
--- /dev/null
@@ -0,0 +1,47 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+HOW TO USE THIS TEMPLATE:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run `git config commit.template docs/leap-commit-template` or
+edit the .git/config for this project and add
+`template = docs/leap-commit-template` 
+under the [commit] block
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+COMMIT TEMPLATE FORMAT EXPLAINED
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[type] <subject>
+
+<body>
+<footer>
+
+Type should be one of the following:
+- bug (bug fix)
+- feat (new feature)
+- docs (changes to documentation)
+- style (formatting, pep8 violations, etc; no code change)
+- refactor (refactoring production code)
+- test (adding missing tests, refactoring tests; no production code change)
+- pkg (packaging related changes; no production code change)
+- i18n translation related changes
+
+Subject should use imperative tone and say what you did.
+For example, use 'change', NOT 'changed' or 'changes'.
+
+The body should go into detail about changes made.
+
+The footer should contain any issue references or actions.
+You can use one or several of the following:
+
+- Resolves: #XYZ
+- Related: #XYZ
+- Documentation: #XYZ
+- Releases: XYZ
+
+The Documentation field should be included in every new feature commit, and it
+should link to an issue in the bug tracker where the new feature is analyzed
+and documented.
+
+For a full example of how to write a good commit message, check out
+https://github.com/sparkbox/how_to/tree/master/style/git
diff --git a/docs/leap-flake8.pre-commit.hook b/docs/leap-flake8.pre-commit.hook
new file mode 100755 (executable)
index 0000000..b00fd08
--- /dev/null
@@ -0,0 +1,7 @@
+#!/bin/sh
+# Auto-check for pep8 so I don't check in bad code
+FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -e '\.py$')
+
+if [ -n "$FILES" ]; then
+    flake8 -r $FILES
+fi
diff --git a/docs/man/bitmask-root.1.rst b/docs/man/bitmask-root.1.rst
new file mode 100644 (file)
index 0000000..b25a336
--- /dev/null
@@ -0,0 +1,74 @@
+============
+bitmask-root
+============
+
+------------------------------------------------------------------------
+privileged helper for bitmask, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: LEAP Encryption Access Project https://leap.se
+:Date:   2015-11-03
+:Copyright: GPLv3+
+:Version: 0.9.1
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+bitmask-root [openvpn | firewall | version] [start | stop | isup] [ARGS]
+
+DESCRIPTION
+===========
+
+*bitmask-root* is a privileged helper for bitmask.
+
+It is used to start or stop openvpn and the bitmask firewall. To operate, it
+needs to be executed with root privileges.
+
+
+OPTIONS
+=======
+
+openvpn
+--------
+
+**start** [ARGS]       Starts openvpn. All args are passed to openvpn, and
+                       filtered against a list of allowed args. If the next
+                       argument is `restart`, the firewall will not be torn
+                       down in the case of errors launching openvpn.
+
+**stop**               Stops openvpn.
+
+
+firewall
+--------
+
+**start** [GATEWAYS]   Starts the firewall. GATEWAYS is a list of EIP
+                       gateways to allow in the firewall.
+
+**stop**               Stops the firewall.
+
+**isup**               Check if the firewall is up.
+
+
+fw-email
+--------
+
+**start** UID          Starts the email firewall. UID is the user name or unix
+                       id that will have access to the email.
+
+**stop**               Stops the email firewall.
+
+**isup**               Check if the email firewall is up.
+
+version
+--------
+
+**version**             Prints the `bitmask-root` version string.
+
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code/projects/report-issues
diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst
new file mode 100644 (file)
index 0000000..0970b44
--- /dev/null
@@ -0,0 +1,111 @@
+=======
+bitmask
+=======
+
+------------------------------------------------------------------------
+graphical client to control LEAP, the encrypted internet access toolkit.
+------------------------------------------------------------------------
+
+:Author: The LEAP Encryption Access Project https://leap.se
+:Date:   2015-11-03
+:Copyright: GPLv3+
+:Version: 0.9.1
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+bitmask [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]]
+
+DESCRIPTION
+===========
+
+*bitmask* is a graphical client to control LEAP, the encrypted internet access toolkit.
+
+When launched, it places an icon in the system tray from where the LEAP services can be controlled.
+
+
+OPTIONS
+=======
+
+general options
+---------------
+
+**-h, --help**                  Print a help message and exit.
+
+**-l, --logfile=<file>**        Writes log to file. 
+
+**-s, --standalone**          Makes Bitmask use standalone directories for configuration and binary searching.
+
+**-V, --version**             Displays Bitmask version and exits.
+
+
+openvpn options
+---------------
+
+**--openvpn-verbosity** [0-5]   Verbosity level for openvpn logs.
+
+debug options
+-------------
+**-d, --debug**                 Launches client in debug mode, writing debug info to stdout.
+
+**--danger**                    Bypasses the certificate check for bootstrap. This open the possibility of MITM attacks, so use only to debug providers in controlled environments, and never in production.
+
+ENCRYPTED MAIL
+==============
+
+Bitmask now (since version 0.3.0) supports the encrypted mail service with providers that offer it.
+
+Mail client configuration
+-------------------------
+
+To be able to use the mail services, you should configure your mail client to
+talk to the following ports:
+
+**STMP**:                       localhost:2013
+
+**IMAP**:                       localhost:1984
+
+For the time being, we have successfully tested this functionality in thunderbird.
+
+Mail poll period
+----------------
+
+If you want to change the default polling time for fetching mail, you can use
+a environment variable: BITMASK_MAILCHECK_PERIOD
+
+WARNING
+=======
+
+This software is still in its early phases of testing. So don't trust your life to it! 
+
+
+FILES
+=====
+
+
+/usr/share/polkit-1/actions/se.leap.bitmask.policy
+-------------------------------------------------------
+
+PolicyKit policy file, used for granting access to bitmask-root without the need of entering a password each time.
+
+/usr/sbin/bitmask-root
+------------------------
+
+Helper to launch and stop openvpn and the bitmask firewall.
+
+~/.config/leap/
+---------------
+
+Main config folder
+
+~/.config/leap/leap.conf
+------------------------
+
+GUI options
+
+BUGS
+====
+
+Please report any bugs to https://leap.se/code/projects/report-issues
diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki
new file mode 100644 (file)
index 0000000..95ff220
--- /dev/null
@@ -0,0 +1,90 @@
+= Bitmask Release Checklist =
+
+  == CI check ==
+  * [ ] Check that all tests are passing!
+  * [ ] Fix any broken tests.
+
+  == Version bumps and Tagging ==
+  * [ ] Update pkg/next-release
+  * [ ] Update release-notes.rst in leap.bitmask if needed.
+  * [ ] Update version in bitmask_client/pkg/linux/bitmask-root if needed.
+  
+  * [ ] Tag everything. Should be done for the following packages, in order:
+      * [ ] 1. leap.common
+      * [ ] 2. leap.keymanager
+      * [ ] 3. leap.soledad
+      * [ ] 4. leap.mail
+      * [ ] 5. leap.bitmask
+      * [ ] 6. leap.mx
+
+    * NOTE: It's assumed that origin is the leap.se repo
+     
+    * [ ] git fetch origin
+    * [ ] git tag -l, and see the latest tagged version (unless it's not a minor version bump, in which case, just bump to it)
+    * [ ] export version: export RELEASE=0.9.0
+    * [ ] git checkout `release/0.9.x`
+       - NOTE: the release branch is created when the first release candidate
+         is tagged, after that the bugfixes and features that are meant to be
+         shipped with the specific version that we are targetting are merged in that branch
+    * [ ] git checkout -b release/$RELEASE (this is a LOCAL branch, never published).
+       * [ ] (maybe) cherry-pick specific commits
+       * [ ] (maybe) add special fixes for this release
+
+    * [ ] Review pkg/requirements.pip for everything, update if needed (that's why the order).
+          - See whatever has been introduced in changes/VERSION_COMPAT
+          - Reset changes/VERSION_COMPAT
+          - Bump all the leap-requirements altogether.
+    * [ ] git commit -am "Update requirements file"
+
+    * [ ] Merge changes/next-changelog.rst into the CHANGELOG
+          - NOTE: in leap.soledad, 3 sections (common, client, server).
+    * [ ] reset changes/next-changelog.rst
+    * [ ] git commit -S -m "[pkg] Update changelog"
+
+    * [ ] git tag --sign $RELEASE -m "Tag version $RELEASE"
+
+    * If everything went ok, push the changes, and merge back into master&develop:
+       * [ ] git checkout release/0.9.x && git merge $RELEASE
+       * [ ] git push origin release/0.9.x
+        * [ ] git push origin $RELEASE
+       * [ ] git checkout master && git pull origin master && git merge --no-edit $RELEASE
+       * [ ] git checkout develop && git merge $RELEASE && git push origin develop
+
+  == Bundles ==
+  * [ ] Build and upload bundles
+    * [ ] Use 'make pyinst-linux' to build bundles.
+    * [ ] Sign: make pyinst-sign
+    * [ ] Upload bundle and signature to downloads.leap.se/client/<os>/Bitmask-<os>-<ver>.(tar.bz2,dmg,zip)
+      * [ ] make pyinst-upload
+    * [ ] Update symbolic link for latest upload and signature:
+       * [ ] ~/public/client/Bitmask-<os>-latest
+       * [ ] ~/public/client/Bitmask-<os>-latest.asc
+
+    === TUF: Relese candidate bundles: RC# (skipped for now) ===
+       * [ ] Upload the TUF unstable repo
+       * [ ] Upload bundle to staging for release-candidate
+       * [ ] Sign the bundles, move it to client downloads (micah)
+       * [ ] Update symlinks for -latest
+       * [ ] Fix all show stoppers
+
+    === TUF: Stable bundles (skipped for now) ===
+       * [ ] Upload the TUF Stable Repo to staging
+       * [ ] Upload bundle to staging for stable
+       * [ ] move and sign the TUF repo (kwadro)
+       * [ ] Sign the bundles, move it to client downloads (micah)
+       * [ ] Update symlinks for -latest
+  
+  == Debian packages ==
+  * TBD...
+  
+  == Pypi upload ==
+  * [ ]  python setup.py sdist upload --sign -i kali@leap.se -r pypi
+
+  == Announcing ==
+  * [ ] Announce (use release-notes.rst)
+    * [ ] Mail leap@lists.riseup.net
+    * [ ] Twitter
+    * [ ] Gnusocial
+    * [ ] Post in leap.se
+    * [ ] reddit
+    * [ ] hackernews
diff --git a/docs/testing-rcs.README b/docs/testing-rcs.README
new file mode 100644 (file)
index 0000000..b0340f0
--- /dev/null
@@ -0,0 +1,35 @@
+Tips for QA
+------------
+
+From time to time, we'll ask the community for help testing a new alpha release
+or a release candidate. Normally, we'll offer a link for the download of a
+self-contained bundle just for internal testing purposes. These will be updated
+quite often, as soon as there are fixes available to fix the release-critical
+bugs.
+
+If you want to give a hand in this process, please follow the following tips:
+
+- Focus all your efforts, if possible, on whatever is *the* golden distro at
+  the time of the release.  This currently is: Ubuntu 14.04.x LTS, 64bits, with
+Unity as the default desktop environment.
+  It's very important to have a reference environment as bug-free as possible,
+  before trying to solve issues that are present in other distributions or window
+  managers.
+- Identify all issues that need help in the QA phase. You can do that going to
+  the bug tracker, and filtering all the issues for a given release that are in
+  the QA state.
+- If the issue is solved in your tests for this alpha release, please add a
+  comment to the issue stating the results of your tests, and the platform and
+  desktop environment in which your tests took place.  But please do not change
+  the QA status on the issue. We generally leave this role to the author of the
+  original issue, or to the person playing the role of the release QA master.
+- Always test with a newly created account (specially relevant when testing
+  email candidates)
+- Always test with the reference Mail User Agent (currently, Thunderbird, in
+  whatever version is present in the reference distribution).
+- Remove also any thunderbird configuration, start a freshly configured account.
+- If you find a new bug, please make sure that it hasn't already been reported
+  in the issue tracker. If you are absolutely certain that you have found a new
+  bug, please attach a log of a new bitmask session, which should contain
+  *only* the behaviour needed to reproduce the bug you are reporting.
+
diff --git a/pkg/tools/check_code.sh b/pkg/tools/check_code.sh
new file mode 100755 (executable)
index 0000000..7bbd91f
--- /dev/null
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# Escape code
+esc=`echo -en "\033"`
+
+# Set colors
+cc_green="${esc}[0;32m"
+cc_red="${esc}[0;31m"
+cc_normal=`echo -en "${esc}[m\017"`
+
+
+[[ -z "$1" ]] && WHERE='src/leap/bitmask' || WHERE=$1
+
+PEP8="pep8 --ignore=E202,W602 --exclude=*_rc.py,ui_*,_version.py $WHERE"
+echo "${cc_green}$PEP8${cc_normal}"
+$PEP8
+
+echo
+FLAKE8="flake8 --ignore=E202,W602 --exclude=*_rc.py,ui_*,_version.py $WHERE"
+echo "${cc_green}$FLAKE8${cc_normal}"
+$FLAKE8
+
+echo
+echo "${cc_green}Looking for 'print's, no prints in code, use logging/twisted.log.${cc_normal}"
+echo `git grep -n "print " | wc -l` 'coincidences.'
+
+echo
+echo "${cc_green}Grepping for 'pdb' code left behind.${cc_normal}"
+git grep -n "pdb"
+
+echo
+echo "${cc_green}Grepping for 'XXX|TODO|FIXME|NOTE|HACK'.${cc_normal}"
+echo `git grep -E "XXX|TODO|FIXME|NOTE|HACK" | wc -l` 'coincidences.'
diff --git a/pkg/tools/filter-bitmask-deps b/pkg/tools/filter-bitmask-deps
new file mode 100755 (executable)
index 0000000..9808d39
--- /dev/null
@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+"""
+Filter bitmask dependencies.
+
+Usage: pipdeptree | filter-bitmask-deps
+"""
+import fileinput
+
+TARGET = "leap.bitmask"
+
+
+def get_bitmask_deps(dep_lines):
+    res = []
+    begin = False
+    for dep in dep_lines:
+        if dep.startswith(TARGET):
+            begin = True
+            res.append(dep)
+            continue
+        elif dep.startswith(' ') and begin:
+            res.append(dep)
+            continue
+        if begin:
+            return res
+
+
+if __name__ == "__main__":
+    lines = []
+    for line in fileinput.input():
+        lines.append(line)
+
+    bitmask_deps = get_bitmask_deps(lines)
+    for line in bitmask_deps:
+        print line[:-1]
diff --git a/pkg/tools/get_authors.sh b/pkg/tools/get_authors.sh
new file mode 100755 (executable)
index 0000000..0169bb1
--- /dev/null
@@ -0,0 +1,2 @@
+#!/bin/sh
+git log --format='%aN <%aE>' | awk '{arr[$0]++} END{for (i in arr){print arr[i], i;}}' | sort -rn | cut -d' ' -f2-
diff --git a/pkg/tools/monitor_resource.zsh b/pkg/tools/monitor_resource.zsh
new file mode 100755 (executable)
index 0000000..ac468e3
--- /dev/null
@@ -0,0 +1,26 @@
+#!/bin/zsh
+if (( ! $# )); then
+    echo "Usage: $0:t <PID> <minutes to monitor>" >&2
+    return 1;
+fi
+
+OUT="$1-usage.data"
+GRAPH="bitmask-resources.png"
+MAX=150
+let "ticks=$2*60/3"
+echo "cpu mem" >> $OUT
+for i in {1..$ticks}; do;
+    cpu=$(ps -p $1 -o pcpu | grep -v %)
+    mem=$(ps wuh -p $1 | awk '{print $4}')
+    echo "$cpu $mem" >> $OUT;
+    sleep 3;
+    echo $i / $ticks;
+done;
+
+gnuplot -e "set term dumb; \
+set key outside; set yrange [0:$MAX]; \
+plot for [col=1:2] '$OUT' using 0:col title columnheader s c"
+
+gnuplot -e "set term png; set output '$GRAPH'; \
+set key outside; set yrange [0:$MAX]; \
+plot for [col=1:2] '$OUT' using 0:col with lines title columnheader"
diff --git a/release-notes.rst b/release-notes.rst
new file mode 100644 (file)
index 0000000..2fc1f9e
--- /dev/null
@@ -0,0 +1,38 @@
+0.9.2 April XY - "Panis et Circenses"
++++++++++++++++++++++++++++++++++++++
+
+We are pleased to announce the Bitmask 0.9.2 release.  You can refer to `the
+changelog`_ for the whole changeset.
+
+In addition to the Encrypted Internet Proxy, the Encrypted Email service is now
+available, in Beta state in the Linux bundles. An alpha version for OSX is also
+ready. This service can be tested against any LEAP provider that has made it
+publicly available.
+
+The "Beta" in the Email service means that things are getting more stable, but
+unforeseen issues are still expected to be found, so please use it accordingly.
+We need you to test it as hard as you can, and report any bugs that you find,
+but don't trust it yet in situations where data loss, delivery problems or any
+other errors can put you at risk or otherwise cause major trouble.
+
+Currently we maintain a demo provider for the Mail service at
+https://mail.bitmask.net. This provider is already pinned in Bitmask for easy
+access when creating a new account from within the wizard.
+
+In the standalone bundles beginning with 0.9.2, we are shipping the Pixelated
+Webmail interface. Access via Thunderbird or any other mail client of your
+choice is still supported, but we hope that this modern web interface will make
+the delights of our users.
+
+The bundles for 0.9.2 include statically compiled binaries for OpenVPN 2.3.10
+(compiled against PolarSSL 1.3.9) and GnuPG 1.4.20.
+
+Please help us test Bitmask and file any bug reports here:
+https://leap.se/code/projects/report-issues, that will be a great contribution
+towards future improvement!
+
+Until the next release, see you on the intertubes, and stay safe.
+
+The Bitmask team.
+
+.. _`the changelog`: https://github.com/leapcode/bitmask_client/blob/0.9.2/CHANGELOG.rst