ShellOption

firrtl.options.ShellOption
final class ShellOption[A](val longOption: String, val toAnnotationSeq: A => AnnotationSeq, val helpText: String, val shortOption: Option[String] = ..., val helpValueName: Option[String] = ...)(implicit evidence$1: Read[A])

Contains information about a Shell command line option

Type parameters

the

type of the command line argument

Value parameters

helpText

help text

helpValueName

a string to show as a placeholder argument in help text

longOption

a long, double-dash option

shortOption

an optional single-dash option

toAnnotationSeq

a function to convert the type into an AnnotationSeq

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
Registration.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def addOption(p: OptionParser[AnnotationSeq]): Unit

Add this specific shell (command line) option to an option parser

Add this specific shell (command line) option to an option parser

Value parameters

p

an option parser

Attributes

Source
Registration.scala

Concrete fields

val helpText: String

Attributes

Source
Registration.scala
val helpValueName: Option[String]

Attributes

Source
Registration.scala
val longOption: String

Attributes

Source
Registration.scala
val shortOption: Option[String]

Attributes

Source
Registration.scala

Attributes

Source
Registration.scala