Re: [myhdl-list] MEP guidelines
Brought to you by:
jandecaluwe
Menu
▾
▴
Re: [myhdl-list] MEP guidelines
|
From: Jan D. <ja...@ja...> - 2011-05-10 07:54:52
|
On 05/06/2011 11:07 PM, Christopher Felton wrote: > Sounds good. But what is the process for ammending a MEP? In the > example you provided, how would the MEP documentation be kept upto date > with the implementation? Assuming the implementation diversion had > reasons to change the MEP. I have not stated it explicitly, but, as Guenter inferred, the idea of MEPs was indeed to be for MyHDL what PEPs are for Python, and to reuse the PEP methodology. The PEP infrastructure has all we will ever need, and much more probably. Given our resources, it is too heavy to just copy it as is, but we can use the bits that we need and let it grow as our needs evolve. Case in point: A 'Final' MEP should not be changed (except typo's and language corrections from a neutral proofreader). It is intended to document the language history for experts. The lanugage documentation is in the manuals. > Would a new MEP be created for the changes? New MEP's can be created and existing ones superseded. > There should be a method to add this information and the process should > be added to the text. > > Regards, > Chris > > On 5/6/11 10:03 AM, Günter Dannoritzer wrote: >> Hi, >> >> I would like to suggest, adding some guidelines about the MEP process. >> Seeing that the text of an already implemented MEP got changed, I think >> it would be helpfull to have some guidelines how the MEP process is >> intended. >> >> I think, that especially an already implemented MEP should be kept for >> reference as is and not changed later in time. There is the chance, that >> the original notion of the implementation gets altered by editing the >> MEP it originated from. >> >> My suggestion is to add the text to the MEP introduction page: >> >> http://myhdl.org/doku.php/meps:intro >> >> The text could be based on the Python Enhancement Proposal, found here: >> >> http://www.python.org/dev/peps/pep-0001/ >> >> Here is a first draft for a text. The first paragraphs are a copy of the >> PEP text, changed according to MyHDL: >> >> --------- >> >> >> MEP stands for MyHDL Enhancement Proposal. A MEP is a design document >> providing information to the MyHDL community, or describing a new >> feature for MyHDL. The MEP should provide a concise technical >> specification of the feature and a rationale for the feature. >> >> We intend MEPs to be the primary mechanisms for proposing new features, >> for collecting community input on an issue, and for documenting the >> design decisions that have gone into MyHDL. The MEP author is >> responsible for building consensus within the community and documenting >> dissenting opinions. >> >> MEPs are maintained on the MyHDL wiki page. The page history resembles >> the development history of the document. >> >> Main responsibility of a MEP lies with its author. Before opening a new >> MEP, its idea should be discussed on the MyHDL mailing list. >> >> In the development phase the MEP gets the status "Draft" assigned. Fully >> developed and provided with a functional implementation, the MEP can get >> the status "Final", documenting that the content of the MEP is ready to >> be implemented into MyHDL. >> >> Once the MEP has the status "Final" and its content got added to the >> source code, the MyHDL version will be added to the MEP document. From >> this time, the text of the document will be frozen. >> >> ------------ >> >> >> Cheers, Guenter >> >> ------------------------------------------------------------------------------ >> WhatsUp Gold - Download Free Network Management Software >> The most intuitive, comprehensive, and cost-effective network >> management toolset available today. Delivers lowest initial >> acquisition cost and overall TCO of any competing solution. >> http://p.sf.net/sfu/whatsupgold-sd > > > > ------------------------------------------------------------------------------ > WhatsUp Gold - Download Free Network Management Software > The most intuitive, comprehensive, and cost-effective network > management toolset available today. Delivers lowest initial > acquisition cost and overall TCO of any competing solution. > http://p.sf.net/sfu/whatsupgold-sd -- Jan Decaluwe - Resources bvba - http://www.jandecaluwe.com Python as a HDL: http://www.myhdl.org VHDL development, the modern way: http://www.sigasi.com Analog design automation: http://www.mephisto-da.com World-class digital design: http://www.easics.com |
