mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-06 01:24:10 +00:00
Code Activity

Docs: Rename source/temp to source/generated

Browse source
This commit is contained in:
Krystine Sherwin 2024-04-15 10:13:22 +12:00
parent 953f5bbe6c
commit 73d021562f
No known key found for this signature in database
5 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Makefile
View file

@ -985,13 +985,13 @@ docs/gen_images:
$(Q) $(MAKE) -C docs images $(Q) $(MAKE) -C docs images
DOCS_GUIDELINE_FILES := GettingStarted CodingStyle DOCS_GUIDELINE_FILES := GettingStarted CodingStyle
docs/guidelines docs/source/temp: docs/guidelines docs/source/generated:
$(Q) mkdir -p docs/source/temp $(Q) mkdir -p docs/source/generated
$(Q) cp -f $(addprefix guidelines/,$(DOCS_GUIDELINE_FILES)) docs/source/temp $(Q) cp -f $(addprefix guidelines/,$(DOCS_GUIDELINE_FILES)) docs/source/generated
# some commands return an error and print the usage text to stderr # some commands return an error and print the usage text to stderr
define DOC_USAGE_STDERR define DOC_USAGE_STDERR
docs/source/temp/$(1): $(PROGRAM_PREFIX)$(1) docs/source/temp docs/source/generated/$(1): $(PROGRAM_PREFIX)$(1) docs/source/generated
-$(Q) ./$$< --help 2> $$@ -$(Q) ./$$< --help 2> $$@
endef endef
DOCS_USAGE_STDERR := yosys-config yosys-filterlib yosys-abc DOCS_USAGE_STDERR := yosys-config yosys-filterlib yosys-abc
@ -999,13 +999,13 @@ $(foreach usage,$(DOCS_USAGE_STDERR),$(eval $(call DOC_USAGE_STDERR,$(usage))))
# others print to stdout # others print to stdout
define DOC_USAGE_STDOUT define DOC_USAGE_STDOUT
docs/source/temp/$(1): $(PROGRAM_PREFIX)$(1) docs/source/temp docs/source/generated/$(1): $(PROGRAM_PREFIX)$(1) docs/source/generated
$(Q) ./$$< --help > $$@ $(Q) ./$$< --help > $$@
endef endef
DOCS_USAGE_STDOUT := yosys yosys-smtbmc yosys-witness DOCS_USAGE_STDOUT := yosys yosys-smtbmc yosys-witness
$(foreach usage,$(DOCS_USAGE_STDOUT),$(eval $(call DOC_USAGE_STDOUT,$(usage)))) $(foreach usage,$(DOCS_USAGE_STDOUT),$(eval $(call DOC_USAGE_STDOUT,$(usage))))
docs/usage: $(addprefix docs/source/temp/,$(DOCS_USAGE_STDOUT) $(DOCS_USAGE_STDERR)) docs/usage: $(addprefix docs/source/generated/,$(DOCS_USAGE_STDOUT) $(DOCS_USAGE_STDERR))
docs/reqs: docs/reqs:
$(Q) $(MAKE) -C docs reqs $(Q) $(MAKE) -C docs reqs

2
docs/.gitignore vendored
View file

@ -1,6 +1,6 @@
/build/ /build/
/source/cmd /source/cmd
/source/temp /source/generated
/source/_images/**/*.log /source/_images/**/*.log
/source/_images/**/*.aux /source/_images/**/*.aux
/source/_images/**/*.pdf /source/_images/**/*.pdf

1
docs/Makefile
View file

@ -48,6 +48,7 @@ help:
clean: clean-examples clean: clean-examples
rm -rf $(BUILDDIR)/* rm -rf $(BUILDDIR)/*
rm -rf source/cmd util/__pycache__ rm -rf source/cmd util/__pycache__
rm -rf source/generated
$(MAKE) -C source/_images clean $(MAKE) -C source/_images clean
.PHONY: html .PHONY: html

10
docs/source/appendix/auxprogs.rst
View file

@ -11,7 +11,7 @@ The ``yosys-config`` tool (an auto-generated shell-script) can be used to query
compiler options and other information needed for building loadable modules for compiler options and other information needed for building loadable modules for
Yosys. See :doc:`/yosys_internals/extending_yosys/extensions` for details. Yosys. See :doc:`/yosys_internals/extending_yosys/extensions` for details.
.. literalinclude:: /temp/yosys-config .. literalinclude:: /generated/yosys-config
:start-at: Usage :start-at: Usage
.. _sec:filterlib: .. _sec:filterlib:
@ -25,7 +25,7 @@ The ``yosys-filterlib`` tool is a small utility that can be used to strip or
extract information from a Liberty file. This can be useful for removing extract information from a Liberty file. This can be useful for removing
sensitive or proprietary information such as timing or other trade secrets. sensitive or proprietary information such as timing or other trade secrets.
.. literalinclude:: /temp/yosys-filterlib .. literalinclude:: /generated/yosys-filterlib
:start-at: Usage :start-at: Usage
yosys-abc yosys-abc
@ -36,7 +36,7 @@ been accepted upstream. Not all versions of Yosys work with all versions of ABC.
So Yosys comes with its own yosys-abc to avoid compatibility issues between the So Yosys comes with its own yosys-abc to avoid compatibility issues between the
two. two.
.. literalinclude:: /temp/yosys-abc .. literalinclude:: /generated/yosys-abc
:start-at: usage :start-at: usage
yosys-smtbmc yosys-smtbmc
@ -45,7 +45,7 @@ yosys-smtbmc
The ``yosys-smtbmc`` tool is a utility used by SBY for interacting with smt The ``yosys-smtbmc`` tool is a utility used by SBY for interacting with smt
solvers. solvers.
.. literalinclude:: /temp/yosys-smtbmc .. literalinclude:: /generated/yosys-smtbmc
yosys-witness yosys-witness
------------- -------------
@ -54,7 +54,7 @@ yosys-witness
This is used in SBY and SCY for producing traces in a consistent format This is used in SBY and SCY for producing traces in a consistent format
independent of the solver. independent of the solver.
.. literalinclude:: /temp/yosys-witness .. literalinclude:: /generated/yosys-witness
:start-at: Usage :start-at: Usage
.. note:: ``yosys-witness`` requires `click`_ Python package for use. .. note:: ``yosys-witness`` requires `click`_ Python package for use.

2
docs/source/cmd_ref.rst
View file

@ -4,7 +4,7 @@
Command line reference Command line reference
================================================================================ ================================================================================
.. literalinclude:: /temp/yosys .. literalinclude:: /generated/yosys
:start-at: Usage :start-at: Usage
.. toctree:: .. toctree::