riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Start removing guidelines folder 

Disable the export to docs and remove any references to the guidelines folder.
This commit is contained in:
Krystine Sherwin 2024-12-05 09:18:56 +13:00
parent c61b2bc1bc
commit f0da1cc67f
No known key found for this signature in database
5 changed files with 4 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Makefile
View File

@ -996,15 +996,12 @@ docs/source/cell/word_add.rst: $(TARGETS) $(EXTRA_TARGETS)
docs/source/generated/cells.json: docs/source/generated $(TARGETS) $(EXTRA_TARGETS) docs/source/generated/cells.json: docs/source/generated $(TARGETS) $(EXTRA_TARGETS)
$(Q) ./$(PROGRAM_PREFIX)yosys -p 'help -dump-cells-json $@' $(Q) ./$(PROGRAM_PREFIX)yosys -p 'help -dump-cells-json $@'
PHONY: docs/gen docs/guidelines docs/usage docs/reqs PHONY: docs/gen docs/usage docs/reqs
docs/gen: $(TARGETS) docs/gen: $(TARGETS)
$(Q) $(MAKE) -C docs gen $(Q) $(MAKE) -C docs gen
DOCS_GUIDELINE_FILES := GettingStarted CodingStyle docs/source/generated:
DOCS_GUIDELINE_SOURCE := $(addprefix guidelines/,$(DOCS_GUIDELINE_FILES))
docs/guidelines docs/source/generated: $(DOCS_GUIDELINE_SOURCE)
$(Q) mkdir -p docs/source/generated $(Q) mkdir -p docs/source/generated
$(Q) cp -f $(DOCS_GUIDELINE_SOURCE) 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
@ -1034,7 +1031,7 @@ docs/reqs:
$(Q) $(MAKE) -C docs reqs $(Q) $(MAKE) -C docs reqs
.PHONY: docs/prep .PHONY: docs/prep
docs/prep: docs/source/cmd/abc.rst docs/source/generated/cells.json docs/gen docs/guidelines docs/usage docs/prep: docs/source/cmd/abc.rst docs/source/generated/cells.json docs/gen docs/usage
DOC_TARGET ?= html DOC_TARGET ?= html
docs: docs/prep docs: docs/prep

3
README.md
View File

@ -47,9 +47,6 @@ The "Documentation" page on the web site contains links to more resources,
including a manual that even describes some of the Yosys internals: including a manual that even describes some of the Yosys internals:
- https://yosyshq.net/yosys/documentation.html - https://yosyshq.net/yosys/documentation.html
The directory `guidelines` contains additional information
for people interested in using the Yosys C++ APIs.
Users interested in formal verification might want to use the formal verification Users interested in formal verification might want to use the formal verification
front-end for Yosys, SymbiYosys: front-end for Yosys, SymbiYosys:
- https://symbiyosys.readthedocs.io/en/latest/ - https://symbiyosys.readthedocs.io/en/latest/

4
docs/source/getting_started/installation.rst
View File

@ -161,10 +161,6 @@ directories:
``frontends/`` ``frontends/``
This directory contains a subdirectory for each of the frontend modules. This directory contains a subdirectory for each of the frontend modules.
``guidelines/``
Contains developer guidelines, including the code of conduct and coding style
guide.
``kernel/`` ``kernel/``
This directory contains all the core functionality of Yosys. This includes This directory contains all the core functionality of Yosys. This includes
the functions and definitions for working with the RTLIL data structures the functions and definitions for working with the RTLIL data structures

6
docs/source/yosys_internals/extending_yosys/extensions.rst
View File

@ -11,11 +11,7 @@ Writing extensions
This chapter contains some bits and pieces of information about programming This chapter contains some bits and pieces of information about programming
yosys extensions. Don't be afraid to ask questions on the YosysHQ Slack. yosys extensions. Don't be afraid to ask questions on the YosysHQ Slack.
The :file:`guidelines/` directory of the Yosys source code contains notes on .. todo:: mention coding guide
various aspects of Yosys development. In particular, the files GettingStarted
and CodingStyle may be of interest.
.. todo:: what's in guidelines/GettingStarted that's missing from the manual?
Quick guide Quick guide
----------- -----------

2
kernel/yosys.h
View File

@ -32,8 +32,6 @@
// //
// This header is very boring. It just defines some general things that // This header is very boring. It just defines some general things that
// belong nowhere else and includes the interesting headers. // belong nowhere else and includes the interesting headers.
//
// Find more information in the "guidelines/GettingStarted" file.
#ifndef YOSYS_H #ifndef YOSYS_H