foss-for-synopsys-dwc-arc-processors/embarc_mli

Confusing description of debug modes

demidan opened this issue · 2 comments

Hi Dima,
As you requested in PR#26 I transferring my comments to this issue.

For easier reference: after documentation restructure, the debug modes description moved to doc/documents/library_model/hw_dependencies_config.rst

In short:

  1. I do not like confusing (and not quite true) wording

function tries to break the execution using assert() function. If the assert() function does not break the execution, function returns error status.
I suggest to

  1. I do not like very repetitive descriptions in one place
  2. I think adding descriptive table would make sense

I suggest

  1. use wording like Any violation of data found lead to break on assert() instead
  2. use wording like The same as DBG_MODE_ASSERT, but before breaking on assert() function prints descriptive message using standard printf() function.
  3. add a table like following:
Behavior \ Mode RELEASE RET_CODES ASSERT DEBUG FULL
Return codes No Yes Yes Yes Yes
Assertions No No Yes Yes Yes
Extra Assertion No No No No Yes
Messages No No No Yes Yes

Best regards,
Daniil

Pull request #39 includes changes for this issue. Please, check.

Confirming that problem is solved.