mirror of
				https://github.com/YosysHQ/sby.git
				synced 2025-10-26 10:44:37 +00:00 
			
		
		
		
	docs: started working on a rough draft of the docs for the new sections and changes to existing sections
This commit is contained in:
		
							parent
							
								
									98fdcd7772
								
							
						
					
					
						commit
						da56a3c6d1
					
				
					 2 changed files with 58 additions and 8 deletions
				
			
		|  | @ -178,6 +178,9 @@ options are: | ||||||
| |                  | ``prove``, | specified number of cycles at the end of the trace.     | | |                  | ``prove``, | specified number of cycles at the end of the trace.     | | ||||||
| |                  | ``cover``  | Default: ``0``                                          | | |                  | ``cover``  | Default: ``0``                                          | | ||||||
| +------------------+------------+---------------------------------------------------------+ | +------------------+------------+---------------------------------------------------------+ | ||||||
|  | | ``stage``        | All        | The stages to select to run.                            | | ||||||
|  | |                  |            | Default: All                                            | | ||||||
|  | +------------------+------------+---------------------------------------------------------+ | ||||||
| 
 | 
 | ||||||
| Engines section | Engines section | ||||||
| --------------- | --------------- | ||||||
|  | @ -205,6 +208,19 @@ solver options. | ||||||
| In the 2nd line ``abc`` is the engine, there are no engine options, ``sim3`` is the | In the 2nd line ``abc`` is the engine, there are no engine options, ``sim3`` is the | ||||||
| solver, and ``-W 15`` are solver options. | solver, and ``-W 15`` are solver options. | ||||||
| 
 | 
 | ||||||
|  | 
 | ||||||
|  | The ``[engines]`` section also takes an argument as to what mode that block applies to. | ||||||
|  | Meaning you can specify an engine block for a given mode. | ||||||
|  | 
 | ||||||
|  | Example: | ||||||
|  | 
 | ||||||
|  | .. code-block:: text | ||||||
|  | 
 | ||||||
|  |    [engines bmc] | ||||||
|  |    btor pono | ||||||
|  |    abc sim3 | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
| The following mode/engine/solver combinations are currently supported: | The following mode/engine/solver combinations are currently supported: | ||||||
| 
 | 
 | ||||||
| +-----------+--------------------------+ | +-----------+--------------------------+ | ||||||
|  | @ -391,6 +407,48 @@ Run ``yosys`` in a terminal window and enter ``help`` on the Yosys prompt | ||||||
| for a command list. Run ``help <command>`` for a detailed description of the | for a command list. Run ``help <command>`` for a detailed description of the | ||||||
| command, for example ``help prep``. | command, for example ``help prep``. | ||||||
| 
 | 
 | ||||||
|  | Setup section | ||||||
|  | ------------- | ||||||
|  | 
 | ||||||
|  | The ``[setup]`` section provides a way to add global cutpoints, and enable/disable/assume/define patterns. | ||||||
|  | By default properties that are unspecified default to enabled, and a ``disable *`` at the end of the settings | ||||||
|  | will set the default to be disabled. | ||||||
|  | 
 | ||||||
|  | For example: | ||||||
|  | 
 | ||||||
|  | .. code-block:: text | ||||||
|  | 
 | ||||||
|  |    [setup] | ||||||
|  |    enable * | ||||||
|  | 
 | ||||||
|  | The following options are available for the ``[setup]`` section: | ||||||
|  | 
 | ||||||
|  | .. todo:: | ||||||
|  | 
 | ||||||
|  |    Document better | ||||||
|  | 
 | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | |   Option         | Description                                             | | ||||||
|  | +==================+=========================================================+ | ||||||
|  | | ``cutpoint``     | Defines a cutpoint pattern.                             | | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | | ``disable``      | Defines a disable pattern.                              | | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | | ``enable``       | Defines an enable pattern.                              | | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | | ``assume``       | Defines an assume pattern.                              | | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | | ``define``       | Define a value.                                         | | ||||||
|  | +------------------+---------------------------------------------------------+ | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | Stage section | ||||||
|  | ------------- | ||||||
|  | 
 | ||||||
|  | .. todo:: | ||||||
|  | 
 | ||||||
|  |    Document | ||||||
|  | 
 | ||||||
| Files section | Files section | ||||||
| ------------- | ------------- | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -1,8 +0,0 @@ | ||||||
| [options] |  | ||||||
| mode bmc |  | ||||||
| depth 1 |  | ||||||
| expect error |  | ||||||
| stages foo,bar,nya |  | ||||||
| 
 |  | ||||||
| [engines] |  | ||||||
| smtbmc |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue