Minor improvements to benchmark files - Githubissues

intel / rohd

The Rapid Open Hardware Development (ROHD) framework is a framework for describing and verifying hardware in the Dart programming language.

https://intel.github.io/rohd-website

BSD 3-Clause "New" or "Revised" License

374 stars 67 forks source link

Minor improvements to benchmark files #325

Closed chykon closed 1 year ago

chykon commented 1 year ago

Description & Motivation

It is proposed to make small changes to the benchmark files:

Rename BENCHMARKING.md to README.md so that the information is immediately displayed when going to the benchmark directory on GitHub
Make the order of the fields (license, date, authorship) at the bottom of README.md match the order of the header template used in code files; add new line breaks
Change benchmark files a bit (update headers, add missing final, remove empty functions)

Related Issue(s)

No.

Testing

Not required - the functionality does not change.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

The benchmark information file (README.md) will change slightly.

chykon commented 1 year ago

CI ended with an error due to https://github.com/intel/rohd/issues/324.