oddball / ipxact2systemverilog

Translates IPXACT XML to synthesizable VHDL or SystemVerilog
GNU General Public License v2.0
56 stars 19 forks source link

ipxact2hdlCommon.py returnRstTitle returns hardcoded string iso addressBlock.name #43

Closed wolfgang-blaszczyk closed 1 year ago

wolfgang-blaszczyk commented 1 year ago

If there are several .xml files in a map, describing registers, after running ipxact2rst, each .rst file begins with :

Register description

Registers

It would be an improvement, if instead we could have the real name of the register, as describe in the xml document at:

fpi_registers <== this name (fpi_registers) should be the header of the .rst file.
oddball commented 1 year ago

This is unclear to me. You cannot point out a filesystem directory ( which is what I assume you mean with ma)

If you do something like

 ipxact2rst --srcFile example/input --destDir

you will get an error

 IsADirectoryError: [Errno 21] Is a directory: 'example/input'

Please elaborate

wolfgang-blaszczyk commented 1 year ago

I dont know how to explain it better tan this: I have a folder with several .xml files, describing registers. When I run ipxact2rst on those files, the result are several .rst files, each starting with a hardcoded header generated by the

class rstAddressBlock(addressBlockClass):

def returnRstTitle(self):
    r = ''
    r += "====================\n"
    r += "Register description\n"
    r += "====================\n\n"
    return r

def returnRstSubTitle(self):
    r = ''
    r += "Registers\n"
    r += "---------\n\n"
    return r

When running make html from those files, I get in the index.html in the contents, not the name of the registers, but for each register the same tittle : Register description.

vermaete commented 1 year ago

@wolfgang-blaszczyk Could you check if my fork is fixing your issue before doing a merge request to Oddball. https://github.com/vermaete/ipxact2systemverilog

You will still have the issue that the generated documentation (MarkDown and ResturcturedText) is starting with upper header. This still can have issues if you want to collect the generated files into one top document. To be fixed later :-)

br

oddball commented 1 year ago

@wolfgang-blaszczyk, does the last release fix this issue?

wolfgang-blaszczyk commented 1 year ago

Hi, yes, the latest fix did return now for each register the name of the register.

Op di 23 mei 2023 om 13:46 schreef oddball @.***>:

@wolfgang-blaszczyk https://github.com/wolfgang-blaszczyk, does the last release fix this issue?

— Reply to this email directly, view it on GitHub https://github.com/oddball/ipxact2systemverilog/issues/43#issuecomment-1559129718, or unsubscribe https://github.com/notifications/unsubscribe-auth/A7OCGWHMKWZIWATP74OGF7LXHSPQ7ANCNFSM6AAAAAAXMKX5LM . You are receiving this because you were mentioned.Message ID: @.***>