mirror of
				https://github.com/YosysHQ/yosys
				synced 2025-11-03 21:09:12 +00:00 
			
		
		
		
	Docs: Update build_verific
Clarify partially supported builds section. Update parameter defaults. Include note on finding compile options with `yosys-config`. Fix remaining references to `/yosys_source/`.
This commit is contained in:
		
							parent
							
								
									88bb785dcd
								
							
						
					
					
						commit
						36ad07e1d5
					
				
					 3 changed files with 14 additions and 8 deletions
				
			
		| 
						 | 
				
			
			@ -138,8 +138,8 @@ To use a compiler different than the default, use:
 | 
			
		|||
 | 
			
		||||
.. seealso:: 
 | 
			
		||||
 | 
			
		||||
   Refer to :doc:`/yosys_source/test_suites` for details on testing Yosys once
 | 
			
		||||
   compiled.
 | 
			
		||||
   Refer to :doc:`/yosys_internals/extending_yosys/test_suites` for details on
 | 
			
		||||
   testing Yosys once compiled.
 | 
			
		||||
 | 
			
		||||
Source tree and build system
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
| 
						 | 
				
			
			@ -194,7 +194,7 @@ directories:
 | 
			
		|||
 | 
			
		||||
``tests/``
 | 
			
		||||
   This directory contains the suite of unit tests and regression tests used by
 | 
			
		||||
   Yosys.  See :doc:`/yosys_source/test_suites`.
 | 
			
		||||
   Yosys.  See :doc:`/yosys_internals/extending_yosys/test_suites`.
 | 
			
		||||
 | 
			
		||||
The top-level Makefile includes :file:`frontends/{*}/Makefile.inc`,
 | 
			
		||||
:file:`passes/{*}/Makefile.inc` and :file:`backends/{*}/Makefile.inc`. So when
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -40,6 +40,5 @@ available, go to :ref:`commandindex`.
 | 
			
		|||
   getting_started/index
 | 
			
		||||
   using_yosys/index
 | 
			
		||||
   yosys_internals/index
 | 
			
		||||
   yosys_source/index
 | 
			
		||||
 | 
			
		||||
   appendix
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -50,11 +50,18 @@ Parameter                         Default Description
 | 
			
		|||
ENABLE_VERIFIC_SYSTEMVERILOG      1       SystemVerilog support
 | 
			
		||||
ENABLE_VERIFIC_VHDL               1       VHDL support
 | 
			
		||||
ENABLE_VERIFIC_HIER_TREE          1       Hierarchy tree support
 | 
			
		||||
ENABLE_VERIFIC_YOSYSHQ_EXTENSIONS 1       YosysHQ specific extensions support
 | 
			
		||||
ENABLE_VERIFIC_YOSYSHQ_EXTENSIONS 0       YosysHQ specific extensions support
 | 
			
		||||
ENABLE_VERIFIC_EDIF               0       EDIF support
 | 
			
		||||
ENABLE_VERIFIC_LIBERTY            0       Liberty file support
 | 
			
		||||
================================= ======= ===================================
 | 
			
		||||
 | 
			
		||||
To find the compile options used for a given Yosys build, call `yosys-config
 | 
			
		||||
--cxxflags`. This documentation was built with the following compile options:
 | 
			
		||||
 | 
			
		||||
.. literalinclude:: /generated/yosys-config
 | 
			
		||||
    :start-at: --cxxflags
 | 
			
		||||
    :end-before: --linkflags
 | 
			
		||||
 | 
			
		||||
Required Verific features
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -92,9 +99,9 @@ Yosys builds:
 | 
			
		|||
Partially supported builds
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
 | 
			
		||||
.. todo:: still unclear on the purpose of this section.
 | 
			
		||||
 | 
			
		||||
   Are these the configurations we have tested as being able to compile?
 | 
			
		||||
This section describes Yosys+Verific configurations which we have confirmed as
 | 
			
		||||
working in the past, however they are not a part of our regular tests so we
 | 
			
		||||
cannot guarantee they are still functional.
 | 
			
		||||
 | 
			
		||||
To be able to compile Yosys with Verific, the Verific library must have support
 | 
			
		||||
for at least one HDL language with RTL elaboration enabled.  The following table
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue