Change misleading comment about ModuleDoc. #668
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not calling
ModuleDoc.__init__(self)
causesduid
to be unset and exceptions like this (see gregdavill/valentyusb#1 ).Traceback (most recent call last):
File "mydesign.py", line 299, in
main()
File "mydesign.py", line 292, in main
generate_docs(soc, "build/"+target+"/documentation")
File ".../litex/litex/litex/soc/doc/init.py", line 98, in generate_docs
documented_region = DocumentedCSRRegion(
File ".../litex/litex/litex/soc/doc/csr.py", line 80, in init
docs = module.get_module_documentation()
File ".../litex/litex/litex/soc/integration/doc.py", line 141, in gatherer
return sorted(r, key=lambda x: x.duid)
File ".../litex/litex/litex/soc/integration/doc.py", line 141, in
return sorted(r, key=lambda x: x.duid)
File ".../litex/migen/migen/fhdl/module.py", line 136, in getattr
raise AttributeError("'"+self.class.name+"' object has no attribute '"+name+"'")
AttributeError: 'CDCUsbPHY' object has no attribute 'duid'
Acknowledgement
Thanks for zyp on #litex for hints. As zyp wrote: "unless there is a better way to solve it".