Infoportal
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision | ||
| fpga:vhdllibrary:start [2013-12-11 08:52] – tinner | fpga:vhdllibrary:start [2013-12-11 09:41] – tinner | ||
|---|---|---|---|
| Zeile 20: | Zeile 20: | ||
| * Im doc-Ordner können Dokumentationsdateien die zusätzlich zur .info Datei benötigt werden abgelegt werden. | * Im doc-Ordner können Dokumentationsdateien die zusätzlich zur .info Datei benötigt werden abgelegt werden. | ||
| * Die Projektordner müssen folgendermassen bennant werden: Name der Entwicklungsumgebung unterstrich Name des FPGAs z.B. quartus_cyclone_4. Dabei ist darauf zu achten keine von der Entwicklungsumgebung generierten Dateien mit einzuchecken. | * Die Projektordner müssen folgendermassen bennant werden: Name der Entwicklungsumgebung unterstrich Name des FPGAs z.B. quartus_cyclone_4. Dabei ist darauf zu achten keine von der Entwicklungsumgebung generierten Dateien mit einzuchecken. | ||
| + | * Alle Ordner bzw. Dateinamen dürfen **keine** Leerzeichen und auch **keine** Umlaute (ä,ö,ü) enthalten. | ||
| === Beispiel fqd === | === Beispiel fqd === | ||
| Zeile 50: | Zeile 51: | ||
| Für jeden Block muss eine .info Datei angelegt werden. Sie enthält Informationen über die jeweilige Komponente. Sie wird auch verwendet um den Wiki Eintag zu generieren. Es ist darauf zu achten, diese Datei stehts aktuell zu halten. | Für jeden Block muss eine .info Datei angelegt werden. Sie enthält Informationen über die jeweilige Komponente. Sie wird auch verwendet um den Wiki Eintag zu generieren. Es ist darauf zu achten, diese Datei stehts aktuell zu halten. | ||
| Für jede Komponente müssen in der .info Datei folgende Parameter angegeben werden: | Für jede Komponente müssen in der .info Datei folgende Parameter angegeben werden: | ||
| - | * Designer | + | * name (designator) |
| - | * Version | + | * description (string) |
| - | * Description | + | * version (designator) |
| - | * Used Sub-Blocks | + | * sources (name of the source files)(designator) |
| - | * Needed Files | + | * testbench (name of the testbench files)(designator) |
| - | * Testbench | + | * usedSubBlocks (Name of the used subblock)(designator) |
| - | * Lizenz | + | * license (string) |
| - | * State (Under Construction, Testing, Released) | + | * state (UnderConstruction, Testing, Released) |
| + | * reviewedBy (string) | ||
| Optional können noch weitere Informationen abgelegt werden: | Optional können noch weitere Informationen abgelegt werden: | ||
| - | * Synthesis Results | + | * synthesisResults (string) |
| - | * Usage | + | * usage (string) |
| - | * Known Bugs | + | * knownBugs (string) |
| - | * Modified by | + | * modifiedBy (string) |
| - | * TBD | + | |
| + | Alle Paramter die mit designator gekenzeichnet sind dürfen nicht zwischen Anführungszeichen geschrieben werden. Ein Beispiel ist [[https:// | ||
| + | |||
| === Beispiel: i2c.info === | === Beispiel: i2c.info === | ||
| < | < | ||
| Zeile 88: | Zeile 91: | ||
| ==== Versionierung ==== | ==== Versionierung ==== | ||
| - | Die Version besitzt folgendes Format: 0.0.0 ...TBD | + | Die Version besitzt folgendes Format: 0.0.0. |
| ==== Tags ==== | ==== Tags ==== | ||
| Sobald eine Komponente einen gewissen Stand erreicht hat bzw. spätestens wenn sie in irgend einem Projekt ausgeliefert wird muss im SVN ein Tag erstellt werden. Davor wird eine neue Version vergeben. | Sobald eine Komponente einen gewissen Stand erreicht hat bzw. spätestens wenn sie in irgend einem Projekt ausgeliefert wird muss im SVN ein Tag erstellt werden. Davor wird eine neue Version vergeben. | ||