Skip to content

Commit aa30dbc

Browse files
JimLewisJimLewis
committed
Updated comments for 2024.05 release
1 parent 23b5694 commit aa30dbc

32 files changed

+174
-94
lines changed

‎AUTHORS.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,27 @@
99
#### [Patrick Lehmann](https://opensource.ieee.org/patrick.lehmann)
1010
* Maintainer / Contributor
1111

12+
## OSVVM Project Contributors - The people who contribute to OSVVM
13+
14+
#### [Jim Lewis](https://opensource.ieee.org/jim)
15+
* Technical/Project lead
16+
* Maintainer / Contributor
17+
* email: jim (at) synthworks.com
18+
19+
#### [Patrick Lehmann](https://opensource.ieee.org/patrick.lehmann)
20+
* Maintainer / Contributor
21+
22+
### [Full contributors list](https://opensource.ieee.org/OSVVM/VerificationIP/-/graphs/master)
23+
24+
1225
## Participating
1326
The OSVVM project welcomes your participation with either
1427
issue reports or pull requests.
15-
For details on [how to participate see](https://opensource.ieee.org/osvvm/OsvvmLibraries/-/blob/master/CONTRIBUTING.md)
16-
17-
You can find the project
18-
[Contributors here](CONTRIBUTORS.md).
19-
28+
For details on [how to participate see](https://github.com/OSVVM/OsvvmLibraries/blob/main/CONTRIBUTING.md)
2029

2130

2231
#### Copyright and License
23-
Copyright (C) 2020 by [OSVVM Authors](AUTHORS.md)
32+
Copyright (C) 2020 - 2024 by [OSVVM Authors](AUTHORS.md)
2433

2534
This file is part of OSVVM.
2635

‎CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
| **Revision** | **Release Summary** |
44
|---------------|-----------------------------------------------------------------------------------------------|
5-
| 2024.04 | OsvvmProjectScripts - OpenBuildHtml |
5+
| 2024.05 | Updated Report formatting |
6+
| | Refactored Report2Html/Report2Junit to ReportBuildYaml2Dict/ReportBuildDict2Html/ReportBuildDict2Junit |
7+
| 2024.03 | OsvvmProjectScripts - OpenBuildHtml |
68
| | Fixed issue WRT simulator ending in error and not being able to move transcript files |
79
| | Added variable OsvvmVersionCompatibility to control whether to use new or old OSVVM settings |
810
| 2023.09 | OsvvmProjectScripts - build/include - file search now happens early for better messages |

‎CONTRIBUTORS.md

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,2 @@
1-
## OSVVM Project Contributors - The people who contribute to OSVVM
2-
3-
#### [Jim Lewis](https://opensource.ieee.org/jim)
4-
* Technical/Project lead
5-
* Maintainer / Contributor
6-
* email: jim (at) synthworks.com
7-
8-
#### [Patrick Lehmann](https://opensource.ieee.org/patrick.lehmann)
9-
* Maintainer / Contributor
10-
11-
### [Full contributors list](https://opensource.ieee.org/OSVVM/VerificationIP/-/graphs/master)
12-
13-
14-
## Participating
15-
The OSVVM project welcomes your participation with either
16-
issue reports or pull requests.
17-
For details on [how to participate see](https://opensource.ieee.org/osvvm/OsvvmLibraries/-/blob/master/CONTRIBUTING.md)
18-
19-
You can find the project [Authors here](AUTHORS.md)
20-
21-
#### Copyright and License
22-
Copyright (C) 2020 by [OSVVM Authors](AUTHORS.md)
23-
24-
This file is part of OSVVM.
25-
26-
Licensed under Apache License, Version 2.0 (the "License")
27-
You may not use this file except in compliance with the License.
28-
You may obtain a copy of the License at
29-
30-
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
31-
32-
Unless required by applicable law or agreed to in writing, software
33-
distributed under the License is distributed on an "AS IS" BASIS,
34-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35-
See the License for the specific language governing permissions and
36-
limitations under the License.
37-
1+
This file is deprecated.
2+
See [AUTHORS](AUTHORS.md).

‎CallbackDefaults.tcl

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@
1818
#
1919
# Revision History:
2020
# Date Version Description
21+
# 05/2024 2024.05 Updated for refactoring Report2Html/Junit to ReportBuildYaml2Dict/Dict2Html/Dict2Junit
2122
# 09/2022 2022.09 Initial
2223
#
2324
#
2425
# This file is part of OSVVM.
2526
#
26-
# Copyright (c) 2022 by SynthWorks Design Inc.
27+
# Copyright (c) 2022-2024 by SynthWorks Design Inc.
2728
#
2829
# Licensed under the Apache License, Version 2.0 (the "License");
2930
# you may not use this file except in compliance with the License.
@@ -212,14 +213,19 @@ namespace eval ::osvvm {
212213
error "$ProcName 'File Name: $FileName ' failed: $errmsg"
213214
}
214215

215-
proc CallbackOnError_Report2Html {FileName errmsg} {
216+
proc CallbackOnError_ReportBuildYaml2Dict {FileName errmsg} {
216217
set ::osvvm::Report2HtmlErrorInfo $::errorInfo
217-
LocalOnError_BuildReports Report2Html $FileName $errmsg
218+
LocalOnError_BuildReports ReportBuildYaml2Dict $FileName $errmsg
219+
}
220+
221+
proc CallbackOnError_ReportBuildDict2Html {FileName errmsg} {
222+
set ::osvvm::Report2HtmlErrorInfo $::errorInfo
223+
LocalOnError_BuildReports ReportBuildDict2Html $FileName $errmsg
218224
}
219225

220-
proc CallbackOnError_Report2Junit {FileName errmsg} {
226+
proc CallbackOnError_ReportBuildDict2Junit {FileName errmsg} {
221227
set ::osvvm::Report2JunitErrorInfo $::errorInfo
222-
LocalOnError_BuildReports Report2Junit $FileName $errmsg
228+
LocalOnError_BuildReports ReportBuildDict2Junit $FileName $errmsg
223229
}
224230

225231
proc CallbackOnError_Log2Osvvm {FileName errmsg} {

‎CssOsvvmStyle.css

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
/*
2-
*
2+
# File Name: CssOsvvmStyles.css
3+
# Purpose: CSS for OSVVM HTML reports
4+
# Revision: OSVVM MODELS STANDARD VERSION
5+
#
6+
# Maintainer: Jim Lewis email: [email protected]
7+
# Contributor(s):
8+
# Patrick Lehmann
9+
# Jim Lewis email: [email protected]
10+
#
11+
# Description
12+
# CSS for OSVVM HTML reports
13+
#
14+
#
15+
# Revision History:
16+
# Date Version Description
17+
# 05/2024 2024.05 Initial Revision
18+
#
19+
#
20+
# This file is part of OSVVM.
21+
#
22+
# Copyright (c) 2024 by SynthWorks Design Inc.
23+
#
24+
# Licensed under the Apache License, Version 2.0 (the "License");
25+
# you may not use this file except in compliance with the License.
26+
# You may obtain a copy of the License at
27+
#
28+
# https://www.apache.org/licenses/LICENSE-2.0
29+
#
30+
# Unless required by applicable law or agreed to in writing, software
31+
# distributed under the License is distributed on an "AS IS" BASIS,
32+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33+
# See the License for the specific language governing permissions and
34+
# limitations under the License.
35+
#
336
*/
437

538

‎OsvvmScriptsCore.tcl

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -452,14 +452,13 @@ proc AfterBuildReports {BuildName} {
452452
after 1000
453453
set BuildYamlFile [file join ${::osvvm::OutputBaseDirectory} ${BuildName}.yml]
454454
file rename -force ${::osvvm::OsvvmBuildYamlFile} ${BuildYamlFile}
455-
ReportBuildYaml2Dict ${BuildYamlFile}
456-
ReportBuildDict2Html
457-
# Report2Html ${BuildYamlFile}
455+
CreateBuildReports ${BuildYamlFile}
456+
# ReportBuildYaml2Dict ${BuildYamlFile}
457+
# ReportBuildDict2Html
458+
# ReportBuildDict2Junit
458459
if {($::osvvm::SimulateInteractive) && ($::osvvm::OpenBuildHtmlFile)} {
459460
OpenBuildHtml ${BuildName}
460461
}
461-
# Report2Junit ${BuildYamlFile}
462-
ReportBuildDict2Junit
463462

464463
ReportBuildStatus
465464
}

‎OsvvmScriptsCreateYamlReports.tcl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# File Name: CreateBuildYaml.tcl
1+
# File Name: OsvvmScriptsCreateYamlReports.tcl
22
# Purpose: Scripts for running simulations
33
# Revision: OSVVM MODELS STANDARD VERSION
44
#
@@ -7,7 +7,7 @@
77
# Jim Lewis email: [email protected]
88
#
99
# Description
10-
# Procedures that create the OSVVM OsvvmRun.yml
10+
# Support procedures to create the OSVVM YAML output
1111
# Defines the format of the OsvvmRun.yml file
1212
#
1313
# Developed by:

‎OsvvmSettingsRequired.tcl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
namespace eval ::osvvm {
5858

59-
variable OsvvmVersion 2024.0X-Dev
59+
variable OsvvmVersion 2024.05
6060

6161
if {![info exists OsvvmVersionCompatibility]} {
6262
variable OsvvmVersionCompatibility $OsvvmVersion

‎README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1294,7 +1294,7 @@ by calling Simulate2Html as follows.
12941294

12951295
.. code:: tcl
12961296
1297-
Simulate2Html <TestCaseName> <TestSuiteName> <TestCaseFileName>
1297+
Simulate2Html <PathToFile>/<TestCaseFileName>.yml
12981298
12991299
If no generics are set, then TestCaseFileName is the same as TestCaseName.
13001300
If generics are set, TestCaseFileName is TestCaseName_GenericName_Value.

‎ReportAlert2Html.tcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#
2020
# Revision History:
2121
# Date Version Description
22+
# 05/2024 2024.05 Minor updates during Simulate2Html refactoring
2223
# 04/2024 2024.04 Updated report formatting
2324
# 02/2022 2022.02 Updated YAML file handling
2425
# 10/2021 Initial Initial Revision

‎ReportBuildDict2Html.tcl

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
# Jim Lewis email: [email protected]
88
#
99
# Description
10-
# Convert OSVVM YAML build reports to HTML
11-
# Visible externally: Report2Html
10+
# Convert OSVVM Build Dictionary into HTML Build Report
11+
# Visible externally: ReportBuildDict2Html
12+
# Must call ReportBuildYaml2Dict first.
1213
#
1314
# Developed by:
1415
# SynthWorks Design Inc.
@@ -19,7 +20,7 @@
1920
#
2021
# Revision History:
2122
# Date Version Description
22-
# 05/2024 2024.05 Refactored. Decoupled. Yaml = source of information.
23+
# 05/2024 2024.05 Refactored. Must call ReportBuildYaml2Dict first.
2324
# 04/2024 2024.04 Updated report formatting
2425
# 07/2023 2023.07 Updated file handler to search for user defined HTML headers
2526
# 12/2022 2022.12 Refactored to only use static OSVVM information
@@ -58,6 +59,7 @@ package require yaml
5859
# Report2CoverageSubdirectory - value is "" if coverage not used
5960
#
6061

62+
6163
# -------------------------------------------------
6264
# ReportBuildDict2Html
6365
#
@@ -75,7 +77,7 @@ proc ReportBuildDict2Html {} {
7577
close $ResultsFile
7678

7779
if {$ErrorCode} {
78-
CallbackOnError_Report2Html ${ReportFileRoot}.html $errmsg
80+
CallbackOnError_ReportBuildDict2Html ${ReportFileRoot}.html $errmsg
7981
}
8082
}
8183

@@ -435,6 +437,14 @@ proc SumAlertCount {AlertCountDict} {
435437
}
436438

437439

440+
# -------------------------------------------------
441+
# Report2Html - provided for backward compatibility
442+
#
443+
proc Report2Html {BuildYamlFile} {
444+
ReportBuildYaml2Dict ${BuildYamlFile}
445+
ReportBuildDict2Html
446+
}
447+
438448

439449

440450

‎ReportBuildDict2Junit.tcl

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
# Jim Lewis email: [email protected]
88
#
99
# Description
10-
# Convert OSVVM YAML build reports to JUnit XML
11-
# Visible externally: Report2Junit
10+
# Convert OSVVM Build Dictionary into JUnit XML
11+
# Visible externally: ReportBuildDict2Junit
12+
# Must call ReportBuildYaml2Dict first.
1213
#
1314
#
1415
# Developed by:
@@ -20,6 +21,7 @@
2021
#
2122
# Revision History:
2223
# Date Version Description
24+
# 05/2024 2024.05 Refactored.
2325
# 04/2024 2024.04 Updated report formatting
2426
# 12/2022 2022.12 Refactored to only use static OSVVM information
2527
# 10/2021 Initial Initial Revision
@@ -58,7 +60,7 @@ proc ReportBuildDict2Junit {} {
5860
close $ResultsFile
5961

6062
if {$ErrorCode} {
61-
CallbackOnError_Report2Junit ${ReportFileRoot}.xml $errmsg
63+
CallbackOnError_ReportBuildDict2Junit ${ReportFileRoot}.xml $errmsg
6264
}
6365
}
6466

@@ -205,3 +207,11 @@ proc CreateJunitTestCaseSummary { TestSuiteSummaryDict } {
205207
# puts $ResultsFile " hostname=\"$env(HOSTNAME)\""
206208
puts $ResultsFile ">"
207209
}
210+
211+
# -------------------------------------------------
212+
# Report2Junit - provided for backward compatibility
213+
#
214+
proc Report2Junit {BuildYamlFile} {
215+
ReportBuildYaml2Dict ${BuildYamlFile}
216+
ReportBuildDict2Junit
217+
}

‎ReportBuildYaml2Dict.tcl

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
# Jim Lewis email: [email protected]
88
#
99
# Description
10-
# Convert OSVVM YAML build reports to HTML
11-
# Visible externally: Report2Html
10+
# Convert OSVVM YAML build reports to TCL Dictionary
11+
# Visible externally: ReportBuildYaml2Dict
1212
#
1313
# Developed by:
1414
# SynthWorks Design Inc.
@@ -58,6 +58,15 @@ package require yaml
5858
# Report2CoverageSubdirectory - value is "" if coverage not used
5959
#
6060

61+
# -------------------------------------------------
62+
# CreateBuildReports
63+
#
64+
proc CreateBuildReports {ReportFile} {
65+
ReportBuildYaml2Dict ${ReportFile}
66+
ReportBuildDict2Html
67+
ReportBuildDict2Junit
68+
}
69+
6170
# -------------------------------------------------
6271
# ReportBuildYaml2Dict
6372
#
@@ -78,7 +87,7 @@ proc ReportBuildYaml2Dict {ReportFile} {
7887
set ErrorCode [catch {LocalReportBuildYaml2Dict $BuildDict} errmsg]
7988

8089
if {$ErrorCode} {
81-
CallbackOnError_Report2Html $ReportFile $errmsg
90+
CallbackOnError_ReportBuildYaml2Dict $ReportFile $errmsg
8291
}
8392
}
8493

‎ReportCov2Html.tcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#
2020
# Revision History:
2121
# Date Version Description
22+
# 05/2024 2024.05 Minor updates during Simulate2Html refactoring
2223
# 04/2024 2024.04 Updated report formatting
2324
# 06/2022 2022.06 Print PASSED/FAILED with Coverage HTML
2425
# 02/2022 2022.02 Updated YAML file handling

‎ReportScoreboard2Html.tcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#
2020
# Revision History:
2121
# Date Version Description
22+
# 05/2024 2024.05 Minor updates during Simulate2Html refactoring
2223
# 04/2024 2024.04 Updated report formatting
2324
# 02/2022 2022.02 Initial Revision
2425
#

‎ReportSimulate2Html.tcl

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
# Jim Lewis email: [email protected]
88
#
99
# Description
10-
# Convert OSVVM Alert and Coverage results to HTML
11-
# Calls Alert2Html and Cov2Html
12-
# Visible externally: GenerateSimulationReports
10+
# Convert OSVVM Alert, Coverage, and Scoreboard results to HTML
11+
# Visible externally: Simulate2Html
1312
#
1413
# Developed by:
1514
# SynthWorks Design Inc.
@@ -20,7 +19,7 @@
2019
#
2120
# Revision History:
2221
# Date Version Description
23-
# 05/2024 2024.05 Refactored. Separating file copy from creating HTML.
22+
# 05/2024 2024.05 Refactored. Separating file copy from creating HTML. New Call interface.
2423
# 04/2024 2024.04 Updated report formatting
2524
# 03/2024 2024.03 Updated handling of TranscriptFile to account for simulator still having it open (due to abnormal exit)
2625
# 07/2023 2023.07 Updated OpenSimulationReportFile to search for user defined HTML headers

0 commit comments

Comments
 (0)