345 Commits

Author	SHA1	Message	Date
Emily Schmidt	bfed96ad88	some fixes and rewordings of the dft docs	2025-04-15 09:57:14 +01:00
Emily Schmidt	ea6e5b3c48	add changes to dft docs suggested by Krystine	2025-04-15 09:57:14 +01:00
Emily Schmidt	30486079f9	add dft_tag documentation	2025-04-15 09:57:14 +01:00
N. Engelhardt	3410e10ed5	Merge pull request #5000 from YosysHQ/krys/re_refactor_selections	2025-04-10 16:06:36 +00:00
Emily Schmidt	32ec5a9ccd	Revert "add dft_tag documentation" ... This reverts commit 2443facc46.	2025-04-09 10:34:11 +01:00
Emily Schmidt	2443facc46	add dft_tag documentation	2025-04-09 10:18:25 +01:00
Miodrag Milanovic	fee39a3284	Release version 0.52	2025-04-09 07:38:42 +02:00
Krystine Sherwin	cd3b914132	Reinstate #4768 ... Revert the reversion so that we can fix the bugs that the PR missed.	2025-04-08 11:58:05 +12:00
Miodrag Milanović	d49364d96f	Revert "Refactor full_selection"	2025-04-07 12:11:55 +02:00
KrystalDelusion	98d4355b82	Merge pull request #4768 from YosysHQ/krys/refactor_selections ... Refactor full_selection	2025-04-05 14:15:27 +13:00
KrystalDelusion	cce7aaedf7	Merge pull request #4939 from DanielG/rsync-fallback ... mk: Fall back to cp if rsync is not available	2025-03-25 10:41:27 +13:00
KrystalDelusion	644efca341	Merge pull request #4953 from YosysHQ/krys/local_docs_fixes ... A few fixes, mostly local docs builds	2025-03-25 10:36:18 +13:00
Daniel Gröber	2b67ad78bf	mk: Fall back to cp if rsync is not available	2025-03-24 18:06:17 +01:00
Krystine Sherwin	39a1623ac0	Docs: Don't READTHEDOCS on local builds	2025-03-18 03:57:17 +13:00
Krystine Sherwin	8877817fa9	Fix Docs issues for offline pdf builds #4777 ... Drop svg badges. Even though they were only appearing in the html version, the latexpdf target was still trying to download them, leading to warnings-as-errors in offline builds.	2025-03-15 12:14:09 +13:00
Scott Ashcroft	d8af6b0616	docs: Add latex magic to make PDFs reproducible again	2025-03-14 21:48:08 +01:00
Krystine Sherwin	dac2bb7d4d	Use selection helpers ... Catch more uses of selection constructor without assigning a design.	2025-03-14 14:08:13 +13:00
Martin Povišer	6da543a61a	Merge pull request #4818 from povik/macc_v2 ... Add `$macc_v2`	2025-03-12 22:55:40 +01:00
Miodrag Milanovic	c4b5190229	Release version 0.51	2025-03-12 08:31:37 +01:00
N. Engelhardt	c74df780b7	Merge pull request #4884 from YosysHQ/docs-preview-functional_tutorial ... Docs: More on FunctionalIR	2025-03-10 15:05:55 +00:00
Krystine Sherwin	c9785584da	docs/rosette: Fix tenses	2025-03-07 08:39:21 +13:00
Krystine Sherwin	b56e3ec6e4	docs/functional: Minimal backend paragraphs ... I was thinking about compiling the dummy example and including a simple example usage, but it turns out functional.h isn't (currently) available for extensions.	2025-03-01 16:15:54 +13:00
Krystine Sherwin	3c493d2bef	docs/rosette: Reword ... Acknowledge the minimal functional backend, highlighting what's new/different for our SExpr targets. Add and use the reference `minimal backend`. Use `note` directives to point out missing code sections (highlighting that the included diffs are not complete). Racket *is* still strongly-typed, it's just dynamic instead of static. Adjust phrasing to reflect that. Adjust some of the literal includes, adding a new section from the `Functional::AbstractVisitor`, splitting the `Module::write_eval()` in twain and adding a `smtlib.cc` literal include for the node iteration, as well as for the `FunctionalSmtBackend` to compare against the minimal backend. Move `Backend` description up to minimal functional backend section.	2025-02-28 16:33:57 +13:00
Krystine Sherwin	e01a413722	docs/rosette: List major changes in overview ... Also a little paragraph on why SMT-LIB is used as the base.	2025-02-28 14:57:41 +13:00
Krystine Sherwin	560b5fe6bd	docs/functional: Add dummy toy example ... Add `dummy.cc`, loosely based on `backends/functional/test_generic.cc` but as an actualy backend and without the memory testing. Skeleton section for minimal functional backend, describing the aforementioned `dummy.cc`.	2025-02-27 16:14:59 +13:00
Krystine Sherwin	db823a6acb	docs/rosette: Fix inline code	2025-02-27 16:11:44 +13:00
Krystine Sherwin	c429aef60f	docs/rosette: More intro of SMT-LIB backend ... As the intro paragraph (now) says: > This section will introduce the SMT-LIB functional backend and what changes are needed... The example is intended to be read without prior knowledge of the SMT-LIB backend, but the previous version glossed over a lot and instead focused on *just* what was changed. This version should now be easier to follow without prior knowledge, while still being able to learn enough about the `Smt` version to adapt it to a different s-expression target that isn't Rosette. Also adds a few `literalinclude`s of smtlib.cc, which is now copied to `docs/source/generated` along with producing the rosette diff on the fly (which now also has up to 20 lines of context, enabling the full `Module::write()` diff to be literal included).	2025-02-22 17:14:13 +13:00
Krystine Sherwin	38746ea5fa	docs: Cross reference contributing ... .md points to .html on latest .rst points to .md on main (not that it will work before this is merged)	2025-02-20 14:16:41 +13:00
Miodrag Milanovic	b5170e1394	Release version 0.50	2025-02-11 07:55:17 +01:00
Krystine Sherwin	819c3260ec	docs/rosette: Backend section body	2025-02-07 15:33:40 +13:00
Krystine Sherwin	b02d2c633e	docs/rosette: Module section body	2025-02-07 15:09:06 +13:00
Krystine Sherwin	34c424be68	docs/rosette: Minor updates ... - Fixing typo - Reference `write_functional_rosette` - Adjusting/fixing diff sections - Comment on why the `code-block:: diff` isn't a `literalinclude`	2025-02-07 15:08:24 +13:00
Krystine Sherwin	dc5a5b7bd1	docs/rosette: Regen rosette.diff ... This time from the actual source, which apparently means changing all of the spaces for tabs.	2025-02-07 14:13:34 +13:00
Krystine Sherwin	d73c58fad1	docs/rosette: Sort, Struct, and PrintVisitor sections	2025-02-04 12:24:34 +13:00
Krystine Sherwin	1b6b6a77ba	docs/rosette: Add details for Scope ... Add a diff file and use it for showing changes from smtlib to rosette. Also add relevant sections of diff to Sort and Struct sections.	2025-01-25 09:51:20 +13:00
Martin Povišer	61450e8b6e	Update codebase for macc_v2	2025-01-24 12:38:03 +01:00
Krystine Sherwin	242c037158	docs/rosette: Add overview	2025-01-24 13:10:34 +13:00
Miodrag Milanovic	427b5a251b	Release version 0.49	2025-01-21 14:59:09 +01:00
Emil J	da5c20dcfb	Merge pull request #4849 from YosysHQ/emil/hashlib-merge-top-ops ... hashlib: merge hash_ops with hash_top_ops for plugin compat	2025-01-21 12:09:27 +01:00
Emil J. Tywoniak	a2c26a00f2	hashlib: document merged hash_top_ops with hash_ops	2025-01-20 16:25:52 +01:00
KrystalDelusion	0c61f1a9a8	conf.py: Fix source_directory	2025-01-20 16:30:30 +13:00
KrystalDelusion	ab4bda8ae2	Docs: Fix links for view/edit source	2025-01-20 16:19:36 +13:00
Krystine Sherwin	f4c7377ac1	functional_ir.rst: Fix typo	2025-01-06 14:30:55 +13:00
Krystine Sherwin	23fa9b2014	functional_ir.rst: Initial skeleton for Rosette	2025-01-06 14:30:29 +13:00
Krystine Sherwin	ef7734d610	functional_ir.rst: Formatting ... Line breaks. Put intro under sub-heading.	2025-01-06 12:01:21 +13:00
KrystalDelusion	9e039095e9	Docs: Remove restructure note ... It's been almost a year since the restructure, so it's not recent anymore and doesn't need to link back to the old version.	2025-01-06 11:08:00 +13:00
Emil J. Tywoniak	b9b9515bb0	hashlib: hash_eat -> hash_into	2024-12-18 15:09:25 +01:00
Emil J. Tywoniak	0a525f38c2	hashlib: declare YS_HASHING_VERSION = 1	2024-12-18 15:09:25 +01:00
Emil J. Tywoniak	4e29ec1854	hashlib: acc -> eat	2024-12-18 15:09:25 +01:00
Emil J. Tywoniak	79acc141d5	hashlib: add deprecated mkhash function to prevent plugin breakage	2024-12-18 14:58:53 +01:00
Emil J. Tywoniak	6d53454bf5	docs: move hashing-based container details into internal docs from guidelines	2024-12-18 14:58:53 +01:00
Emil J	1401906d81	docs: formatting and fixes ... Co-authored-by: KrystalDelusion <93062060+KrystalDelusion@users.noreply.github.com>	2024-12-18 14:58:53 +01:00
Krystine Sherwin	0454787443	Docs: Formatting and fixes	2024-12-18 14:58:51 +01:00
Emil J. Tywoniak	ad0dc17711	docs: document the ideas behind the hashing interface	2024-12-18 14:58:31 +01:00
Miodrag Milanovic	aaa5347494	Release version 0.48	2024-12-11 08:35:36 +01:00
Krystine Sherwin	40af327cb6	Docs/installation: Drop resolved todos	2024-12-05 09:21:13 +13:00
Krystine Sherwin	6b3f2fdc8d	Docs: Installation instructions ... Add warning for Cygwin. Add commented out instructions for MSYS2 that I tried to get to work but ran into build errors.	2024-12-05 09:21:13 +13:00
Krystine Sherwin	b9d73d0a8e	Docs: Note on releases	2024-12-05 09:21:13 +13:00
Krystine Sherwin	a7ea375cfc	Docs/installation: Fix code indentation ... Update FreeBSD line to include CXX as well as CC. Drop unneeded todo.	2024-12-05 09:21:13 +13:00
Krystine Sherwin	0aef78245e	Moving primary build instructions to docs ... Also drop visual studio instructions.	2024-12-05 09:21:13 +13:00
Krystine Sherwin	c1f42f725b	Docs: Formatting recent md -> rst converts	2024-12-05 09:21:12 +13:00
Krystine Sherwin	9925b27432	Goodbye guidelines (except GettingStarted) ... Drop the parts that are being dropped. Move the things that are being moved. Also move the verilog stuff out of README and into the docs. GettingStarted is less cut and dry, so hold off on that one.	2024-12-05 09:21:12 +13:00
Krystine Sherwin	f0da1cc67f	Start removing guidelines folder ... Disable the export to docs and remove any references to the guidelines folder.	2024-12-05 09:18:56 +13:00
KrystalDelusion	6f3376cbe6	Merge pull request #4730 from YosysHQ/krys/downstream-docs ... Improvements for downstream-distro maintainability.	2024-11-28 14:35:16 +13:00
George Rennie	8148ebd1ad	docs: document that assigns must come before switches in case rules	2024-11-21 22:41:13 +01:00
Krystine Sherwin	e649c1a8e1	Docs: Accept empty string for release envvar	2024-11-20 12:31:12 +13:00
Krystine Sherwin	44b68fb498	Docs: Add check for envvar to disable todos	2024-11-20 12:18:17 +13:00
KrystalDelusion	22e214ec6d	Merge pull request #4705 from YosysHQ/docs-preview-lintonly ... Emphasise that read_verilog doesn't lint	2024-11-19 03:57:01 +13:00
Krystine Sherwin	1476eaba00	Docs: Add fallback for missing furo_ys ... This is mainly intended for (latex)pdf builds which do not use the furo-ys html theme, where the yosys script syntax highlighting can safely fallback to plaintext. This effectively makes `furo-ys` an optional dependency to simplify distro-package maintainability. See also #4725.	2024-11-12 16:23:12 +13:00
KrystalDelusion	4343c791cb	Merge pull request #4704 from YosysHQ/krys/drop_ilang ... Remove references to ilang	2024-11-08 11:28:06 +13:00
Miodrag Milanovic	647d61dd92	Release version 0.47	2024-11-05 07:59:25 +01:00
Krystine Sherwin	e4994554fd	Docs: Fix nested list	2024-11-05 13:48:48 +13:00
Krystine Sherwin	b14a651142	Docs: Mention verilator for linting ... Link to verilator in the introduction. Include `verilator --lint-only fifo.v` in the example synth doc. Fix linter warnings in fifo.v.	2024-11-05 13:29:45 +13:00
Krystine Sherwin	ee73a91f44	Remove references to ilang	2024-11-05 12:36:31 +13:00
Krystine Sherwin	4ea6119734	cmdref: Move html only section inside cmd:def ... Fixes missing links in body and `??` in tag/command index. Update synth.rst to match.	2024-10-17 06:06:57 +13:00
Krystine Sherwin	e9d9e92804	Docs: Make code_examples/extensions parallel safe	2024-10-17 04:40:21 +13:00
Krystine Sherwin	bc77575c22	Docs: Fix word_logic.rst ... It somehow got lost in the rebase.	2024-10-15 11:46:21 +13:00
Krystine Sherwin	dfe803b5c6	Docs: Comments from @jix ... - Unswap shift/shiftx - Add brief overview to cell lib - Clarify $div cell B input - Clarify unary operators - What is $modfloor	2024-10-15 07:37:20 +13:00
Krystine Sherwin	927dc445dd	Docs: Render cell titles ... Also put property lists *after* cell description.	2024-10-15 07:35:42 +13:00
Krystine Sherwin	7216f07691	Docs: Define is_evaluable	2024-10-15 07:35:41 +13:00
Krystine Sherwin	9d808caba6	Docs: Add note on $check	2024-10-15 07:35:41 +13:00
Krystine Sherwin	e40134c856	Docs: Update for properties ... Add properties page, move cell_gate and cell_word under a singular cell_index along with properties. Fix links accordingly. Also drop x-aware and x-output todos since they are resolved.	2024-10-15 07:35:41 +13:00
Krystine Sherwin	e3d939b719	Docs: Drop fifo.out and fifo.stat ... These two files can now be safely .gitignore'd.	2024-10-15 07:35:41 +13:00
Krystine Sherwin	1a2401816a	Docs: Add cell title TODO	2024-10-15 07:35:41 +13:00
Krystine Sherwin	9ce6952131	Docs: TODOs block, todos don't	2024-10-15 07:35:41 +13:00
Krystine Sherwin	f70a66f5b3	Docs: Assert cell has group ... Explicitly assign $_TBUF_ to `gate_other` and remove catch if a cell has no group.	2024-10-15 07:35:40 +13:00
Krystine Sherwin	5c4f7b4deb	Docs: $eqx aka case equality	2024-10-15 07:35:40 +13:00
Krystine Sherwin	217c2a15dd	Docs: Add todos from JF	2024-10-15 07:35:40 +13:00
Krystine Sherwin	00050833ef	Docs: Add gate_other page ... Drop word_other block since it raises a warning, which will cause the RTDs build to fail.	2024-10-15 07:35:40 +13:00
Krystine Sherwin	5473b60aec	Docs: Split gate-level cells into subpages	2024-10-15 07:35:40 +13:00
Krystine Sherwin	b0bc29e215	Docs: Add todo for $check	2024-10-15 07:35:40 +13:00
Krystine Sherwin	78b9dbd4ea	Docs: Assign remaining word cells to groups ... Move todos to correct place. Add todo for x-prop cells.	2024-10-15 07:35:40 +13:00
Krystine Sherwin	c6414e08eb	Docs: Switch to furo-ys for YoscryptLexer	2024-10-15 07:34:53 +13:00
Krystine Sherwin	e78841ba45	Docs: Fix invalid autorefs	2024-10-15 07:34:53 +13:00
Krystine Sherwin	be5572ca0e	Docs: Less leading backslashes	2024-10-15 07:34:52 +13:00
Krystine Sherwin	2b4a4cb536	Docs: Fix fsm.rst ... `$mux-tree` should be `$mux`-tree.	2024-10-15 07:34:52 +13:00
Krystine Sherwin	46580cebb3	Docs: Move rtlil_text (back) to appendix	2024-10-15 07:34:52 +13:00
Krystine Sherwin	1374fc2e2b	cellref: Deprecate cell_library.rst ... Most of the word/coarse level cells have an assigned group and individual page. The gate/fine level cells are all on one page. Fix links to `cell_library.rst`.	2024-10-15 07:34:52 +13:00
Krystine Sherwin	c662529316	Docs: Move binary operators to cell appendix ... Add binary group tag to relevant cells. Remove content from `cell_library.rst` that is already moved.	2024-10-15 07:31:47 +13:00
Krystine Sherwin	b127ac07f8	Docs: Preliminary autocellgroup usage ... Remove `/source/cell` from .gitignore. Add a few initial cell pages. Add YosysCellGroup documenter and cell:group directive. Update Documenters to use nested json. Better nested tocs for group.module.source layout.	2024-10-15 07:26:04 +13:00