... | ... | @@ -9,21 +9,30 @@ hdlmake releases, but it remains unstable and most of the projects in |
|
|
OHR rely on the older ISYP/v1.0 versions.
|
|
|
|
|
|
Bring the current Master to a stable and well documented status is the
|
|
|
purpose of this.
|
|
|
primary target of this action.
|
|
|
|
|
|
This wiki page is a working document containing the outcomes derived
|
|
|
from the analysis/test of the Master hdlmake and a set of proposals
|
|
|
intended to improve and stabilize the hdlmake tool.
|
|
|
|
|
|
### Repository
|
|
|
|
|
|
Current work is being developed on the hdlmake repository under the
|
|
|
*2014** branch.
|
|
|
Current work for this upgrade action is being developed on the hdlmake
|
|
|
repository under the **2014** branch.
|
|
|
|
|
|
https://www.ohwr.org/project/hdl-make/tree/2014/
|
|
|
|
|
|
## Docs
|
|
|
## Documentation
|
|
|
|
|
|
Command syntax and run arguments name/behavior have changed from ISYP to
|
|
|
current master, but the documentation it's not well
|
|
|
Command syntax and run arguments name/behavior have changed from
|
|
|
ISYP/v1.0 to current Master, but the documentation it's not very clear
|
|
|
about this issue.
|
|
|
|
|
|
### In sources
|
|
|
The most of the documentation is intended for the older versions, and
|
|
|
only this link covers how to migrate an older design/script to the
|
|
|
current Master [Masterforisypusers](Masterforisypusers).
|
|
|
|
|
|
### "doc" folder in sources
|
|
|
|
|
|
It includes two pdf files that are not valid for current master as they
|
|
|
are ISYP related.
|
... | ... | @@ -40,7 +49,7 @@ The source file in La(tex) format. |
|
|
specific for current Master code, but it seems to be targeted to
|
|
|
ISYP again and only points to VHDL support.
|
|
|
|
|
|
### Wiki
|
|
|
### Wiki content
|
|
|
|
|
|
The ISYP and current Masted related info is mixed across the wiki.
|
|
|
|
... | ... | @@ -58,8 +67,9 @@ Separation between older releases stuff and current master. |
|
|
- Compile all the stuff related with ISYP/v1.0 and set a clear wiki
|
|
|
section for this stuff.
|
|
|
- Write a new user document in both wiki and texinfo.
|
|
|
|
|
|
A full current feature set list with examples and parameter/options.
|
|
|
- Complete feature list and related parameters/arguments/options.
|
|
|
- Full set of example tutorials covering the most important
|
|
|
features.
|
|
|
|
|
|
*Developer doc**: Include python comments and a Python generation
|
|
|
(tested with "epydoc").
|
... | ... | |