Some minor preliminary docs reorg

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

View File

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

View File

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

View File

@ -15,7 +15,7 @@ AC_INIT([Verilator],[4.201 devel],
# Then 'make maintainer-dist'
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
AC_MSG_RESULT([configuring for $PACKAGE_STRING])

2
docs/.gitignore vendored
View File

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

View File

@ -88,6 +88,6 @@ Code of Conduct
- Our contributors and participants pledge to make participation in our
project and our community a positive experience for everyone. We follow
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!

View File

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 9.9 KiB

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.
*/

File diff suppressed because it is too large Load Diff

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.
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
be required to setup the system for fuzzing.

View File

@ -23,7 +23,7 @@ my $header =
."\n"
."\\setlength{\\parindent}{0pt} \\setlength{\\parskip}{\\baselineskip}\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"
."\\author{https:\/\/verilator.org}\n"
."\\lhead[${Opt_DistTitle}]{${Opt_DistTitle}}\n"