sierrafoxtrot / srecord

SRecord github Mirror
https://srecord.sourceforge.net/
GNU General Public License v3.0
42 stars 22 forks source link

add vhdl textio format (output only) #52

Closed danselmi closed 1 year ago

danselmi commented 1 year ago

This generates files which can be used in simulation and synthesis tools.

Where belongs the documentation of the command line parameters? The path mentioned in the Efinix patch looks like it contains only file-format descriptions, instead of SRecord command decriptions...???

sierrafoxtrot commented 1 year ago

This generates files which can be used in simulation and synthesis tools.

Where belongs the documentation of the command line parameters? The path mentioned in the Efinix patch looks like it contains only file-format descriptions, instead of SRecord command decriptions...???

The man5 files contain the file descriptions as they are from section 5 "File formats and conventions". The commands themselves are in section 1 "User commands" and the path is documented in doc/man1/*.1.

If you have something specific to e.g srec_cat then it would go in doc/man1/srec_cat.1

If you have something common (primarily the common input arguments used by srec_cat, srec_info and srec_cmp, then it would go into doc/man1/srec_input.1. Generally output specific elements are only used by srec_cat.

danselmi commented 1 year ago

I believe this is ready for reviewing too.