[dv, doc] Replace all 'dv.plan' with testplan
This commit purges all instances of "DV plan" to make the documentation
nomenclature as described in our DV methodology consistent.
what we capture in the HJSon -> testplan
what we capture in the markdown doc -> DV document
Signed-off-by: Srikrishna Iyer <sriyer@google.com>
diff --git a/util/dashboard/dashboard_validate.py b/util/dashboard/dashboard_validate.py
index 487e4b9..df4f9dd 100644
--- a/util/dashboard/dashboard_validate.py
+++ b/util/dashboard/dashboard_validate.py
@@ -36,7 +36,7 @@
field_optional = {
'design_spec':
['s', "path to the design specification, relative to repo root"],
- 'dv_doc': ['s', "path to the DV plan, relative to repo root"],
+ 'dv_doc': ['s', "path to the DV document, relative to repo root"],
'hw_checklist': ['s', "path to the hw_checklist, relative to repo root"],
'sw_checklist': ['s', "path to the sw_checklist, relative to repo root"],
'design_stage': ['s', "design stage of module"],
diff --git a/util/dashboard/gen_dashboard_entry.py b/util/dashboard/gen_dashboard_entry.py
index 7734c55..f813d78 100644
--- a/util/dashboard/gen_dashboard_entry.py
+++ b/util/dashboard/gen_dashboard_entry.py
@@ -75,8 +75,8 @@
return result
-# Provide the link to the DV plan.
-def get_linked_dv_plan(obj):
+# Provide the link to the DV document.
+def get_linked_dv_doc(obj):
if 'dv_doc' in obj:
return "<span title='DV Document'><a href=\"{}\">DV</a></span>".format(
get_doc_url(obj['_ip_desc_hjson_dir'], obj['dv_doc']))
@@ -229,8 +229,8 @@
genout(outfile, " <tr>\n")
genout(outfile, " <td class=\"fixleft\">" +
get_linked_design_spec(obj) + "</td>\n")
- genout(outfile, " <td class=\"dv-plan\">" +
- get_linked_dv_plan(obj) + "</td>\n")
+ genout(outfile, " <td class=\"dv-doc\">" +
+ get_linked_dv_doc(obj) + "</td>\n")
genout(outfile, " <td class=\"version\">" +
get_linked_version(obj) + "</td>\n")
@@ -261,8 +261,8 @@
if len(revisions) == 1:
outstr += " <td class='fixleft'>"
outstr += get_linked_design_spec(obj) + "</td>\n"
- outstr += " <td class='dv-plan'>"
- outstr += get_linked_dv_plan(obj) + "</td>\n"
+ outstr += " <td class='dv-doc'>"
+ outstr += get_linked_dv_doc(obj) + "</td>\n"
# Print out the module name in the first entry only
elif i == 0:
outstr += " <td class='fixleft' rowspan='{}'>".format(
@@ -270,7 +270,7 @@
outstr += get_linked_design_spec(obj) + "</td>\n"
outstr += " <td class='hw-stage' rowspan='{}'>".format(
len(revisions))
- outstr += get_linked_dv_plan(obj) + "</td>\n"
+ outstr += get_linked_dv_doc(obj) + "</td>\n"
# Version
outstr += " <td class=\"version\">"
@@ -306,18 +306,18 @@
else:
log.error("hjson file import failed")
- # create design spec and DV plan references, check for existence below
+ # create design spec and DV doc references, check for existence below
design_spec_md = re.sub(r'/data/', '/doc/',
re.sub(r'\.prj\.hjson', '.md', str(hjson_path)))
- dv_plan_md = re.sub(
- r'/data/', '/doc/',
- re.sub(r'\.prj\.hjson', '_dv_plan.md', str(hjson_path)))
+ dv_doc_md = re.sub(
+ r'/data/', '/doc/dv',
+ re.sub(r'\.prj\.hjson', 'index.md', str(hjson_path)))
design_spec_html = re.sub(
r'/data/', '/doc/',
re.sub(r'\.prj\.hjson', '.html', str(rel_hjson_path)))
- dv_plan_html = re.sub(
- r'/data/', '/doc/',
- re.sub(r'\.prj\.hjson', '_dv_plan.html', str(rel_hjson_path)))
+ dv_doc_html = re.sub(
+ r'/data/', '/doc/dv',
+ re.sub(r'\.prj\.hjson', 'index.html', str(rel_hjson_path)))
# yapf: disable
genout(outfile, " <tr>\n")
@@ -329,9 +329,9 @@
"design spec</a>\n")
else:
genout(outfile, " <td> </td>\n")
- if os.path.exists(dv_plan_md):
+ if os.path.exists(dv_doc_md):
genout(outfile, " <td class=\"fixleft\"><a href=\"" +
- html.escape(dv_plan_html) + "\">" +
+ html.escape(dv_doc_html) + "\">" +
"DV document</a>\n")
else:
genout(outfile, " <td> </td>\n")
