Return-Path: X-Original-To: apmail-incubator-bloodhound-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-bloodhound-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9BFE6EE2C for ; Wed, 23 Jan 2013 21:14:29 +0000 (UTC) Received: (qmail 39183 invoked by uid 500); 23 Jan 2013 21:14:29 -0000 Delivered-To: apmail-incubator-bloodhound-commits-archive@incubator.apache.org Received: (qmail 39158 invoked by uid 500); 23 Jan 2013 21:14:29 -0000 Mailing-List: contact bloodhound-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: bloodhound-dev@incubator.apache.org Delivered-To: mailing list bloodhound-commits@incubator.apache.org Received: (qmail 39150 invoked by uid 99); 23 Jan 2013 21:14:29 -0000 Received: from bloodhound-vm.apache.org (HELO bloodhound-vm) (140.211.11.32) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Jan 2013 21:14:29 +0000 Received: from bloodhound-vm.apache.org (localhost [127.0.0.1]) by bloodhound-vm (Postfix) with ESMTP id 1E69F812CD for ; Wed, 23 Jan 2013 21:14:28 +0000 (UTC) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit From: "Apache Bloodhound" X-Trac-Version: 1.0 X-Trac-Wiki-URL: https://issues.apache.org/bloodhound/wiki/Proposals/BEP-0005 Cc: bloodhound-commits@incubator.apache.org Auto-Submitted: auto-generated X-Mailer: Trac 1.0, by Edgewall Software X-Trac-Project: Apache Bloodhound Date: Wed, 23 Jan 2013 21:14:28 -0000 Reply-To: bloodhound-dev@incubator.apache.org X-URL: https://issues.apache.org/bloodhound/ Subject: [Apache Bloodhound] Proposals/BEP-0005 added Message-Id: <20130123211429.1E69F812CD@bloodhound-vm> Page "Proposals/BEP-0005" was added by olemis Comment: [BEP-0005] Initial version with correct headers Content: -------8<------8<------8<------8<------8<------8<------8<------8<-------- = BEP 5 : Plugin upgrades #overview [[PageOutline]] || '''BEP''' || 5 || || '''Title''' || Plugin upgrade facility || || '''Version''' || || || '''Last-Modified''' || || || '''Author''' || José Angel Franco Navarro || || '''Status''' || Draft || || '''Type''' || Standards Track || || '''Content-Type''' || [wiki:PageTemplates/Proposals text/x-trac-wiki] || || '''Created''' || || || '''Post-History''' || || ---- == Abstract #abstract This template provides a boilerplate or sample template for creating your own BEPs. In conjunction with the [wiki:/Proposals general content guidelines] and the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] , this should make it easy for you to conform your own BEPs to the format outlined below. See [#howto How to Use This Template] for further instructions. **Note**: if you are reading this template via the web, you should first try to create a new wiki page by selecting `ProposalsRst` |page template guide|. **DO NOT EDIT THIS WIKI PAGE IN ORDER TO CREATE A NEW BEP! ** If you would prefer not to use WikiFormatting markup in your BEP, please see [wiki:/Proposals/Formats/RestructuredText reStructuredText BEP guidelines]. == Motivation == == Proposal #proposal == Rationale #rationale ''BEP'' submissions come in a wide variety of forms, not all adhering to the format guidelines set forth below. Use this template, in conjunction with the [wiki:/Proposals general content guidelines] and the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines], to ensure that your ''BEP'' submission is easy to read and understand. This template allows to create BEPs and is very similar to [http://www.python.org/dev/peps/pep-0012 PEP 12] . However it has been optimized by moving long explanations to the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] . If you are interested take a look at the [?action=diff&old_version=1 differences]. The goal is to redact new BEPs just by following in-line instructions between angle brackets (i.e. **<** **>**) . Even if this will allow to write BEPs faster , it is highly recommended to read the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] at least once in your lifetime to be aware of good practices and expected style rules . == How to Use This Template #howto Quick edits will consist in following the instructions inside angle brackets (i.e. **<** **>**) . That should be everything needed to write new BEPs. To be more informed about advanced considerations please read the [wiki:/Proposals general content guidelines] and the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] . If there is no point in including one of the sections in this document then feel free to remove it. == Backwards Compatibility #backwards-compatibility == Reference Implementation #reference-implementation < The reference implementation **must** be completed before any ''BEP'' is given status **Final**, but it need not be completed before the ''BEP'' is accepted. It is better to finish the specification and rationale first and reach consensus on it before writing code. The final implementation **must** include test code and documentation appropriate for either the wiki pages in ''Bloodhound'' users guide or an specific wiki page in the [http://issues.apache.org/bloodhound ​issue tracker] . > == Resources #resources See WikiFormatting for more help on the markup used to write wiki pages. == References #references 1. PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton http://www.python.org/dev/peps/pep-0001/ 2. PEP 9, Sample Plaintext PEP Template, Warsaw http://www.python.org/dev/peps/pep-0009 2. PEP 12, Sample reStructuredText ''PEP'' Template, Goodger, Warsaw http://www.python.org/dev/peps/pep-0012/ 3. http://www.opencontent.org/openpub/ == Copyright #copyright Copyright © 2009-2012 The [http://www.apache.org Apache Software Foundation] [[BR]] Licensed under the [http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0]. Apache Bloodhound, Apache, the Apache feather logo, and the Apache Bloodhound project logo are trademarks of The Apache Software Foundation. -------8<------8<------8<------8<------8<------8<------8<------8<-------- -- Page URL: Apache Bloodhound The Apache Bloodhound (incubating) issue tracker This is an automated message. Someone added your email address to be notified of changes on 'Proposals/BEP-0005' page. If it was not you, please report to .