github/verilator
1
0
Fork 1
mirror of https://github.com/verilator/verilator.git synced 2025-01-05 22:27:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Some minor preliminary docs reorg

Browse Source
This commit is contained in:
Wilson Snyder 2021-04-04 22:05:44 -04:00
parent 5658d7238d
commit 961a2fef61
11 changed files with 8 additions and 1781 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MANIFEST.SKIP
View File

@ -39,7 +39,7 @@ README.html
bin/verilator_bin.* bin/verilator_bin.*
bin/verilator_coverage_bin.* bin/verilator_coverage_bin.*
docs/.*\.html$ docs/.*\.html$
docs/Makefile$ docs/_build/
docs/clang-format.txt$ docs/clang-format.txt$
docs/doxygen-doc/.* docs/doxygen-doc/.*
examples/xml_py/copied/ examples/xml_py/copied/

6
Makefile.in
View File

@ -136,13 +136,11 @@ DISTFILES_INC = $(INFOS) .gitignore \
docs/.gitignore \ docs/.gitignore \
docs/CONTRIBUTING.rst \ docs/CONTRIBUTING.rst \
docs/CONTRIBUTORS \ docs/CONTRIBUTORS \
docs/Makefile.in \ docs/Makefile \
docs/TODO \ docs/TODO \
docs/doxygen-mainpage \ docs/_static/verilator_logo.png \
docs/doxygen.config \
docs/install.rst \ docs/install.rst \
docs/internals.rst \ docs/internals.rst \
docs/verilator_logo.png \
docs/xml.rst \ docs/xml.rst \
install-sh configure *.pod \ install-sh configure *.pod \
include/*.[chv]* \ include/*.[chv]* \

2
configure.ac
View File

@ -15,7 +15,7 @@ AC_INIT([Verilator],[4.201 devel],
# Then 'make maintainer-dist' # Then 'make maintainer-dist'
AC_CONFIG_HEADER(src/config_build.h) AC_CONFIG_HEADER(src/config_build.h)
AC_CONFIG_FILES(Makefile docs/Makefile src/Makefile src/Makefile_obj include/verilated.mk include/verilated_config.h verilator.pc verilator-config.cmake verilator-config-version.cmake) AC_CONFIG_FILES(Makefile src/Makefile src/Makefile_obj include/verilated.mk include/verilated_config.h verilator.pc verilator-config.cmake verilator-config-version.cmake)
# Version # Version
AC_MSG_RESULT([configuring for $PACKAGE_STRING]) AC_MSG_RESULT([configuring for $PACKAGE_STRING])

2
docs/.gitignore vendored
View File

@ -1,4 +1,4 @@
*.1 *.1
*.html *.html
*.pdf *.pdf
Makefile _build

2
docs/CONTRIBUTING.rst
View File

@ -88,6 +88,6 @@ Code of Conduct
- Our contributors and participants pledge to make participation in our - Our contributors and participants pledge to make participation in our
project and our community a positive experience for everyone. We follow project and our community a positive experience for everyone. We follow
the `Contributor Covenant version 1.4 the `Contributor Covenant version 1.4
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__. <https://www.contributor-covenant.org/version/1/4/code-of-conduct/>`__.
Thanks! Thanks!

0
docs/Makefile.in → docs/Makefile
View File

0
docs/verilator_logo.png → docs/_static/verilator_logo.png vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 9.9 KiB

6
docs/doxygen-mainpage
View File

@ -1,6 +0,0 @@
/*! \mainpage Verilator Doxygen Documentation
*
* \section intro_sec Introduction
*
* This is a full doxygen analysis of the Verilator source tree.
*/

1765
docs/doxygen.config
View File

File diff suppressed because it is too large Load Diff

2
docs/internals.rst
View File

@ -872,7 +872,7 @@ There are scripts included to facilitate fuzzing of Verilator. These
have been successfully used to find a number of bugs in the frontend. have been successfully used to find a number of bugs in the frontend.
The scripts are based on using `American fuzzy The scripts are based on using `American fuzzy
lop <http://lcamtuf.coredump.cx/afl/>`__ on a Debian-like system. lop <https://lcamtuf.coredump.cx/afl/>`__ on a Debian-like system.
To get started, cd to "nodist/fuzzer/" and run "./all". A sudo password may To get started, cd to "nodist/fuzzer/" and run "./all". A sudo password may
be required to setup the system for fuzzing. be required to setup the system for fuzzing.

2
src/pod2latexfix
View File

@ -23,7 +23,7 @@ my $header =
."\n" ."\n"
."\\setlength{\\parindent}{0pt} \\setlength{\\parskip}{\\baselineskip}\n" ."\\setlength{\\parindent}{0pt} \\setlength{\\parskip}{\\baselineskip}\n"
."\n" ."\n"
."\\title{\\includegraphics[width=6cm]{docs/verilator_logo.png}\\\\ ${Opt_DistTitle}}\n" ."\\title{\\includegraphics[width=6cm]{docs/_static/verilator_logo.png}\\\\ ${Opt_DistTitle}}\n"
."\\date{${Opt_DistDate}}\n" ."\\date{${Opt_DistDate}}\n"
."\\author{https:\/\/verilator.org}\n" ."\\author{https:\/\/verilator.org}\n"
."\\lhead[${Opt_DistTitle}]{${Opt_DistTitle}}\n" ."\\lhead[${Opt_DistTitle}]{${Opt_DistTitle}}\n"