M .bugs/bugs +1 -1
@@ 17,7 17,7 @@ add a -e flag to add to launch details e
Use consistent EOL markers and set up a .hgeol file | owner:Michael, open:False, id:884b4c3360aa89bbd841013a6cf34bc904dcc3b5, time:1313353463.53
Add optional commented out fields to default details file | owner:Michael, open:False, id:9ce51de4c80014f8cf09e97041a8ae1d9cc001e4, time:1324634131.06
Bugs with no details but a details file should act like there is not details file | owner:Michael, open:False, id:9f771c1b687a119eb8e6f9a8443f2c0dde30776b, time:1277680715.42
-edit doesn't handle editors with spaces properly | owner:Michael, open:False, id:aad16b3f42cade7b71eb1cc92c490f77c7366084, time:1310458238.24
+edit doesn't handle editors with spaces properly | owner:Michael, open:True, id:aad16b3f42cade7b71eb1cc92c490f77c7366084, time:1310458238.24
Support assigning multiple bugs at once | owner:, open:True, id:ab2e474b9120ae940fd40cd2b449771788c6397e, time:1350788263.28
adding a long issue rewrites entire bugs file to align metadata | owner:Michael, open:False, id:b2f52086a6ca25bc3f9c131e8ded23d474b9a11d, time:1319079486.17
Don't add unchanged details files | owner:, open:True, id:c91d45eda3bbba622a060b763a4e5afe2f3b2cb9, time:1350783561.08
M .bugs/details/aad16b3f42cade7b71eb1cc92c490f77c7366084.txt +4 -1
@@ 13,6 13,9 @@ I think b is executing the editor comman
It works with ``EDITOR=emacsclient``.
Reported by Takafumi Arakaki
+The naive solution obviously doesn't work, but the shlex module should offer more robust support:
+http://stackoverflow.com/questions/899276/python-how-to-parse-strings-to-look-like-sys-argv
+
[expected]
# The expected result
@@ 26,4 29,4 @@ Reported by Takafumi Arakaki
[comments]
-# Comments and updates - leave your name
No newline at end of file
+# Comments and updates - leave your name
A => LICENSE +674 -0
@@ 0,0 1,674 @@
+ 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>.
M src/README => README.md +310 -261
@@ 1,271 1,320 @@
-# README - Documentation for b, a distributed bug tracker extension for Mercurial
-#
-# Copyright 2010-2011 Michael Diamond <michael@digitalgemstones.com>
-#
-# This software may be used and distributed according to the terms of the
-# GNU General Public License version 2 or any later version.
-# http://www.gnu.org/licenses/licenses.html
-# http://www.gnu.org/licenses/gpl.html
+# `b`, a distributed bug tracker extension for Mercurial
Version 0.6.0
-Introduction:
-
- Based off and built using Steve Losh's brilliantly simple task manager t
- (http://stevelosh.com/projects/t/) the fundamental principle is
- 'Get things done, not organized', and tries to follow t's message,
- "the only way to make your bug list prettier is to fix some damn bugs."
-
- That said, b has many powerful additions to t, without any of the bloat
- and burden of setting up, maintaining, or using a traditional bug tracker.
-
- You can use b exactly like t, add, rename, resolve, and list work almost
- exactly like t out of the box, with the added benefit that wherever you are in
- a repository, you maintain a single bugs database in the root of the repository.
-
- But you can do more with b. You can reopen issues, the edit, details, and
- comment commands allow you to track additional information about the bugs,
- like stack traces and expected results, and whatever other information you'd
- like. The details file is a plain text file, and can contain any content you desire.
-
- You can also assign bugs to specific individuals - either based on their
- Mercurial commit names or not - and list lets you filter by owner to see what
- tasks are in your care.
-
- b is powerful enough to support several different workflow complexities,
- from an individual just tracking tasks in a repository, all the way up to a
- small, distributed team of managers and developers who need to be able to
- report, manage, and assign bugs, tasks, and issues, share details, and
- express their opinions.
-
- However, b is not intended to be be a replacement for large scale
- bug trackers like Jira, Bugzilla, and the upcoming Bugs
- Everywhere. Most notably, (at present) b is just a command line
- tool. There is no centralized bug list or web access (though the
- site extension (http://draketo.de/proj/hgsite) parses b bugs into
- a static website), nor any GUI interface, and many of the features
- in such larger projects are lacking, notably any kind of warning
- or notification when a bug is reassigned, and the ability to
+## Introduction:
+
+Based off and built using Steve Losh's brilliantly simple task manager
+[`t`](http://stevelosh.com/projects/t/) the fundamental principle is
+'Get things done, not organized', and tries to follow `t`'s message,
+"the only way to make your bug list prettier is to fix some damn bugs."
+
+That said, `b` has many powerful additions to `t`, without any of the bloat
+and burden of setting up, maintaining, or using a traditional bug tracker.
+
+You can use `b` exactly like `t`, add, rename, resolve, and list work almost
+exactly like `t` out of the box, with the added benefit that wherever you are in
+a repository, you maintain a single bugs database in the root of the repository.
+
+But you can do more with `b`. You can reopen issues, the edit, details, and
+comment commands allow you to track additional information about the bugs,
+like stack traces and expected results, and whatever other information you'd
+like. The details file is a plain text file, and can contain any content you desire.
+
+You can also assign bugs to specific individuals - either based on their
+Mercurial commit names or not - and list lets you filter by owner to see what
+tasks are in your care.
+
+`b` is powerful enough to support several different workflow complexities,
+from an individual just tracking tasks in a repository, all the way up to a
+small, distributed team of managers and developers who need to be able to
+report, manage, and assign bugs, tasks, and issues, share details, and
+express their opinions.
+
+However, `b` is not intended to be be a replacement for large scale
+bug trackers like Jira, Bugzilla, and the upcoming Bugs Everywhere. Most
+notably, (at present) `b` is just a command line tool. There is no
+centralized bug list or web access, nor any GUI interface, and many of the
+features in such larger projects are lacking, notably any kind of warning or
+notification when a bug is reassigned, and the ability to categorize bugs and
+to provide resolution reasons, like fixed or duplicate - of course these could
+all be done manually, but there is no such built in functionality.
categorize bugs and to provide resolution reasons, like fixed or
duplicate - of course these could all be done manually, but there
is no such built in functionality.
-
- If you need the power of something like Bugzilla, you're going to find b
- limited. However if you find many of the extra "features" in these larger
- tools to be unhelpful bloat, and you don't want to waste time organizing,
- categorizing, and sorting and instead want a quick, easy way to track issues
- with your project with minimal setup and configuration, then b is the tool to use!
+
+If you need the power of something like Bugzilla, you're going to find `b`
+limited. However if you find many of the extra "features" in these larger
+tools to be unhelpful bloat, and you don't want to waste time organizing,
+categorizing, and sorting and instead want a quick, easy way to track issues
+with your project with minimal setup and configuration, then `b` is the tool to use!
+
+### Some Suggested Use Cases:
+
+A single developer, working on a small project, can turn that into a version
+controlled project with a simple 'hg init'. With `b` installed, he (or she) also
+gets a fully functional bug tracker to boot, no additional setup required!
+As soon as you install `b`, every repository on your machine now has issue
+tracking functionality ready to use.
+
+Working on a website, you could very easily (and I might do this myself
+soon enough) write a little PHP script which takes bug reports and
+logs them to `b`. I often find the closer to my workflow a tool is
+the easier it is to use, so integrating it right into the website
+makes a lot of sense.
+
+Working on a small project with a few other team members is ideal for `b`,
+it's powerful enough to let everyone track what they need to do, and allow
+everyone to contribute what they can to any of the bugs on file. They can
+search titles for matching bugs, and even grep through the details directory
+to find details matching what they're looking for.
-Some Suggested Use Cases:
+Working on a larger project with lots of team members starts getting questionable,
+as many of the powerful features larger projects provide start to really show
+their worth. However in my experience several large companies I've worked for
+or with have drastically underutilized the power of their bug trackers, to the
+point where all the complexity and extra metadata is just wasted space and fluff.
+That's not to say that `b` is necessarily a good alternative for a large company,
+but it's worth asking yourself if you really benefit from all the extra tools;
+many organizations could get by just fine with the features `b` provides.
+
+## Installing `b`:
+
+Like any Mercurial Extension, to install `b` edit a Mercurial config file
+and add the following:
+
+ [extensions]
+ b=/path/to/b.py
+
+See the Mercurial wiki (http://mercurial.selenic.com/wiki/UsingExtensions)
+for more details on installing extensions.
+
+`b` is a zero-configuration tool - as soon as it is installed, every single
+repository is ready to start tracking issues, without any additional setup.
+You may find it helpful to specify a username for yourself in your `~/.hgrc`
+file, however this is absolutely not necessary to work with `b`.
+
+## Config Options:
+
+`b` has two configuration settings, both of which are optional, and should
+be put in the `[bugs]` section of any Mercurial config file.
+
+* `user`
+
+ You can specify a user name for bug tracking, or 'hg.user' if you wish
+ to use your commit name. The bug tracker will work absolutely fine
+ without this setting, but it is recommended if you will be working
+ with multiple people.
+
+* `dir`
- A single developer, working on a small project, can turn that into a version
- controlled project with a simple 'hg init'. With b installed, he (or she) also
- gets a fully functional bug tracker to boot, no additional setup required!
- As soon as you install b, every repository on your machine now has issue
- tracking functionality ready to use.
-
- Working on a website, you could very easily (and I might do this myself
- soon enough) write a little PHP script which takes bug reports and
- logs them to b. I often find the closer to my workflow a tool is
- the easier it is to use, so integrating it right into the website
- makes a lot of sense.
-
- Working on a small project with a few other team members is ideal for b,
- it's powerful enough to let everyone track what they need to do, and allow
- everyone to contribute what they can to any of the bugs on file. They can
- search titles for matching bugs, and even grep through the details directory
- to find details matching what they're looking for.
-
- Working on a larger project with lots of team members starts getting questionable,
- as many of the powerful features larger projects provide start to really show
- their worth. However in my experience several large companies I've worked for
- or with have drastically underutilized the power of their bug trackers, to the
- point where all the complexity and extra metadata is just wasted space and fluff.
- That's not to say that b is necessarily a good alternative for a large company,
- but it's worth asking yourself if you really benefit from all the extra tools;
- many organizations could get by just fine with the features b provides.
+ Allows you to specify (relative to the repo root) where the bugs
+ database should go. The default is '.bugs'
+
+Using `b`:
+
+You're encouraged to read the documentation on [`t`](http://stevelosh.com/projects/t/)
+before using `b` - much of the functionality and usage philosophy of `t` is
+carried over here.
+
+All `b` commands take the form `hg b command [options/parameters]`. You
+can see a full list and command signatures by running `hg help b`.
+
+When you're anywhere within a repository with the `b` extension enabled
+you can use `b`. To file a new bug, all you have to do is say:
+
+ % hg b add 'This is a new bug'
+
+And you can confirm it's been added by calling:
+
+ % hg b list
+
+Which will show you your new bug, along with an ID to refer to it by. These
+IDs are actually prefixes of the full bug ID, and will get longer as more bugs
+are added. If you need a permanent reference to a bug, you can pass a prefix to
+
+ % hg b id ID
+
+This will return the full ID of the bug. You'll likely only ever need the first
+eight or so characters - a database of 20,000+ bugs only used the first four or five
+in most cases.
+
+To rename a bug, you can call:
+
+ % hg b rename ID 'NEW NAME HERE'
-Installing b:
-
- Like any Mercurial Extension, to install b edit a Mercurial config file
- and add the following:
-
- [extensions]
- b=/path/to/b.py
-
- See the Mercurial wiki (http://mercurial.selenic.com/wiki/UsingExtensions)
- for more details on installing extensions.
-
- b is a zero-configuration tool - as soon as it is installed, every single
- repository is ready to start tracking issues, without any additional setup.
- You may find it helpful to specify a username for yourself in your ~/.hgrc
- file, however this is absolutely not necessary to work with b.
+And like `t`'s edit command, you can use sed style replacements if you so desire.
+
+When you're finished with a bug, simply call
+
+ % hg b resolve ID
+
+and it will be marked resolved and no longer (by default) show up in your bug list.
+Use 'reopen' in the same fashion if you decide to reopen a closed bug.
+
+If you need to record more detail than just a title, edit
+
+ % hg b edit ID
+
+will launch your default commit editor with a pre-populated set of sections you can
+fill out. Nothing is mandatory, and you can create or delete new sections as you'd
+like. Comments (see below) are appended to the end of the file, so it is suggested
+you leave the comments section last.
+
+To view the details of a bug you call:
+
+ % hg b details ID
+
+This provides some basic metadata like date filed and owner, along with the contents
+of the details file, if it exists. Any sections (denoted by text in square brackets)
+which are empty are not displayed by the details command to simplify the output.
+
+If you want to add a comment to a bug, like feedback or an update on its status,
+
+ % hg b comment ID 'COMMENT TEXT'
+
+will append your comment to the details file along with the date and, if set,
+your username (see below)
+
+To manage multi-user projects, you can set a bug username (see the Config Options
+section above for how to do that) to associate with bugs, and say something like
-Config Options:
-
- b has two configuration settings, both of which are optional, and should
- be put in the [bugs] section of any Mercurial config file.
-
- user
- You can specify a user name for bug tracking, or 'hg.user' if you wish
- to use your commit name. The bug tracker will work absolutely fine
- without this setting, but it is recommended if you will be working
- with multiple people.
-
- dir
- Allows you to specify (relative to the repo root) where the bugs
- database should go. The default is '.bugs'
-
-Using b:
-
- You're encouraged to read the documentation on t (http://stevelosh.com/projects/t/)
- before using b - much of the functionality and usage philosophy of t is
- carried over here.
-
- All b commands take the form 'hg b command [options/parameters]'. You
- can see a full list and command signatures by running 'hg help b'.
-
- When you're anywhere within a repository with the b extension enabled
- you can use b. To file a new bug, all you have to do is say
- % hg b add 'This is a new bug'
- And you can confirm it's been added by calling:
- % hg b list
- Which will show you your new bug, along with an ID to refer to it by. These
- IDs are actually prefixes of the full bug ID, and will get longer as more bugs
- are added. If you need a permanent reference to a bug, you can pass a prefix to
- % hg b id ID
- This will return the full ID of the bug. You'll likely only ever need the first
- eight or so characters - a database of 20,000+ bugs only used the first four or five
- in most cases.
-
- To rename a bug, you can call:
- % hg b rename ID 'NEW NAME HERE'
- And like t's edit command, you can use sed style replacements if you so desire.
-
- When you're finished with a bug, simply call
- % hg b resolve ID
- and it will be marked resolved and no longer (by default) show up in your bug list.
- Use 'reopen' in the same fashion if you decide to reopen a closed bug.
-
- If you need to record more detail than just a title, edit
- % hg b edit ID
- will launch your default commit editor with a pre-populated set of sections you can
- fill out. Nothing is mandatory, and you can create or delete new sections as you'd
- like. Comments (see below) are appended to the end of the file, so it is suggested
- you leave the comments section last.
-
- To view the details of a bug you call:
- % hg b details ID
- This provides some basic metadata like date filed and owner, along with the contents
- of the details file, if it exists. Any sections (denoted by text in square brackets)
- which are empty are not displayed by the details command to simplify the output.
-
- If you want to add a comment to a bug, like feedback or an update on its status,
- % hg b comment ID 'COMMENT TEXT'
- will append your comment to the details file along with the date and, if set,
- your username (see below)
-
- To manage multi-user projects, you can set a bug username (see the Config Options
- section above for how to do that) to associate with bugs, and say something like
- % hg b assign ID 'John Cleese'
- If the specified username can't be found in the database, you'll be prompted to
- confirm that is the name you want to use, with the '-f' flag. For ease of
- assigning bugs, you can use a prefix of a user's name, and as long as it's not
- ambiguous, b will assign it to the matching username, and let you know
- who it was ultimately assigned to so you can double check. Assuming no other
- users named John, calling:
- % hg b assign ID john
- would have the same effect as the call above. The special name 'me' will
- assign the bug to your username, and the special name 'Nobody' will mark the bug
- as unassigned.
-
- To see a list of all users b is currently aware of, and the number of open
- bugs assigned to them, you can call:
- % hg b users
-
- Finally, list has some advanced functionality that's worth knowing. First
- the '-r' flag will list resolved bugs, instead of open bugs. The -o flag
- takes a username (or a username prefix) and lists bugs owned by the specified
- user. The -g flag will list bugs which contain the specified text in their
- title. You can use the -a flag to sort issues alphabetically, and the -c
- flag to sort them chronologically. These flags can be used together for
- fairly granular browsing of your bugs database. In addition, you can use
- the -T flag to truncate output that would otherwise overflow beyond one line.
-
-
- The read-only commands (list, details, users, and id) have an additional --rev
- option that can be used to run that command against a committed revision of the bug
- database. To see the list of issues open at the time of this release, for
- instance, you could run 'hg b list --rev 6.0-rc-2'
-
-FAQ:
- How well does b scale?
- Basic benchmarks indicate that b performs well even with very large lists.
- test bug lists of more than 50,000 records have been constructed and b
- responds very quickly, taking just a second or two to add a record,
- and even less time to list bugs, especially filtering by owner or by
- grep. Of course, you would have to work very hard to ever reach a bug
- list even close to that number, and long before you get there you'll
- likely discover you need to switch to something more powerful, so for
- all intents and purposes b should handle everything you can throw at it.
-
- I would really like to be able to categorize my bugs, or detail how the bug
- was resolved, why isn't that possible?
- b is philosophically opposed to tracking this sort of data, and is not
- trying to replace large scale, metadata driven bug trackers.
- If you find yourself wishing it had these sorts of features, you may
- very well be looking at the wrong product. However, you could certainly
- add such data to the details file, or add flags like P1 or BLOCKING to
- issue titles if you felt the need to do so. Users have reported finding
- this workflow - combined with list's -g flag, fairly satisfactory.
-
- Can I use standard Mercurial commands inside the .bugs directory?
- Absolutely. Everything in the .bugs directory is a standard text file,
- enabling easy merging, diffing, grepping, annotating, browsing, and data
- mining. If you feel so inclined, you can even edit any of the files in
- the .bugs directory manually.
-
- Why doesn't b commit my changes?
- b does not commit after bugs are filed or changed intentionally.
- The hope is that b acts completely transparently to the underlying
- repository, and that commits are never solely about bugs (unless the
- user chooses so). This allows the repository structure and the commit
- messages to remain concerned with the source code, and not have it fill
- up with uninformative messages about every little thing you do with b.
- It does however automatically add everything located in the bugs directory
- so you shouldn't have to worry about ever leaving anything untracked.
- Be careful that you don't accidentally check in .orig or .rej files that
- Mercurial sometimes creates in the bugs directory, they would also be
- added automatically.
-
- Is b ever going to work with other DVCS?
- b was built to be as compartmentalized from the Mercurial API
- calls as possible, and while there are no plans at present to
- expand b to work with other DVCS, the structure to do so exists.
-
- Does b work with unicode or other encodings beyond ASCII?
- There is an open bug (bug 286b) to improve b's handling of
- non-ASCII character sets, however at present you may run into trouble
- tracking issues in other languages or encodings. Ensuring that
- issues created and updated in arbitrary encodings continue to be
- editable and viewable on machines with other encodings is a
- non-trivial task, and likely cannot be fully resolved until
- a future release of Mercurial provides more robust encoding
- transformation utilities. Patches to improve this issue are
- very welcome.
-
- Can I use b in a corporate environment?
- b is released under GPL2+ so yes, you may. However you may
- not distribute b or any derived works under any other license
- than the GPL2+. If you're unsure of what you can or cannot do,
- there's lots of information on the details of this license online,
- and you are welcome to contact me with questions.
-
- I have an idea for a feature, or a bug to report, what should I do?
- b is released as open source software, so experiment, make or
- fix it yourself if you feel so inclined. You're also welcome
- to email me with suggestions, questions or code changes. Or
- even pull the repository, file a bug there, and serve it up
- somewhere for me to pull it back! How's that for dogfooding?
-
-I hope you find b useful!
+ % hg b assign ID 'John Cleese'
+
+If the specified username can't be found in the database, you'll be prompted to
+confirm that is the name you want to use, with the '-f' flag. For ease of
+assigning bugs, you can use a prefix of a user's name, and as long as it's not
+ambiguous, `b` will assign it to the matching username, and let you know
+who it was ultimately assigned to so you can double check. Assuming no other
+users named John, calling:
+
+ % hg b assign ID john
+
+would have the same effect as the call above. The special name 'me' will
+assign the bug to your username, and the special name 'Nobody' will mark the bug
+as unassigned.
+
+To see a list of all users `b` is currently aware of, and the number of open
+bugs assigned to them, you can call:
+
+ % hg b users
+
+Finally, `list` has some advanced functionality that's worth knowing.
+
+
+* `-r` will list resolved bugs, instead of open bugs.
+* `-o` takes a username (or a username prefix) and lists bugs owned by the
+ specified user.
+* `-g` will list bugs which contain the specified text in their title.
+* `-a` will sort issues alphabetically, and
+* `-c` will sort them chronologically.
+
+These flags can be used together for fairly granular browsing of your
+bugs database. In addition, you can use the `-T` flag to truncate
+output that would otherwise overflow beyond one line.
+
+
+The read-only commands (`list`, `details`, `users`, and `id`) have an additional `--rev`
+option that can be used to run that command against a committed revision of the bug
+database. To see the list of issues open at the time of this release for
+instance, you could run
+
+ hg b list --rev 6.0-rc-2
+
+## FAQ:
+
+* How well does `b` scale?
+
+ Basic benchmarks indicate that `b` performs well even with very large lists.
+ test bug lists of more than 50,000 records have been constructed and `b`
+ responds very quickly, taking just a second or two to add a record,
+ and even less time to list bugs, especially filtering by owner or by
+ grep. Of course, you would have to work very hard to ever reach a bug
+ list even close to that number, and long before you get there you'll
+ likely discover you need to switch to something more powerful, so for
+ all intents and purposes `b` should handle everything you can throw at it.
+
+* I would really like to be able to categorize my bugs, or detail how the bug
+ was resolved, why isn't that possible?
+
+ `b` is philosophically opposed to tracking this sort of data, and is not
+ trying to replace large scale, metadata driven bug trackers.
+ If you find yourself wishing it had these sorts of features, you may
+ very well be looking at the wrong product. However, you could certainly
+ add such data to the details file, or add flags like P1 or BLOCKING to
+ issue titles if you felt the need to do so. Users have reported finding
+ this workflow - combined with list's -g flag, fairly satisfactory.
+
+* Can I use standard Mercurial commands inside the `.bugs` directory?
+
+ Absolutely. Everything in the `.bugs` directory is a standard text file,
+ enabling easy merging, diffing, grepping, annotating, browsing, and data
+ mining. If you feel so inclined, you can even edit any of the files in
+ the .bugs directory manually.
+
+* Why doesn't `b` commit my changes?
+
+ `b` does not commit after bugs are filed or changed intentionally.
+ The hope is that `b` acts completely transparently to the underlying
+ repository, and that commits are never solely about bugs (unless the
+ user chooses so). This allows the repository structure and the commit
+ messages to remain concerned with the source code, and not have it fill
+ up with uninformative messages about every little thing you do with `b`.
+ It does however automatically add everything located in the bugs directory
+ so you shouldn't have to worry about ever leaving anything untracked.
+ Be careful that you don't accidentally check in .orig or .rej files that
+ Mercurial sometimes creates in the bugs directory, they would also be
+ added automatically.
+
+* Is `b` ever going to work with other DVCS?
+
+ `b` was built to be as compartmentalized from the Mercurial API
+ calls as possible, and while there are no plans at present to
+ expand `b` to work with other DVCS, the structure to do so exists.
+
+* Does `b` work with unicode or other encodings beyond ASCII?
+
+ There is an open bug (bug 286b) to improve `b`'s handling of
+ non-ASCII character sets, however at present you may run into trouble
+ tracking issues in other languages or encodings. Ensuring that
+ issues created and updated in arbitrary encodings continue to be
+ editable and viewable on machines with other encodings is a
+ non-trivial task, and likely cannot be fully resolved until
+ a future release of Mercurial provides more robust encoding
+ transformation utilities. Patches to improve this issue are
+ very welcome.
+
+* Can I use `b` in a corporate environment?
+
+ `b` is released under GPL2+ so yes, you may. However you may
+ not distribute `b` or any derived works under any other license
+ than the GPL2+. If you're unsure of what you can or cannot do,
+ there's lots of information on the details of this license online,
+ and you are welcome to contact me with questions.
+
+* I have an idea for a feature, or a bug to report, what should I do?
+
+ `b` is released as open source software, so experiment, make or
+ fix it yourself if you feel so inclined. You're also welcome
+ to email me with suggestions, questions or code changes. Or
+ even pull the repository, file a bug there, and serve it up
+ somewhere for me to pull it back! How's that for dogfooding?
+
+I hope you find `b` useful!
+
+## Copyright
+
+Copyright 2010-2012 Michael Diamond
+
+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/>.
No newline at end of file
M src/b.py +18 -13
@@ 39,7 39,10 @@ import os, errno, re, hashlib, sys, subp
from datetime import date, datetime
from operator import itemgetter
from mercurial.i18n import _
-from mercurial import hg,commands
+from mercurial import hg, commands, cmdutil
+
+cmdtable = {}
+command = cmdutil.command(cmdtable)
#
# Version
@@ 600,6 603,20 @@ def _cat(ui,repo,file,todir,rev=None):
#
# Command line processing
#
+@command("b|bug|bugs",
+ [
+ ('f', 'force', False, _('Force this exact username')),
+ ('e', 'edit', False, _('Launch details editor after running command')),
+ ('r', 'resolved', False, _('List resolved bugs')),
+ ('o', 'owner', '*', _('Specify an owner to list by')),
+ ('g', 'grep', '', _('Filter titles by STRING')),
+ ('a', 'alpha', False, _('Sort list alphabetically')),
+ ('c', 'chrono', False, _('Sort list chronologically')),
+ ('T', 'truncate', False, _('Truncate list output to fit window')),
+ ('', 'rev', '', _('Run a read-only command against a different revision'))
+ ],
+ "cmd [args]"
+ )
def cmd(ui,repo,cmd = 'list',*args,**opts):
""" Distributed Bug Tracker For Mercurial
@@ 824,18 841,6 @@ def cmd(ui,repo,cmd = 'list',*args,**opt
ui.warn(_("'%s' is not a read-only command - cannot run against a past revision\n") % e.cmd)
#open=True,owner='*',grep='',verbose=False,quiet=False):
-cmdtable = {"b|bug|bugs": (cmd,[
- ('f', 'force', False, _('Force this exact username')),
- ('e', 'edit', False, _('Launch details editor after running command')),
- ('r', 'resolved', False, _('List resolved bugs')),
- ('o', 'owner', '*', _('Specify an owner to list by')),
- ('g', 'grep', '', _('Filter titles by STRING')),
- ('a', 'alpha', False, _('Sort list alphabetically')),
- ('c', 'chrono', False, _('Sort list chronologically')),
- ('T', 'truncate', False, _('Truncate list output to fit window')),
- ('', 'rev', '', _('Run a read-only command against a different revision'))
- ]
- ,_("cmd [args]"))}
#
# Programmatic access to b