Added descriptions to variables.

daedaleanai · Dec 22, 2021 · 3abf26f · 3abf26f
1 parent cb5b051
commit 3abf26f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/RULES/hdl/questa.go b/RULES/hdl/questa.go
@@ -16,6 +16,7 @@ var VlogFlags = core.StringFlag{
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the vlog command",
 }.Register()
 
 // VcomFlags enables the user to specify additional flags for the 'vcom' command.
@@ -24,6 +25,7 @@ var VcomFlags = core.StringFlag{
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the vcom command",
 }.Register()
 
 // VsimFlags enables the user to specify additional flags for the 'vsim' command.
@@ -32,6 +34,7 @@ var VsimFlags = core.StringFlag{
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the vsim command",
 }.Register()
 
 // Access enables the user to control the accessibility in the compiled design for
@@ -41,6 +44,7 @@ var Access = core.StringFlag{
 	DefaultFn: func() string {
 		return "rna"
 	},
+	Description: "Control access to simulation objects for debugging purposes",
 }.Register()
 
 // Coverage enables the user to run the simulation with code coverage.
@@ -49,6 +53,7 @@ var Coverage = core.BoolFlag{
 	DefaultFn: func() bool {
 		return false
 	},
+	Description: "Enable code-coverage database generation",
 }.Register()
 
 // CoverageHtml enables the generation of an Html report in the output directory
@@ -57,6 +62,7 @@ var CoverageHtml = core.BoolFlag{
 	DefaultFn: func() bool {
 		return false
 	},
+	Description: "Enable code-coverage HTML report generation",
 }.Register()
 
 // Target returns the optimization target name defined for this rule.

diff --git a/RULES/hdl/simulator.go b/RULES/hdl/simulator.go
@@ -9,7 +9,7 @@ import (
 
 var Simulator = core.StringFlag{
 	Name:        "hdl-simulator",
-	Description: "HDL simulator to use when generating simulation targets",
+	Description: "Select HDL simulator",
 	DefaultFn: func() string {
 		return "questa"
 	},
@@ -18,7 +18,7 @@ var Simulator = core.StringFlag{
 
 var SimulatorLibDir = core.StringFlag{
 	Name:        "hdl-simulator-lib-dir",
-	Description: "Path to the HDL Simulator libraries",
+	Description: "Path to the HDL simulator libraries",
 	DefaultFn: func() string {
 		return ""
 	},

diff --git a/RULES/hdl/xsim.go b/RULES/hdl/xsim.go
@@ -12,35 +12,40 @@ import (
 
 // XvlogFlags enables the user to specify additional flags for the 'vlog' command.
 var XvlogFlags = core.StringFlag{
-	Name: "xvlog-flags",
+	Name: "xsim-xvlog-flags",
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the xvlog command",
 }.Register()
 
 // XvhdlFlags enables the user to specify additional flags for the 'vcom' command.
 var XvhdlFlags = core.StringFlag{
-	Name: "xvhdl-flags",
+	Name: "xsim-xvhdl-flags",
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the xvhdl command",
 }.Register()
 
 // XsimFlags enables the user to specify additional flags for the 'vsim' command.
 var XsimFlags = core.StringFlag{
-	Name: "xsim-flags",
+	Name: "xsim-xsim-flags",
 	DefaultFn: func() string {
 		return ""
 	},
+	Description: "Extra flags for the xsim command",
 }.Register()
 
 // XelabDebug enables the user to control the accessibility in the compiled design for
 // debugging purposes.
 var XelabDebug = core.StringFlag{
-	Name: "xelab-debug",
+	Name: "xsim-xelab-debug",
 	DefaultFn: func() string {
 		return "typical"
 	},
+	Description:   "Extra debug flags for the xelab command",
+	AllowedValues: []string{"line", "wave", "drivers", "readers", "xlibs", "all", "typical", "subprogram", "off"},
 }.Register()
 
 // xsim_rules holds a map of all defined rules to prevent defining the same rule