From b6c905dffc49f579fe419384639970b9eeb796b9 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Thu, 13 Jun 2019 07:19:44 -0400 Subject: [PATCH] Move files into docs directory. --- MANIFEST.SKIP | 3 +- Makefile.in | 20 +++++-- README.pod | 19 ++++--- configure.ac | 2 +- docs/.gitignore | 1 + Artistic => docs/Artistic | 0 COPYING => docs/COPYING | 0 COPYING.LESSER => docs/COPYING.LESSER | 0 docs/Makefile.in | 50 ++++++++++++++++++ TODO => docs/TODO | 0 doxygen-mainpage => docs/doxygen-mainpage | 0 doxygen.config => docs/doxygen.config | 2 +- verilator_logo.png => docs/verilator_logo.png | Bin src/pod2latexfix | 2 +- test_regress/t/t_dist_tabs.pl | 8 +-- 15 files changed, 87 insertions(+), 20 deletions(-) create mode 100644 docs/.gitignore rename Artistic => docs/Artistic (100%) rename COPYING => docs/COPYING (100%) rename COPYING.LESSER => docs/COPYING.LESSER (100%) create mode 100644 docs/Makefile.in rename TODO => docs/TODO (100%) rename doxygen-mainpage => docs/doxygen-mainpage (100%) rename doxygen.config => docs/doxygen.config (99%) rename verilator_logo.png => docs/verilator_logo.png (100%) diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP index a29332d7e..bc21f17df 100644 --- a/MANIFEST.SKIP +++ b/MANIFEST.SKIP @@ -28,6 +28,8 @@ ^Makefile$ bin/verilator_bin.* bin/verilator_coverage_bin.* +docs/Makefile$ +docs/doxygen-doc/.* src/Makefile$ src/Makefile_obj$ include/verilated.mk$ @@ -47,7 +49,6 @@ nodist/ /simv.daidir/ /vc_hdrs.h$ /csrc/ -doxygen-doc/.* obj_dir/.* TAGS .*~ diff --git a/Makefile.in b/Makefile.in index 9dcdbb760..b29e3d97f 100644 --- a/Makefile.in +++ b/Makefile.in @@ -114,9 +114,9 @@ INFOS = README README.html README.pdf internals.txt internals.html \ # Files that can be generated, but should be up to date for a distribution. DISTDEP = info Makefile -DISTFILES_INC = $(INFOS) .gitignore Artistic COPYING COPYING.LESSER \ +DISTFILES_INC = $(INFOS) .gitignore \ *.in *.ac \ - Changes TODO \ + Changes \ MANIFEST.SKIP \ bin/verilator \ bin/verilator_coverage \ @@ -124,8 +124,16 @@ DISTFILES_INC = $(INFOS) .gitignore Artistic COPYING COPYING.LESSER \ bin/verilator_gantt \ bin/verilator_includer \ bin/verilator_profcfunc \ + docs/.gitignore \ + docs/Artistic \ docs/CONTRIBUTORS \ - doxygen-mainpage doxygen.config verilator_logo.png \ + docs/COPYING \ + docs/COPYING.LESSER \ + docs/Makefile.in \ + docs/TODO \ + docs/doxygen-mainpage \ + docs/doxygen.config \ + docs/verilator_logo.png \ install-sh configure *.pod \ include/*.[chv]* \ include/*.in \ @@ -223,9 +231,11 @@ examples: all_nomsg $(MAKE) -C $$p VERILATOR_ROOT=`pwd` || exit 10; \ done +.PHONY: docs +docs: info + info: $(INFOS) -# Use --no-split to avoid creating filenames > 14 chars. %.1: ${srcdir}/bin/% pod2man $< $@ @@ -531,7 +541,7 @@ TAGS: $(TAGFILES) .PHONY: doxygen doxygen: - $(DOXYGEN) doxygen.config + $(MAKE) -C docs doxygen ###################################################################### # Test targets diff --git a/README.pod b/README.pod index dc31b91c9..af00f2539 100644 --- a/README.pod +++ b/README.pod @@ -187,25 +187,28 @@ Detailed documentation and the man page can be seen by running: bin/verilator --help -or reading verilator.txt in the same directory as this README. +or reading verilator.pdf in the same directory as this README. =head1 DIRECTORY STRUCTURE The directories in the kit after de-taring are as follows: bin/verilator => Compiler Wrapper invoked to Verilate code - include/ => Files that should be in your -I compiler path - include/verilated*.cpp => Global routines to link into your simulator - include/verilated*.h => Global headers - include/verilated.v => Stub defines for linting - include/verilated.mk => Common makefile - src/ => Translator source code + docs/ => Additional documentation examples/hello_world_c => Example simple Verilog->C++ conversion examples/hello_world_sc => Example simple Verilog->SystemC conversion examples/tracing_c => Example Verilog->C++ with tracing examples/tracing_sc => Example Verilog->SystemC with tracing + include/ => Files that should be in your -I compiler path + include/verilated*.cpp => Global routines to link into your simulator + include/verilated*.h => Global headers + include/verilated.mk => Common makefile + include/verilated.v => Stub defines for linting + src/ => Translator source code test_regress => Internal tests + verilator.pdf => Primary documentation + verilator.txt => Primary documentation (text) =head1 LIMITATIONS -See verilator.txt (or execute C) for limitations. +See verilator.pdf (or execute C) for limitations. diff --git a/configure.ac b/configure.ac index c0ec75156..36addfdc3 100644 --- a/configure.ac +++ b/configure.ac @@ -13,7 +13,7 @@ AC_INIT([Verilator],[4.015 devel], # and commit using "devel release" or "Version bump" message AC_CONFIG_HEADER(src/config_build.h) -AC_CONFIG_FILES(Makefile src/Makefile src/Makefile_obj include/verilated.mk include/verilated_config.h verilator.pc) +AC_CONFIG_FILES(Makefile docs/Makefile src/Makefile src/Makefile_obj include/verilated.mk include/verilated_config.h verilator.pc) AC_MSG_RESULT([configuring for $PACKAGE_STRING]) diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..f3c7a7c5d --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +Makefile diff --git a/Artistic b/docs/Artistic similarity index 100% rename from Artistic rename to docs/Artistic diff --git a/COPYING b/docs/COPYING similarity index 100% rename from COPYING rename to docs/COPYING diff --git a/COPYING.LESSER b/docs/COPYING.LESSER similarity index 100% rename from COPYING.LESSER rename to docs/COPYING.LESSER diff --git a/docs/Makefile.in b/docs/Makefile.in new file mode 100644 index 000000000..61156f3da --- /dev/null +++ b/docs/Makefile.in @@ -0,0 +1,50 @@ +#***************************************************************************** +# DESCRIPTION: Verilator documentation: Makefile pre-configure version +# +# This file is part of Verilator. +# +# Code available from: http://www.veripool.org/verilator +# +#***************************************************************************** +# +# Copyright 2003-2019 by Wilson Snyder. This program is free software; you can +# redistribute it and/or modify it under the terms of either the GNU +# Lesser General Public License Version 3 or the Perl Artistic License +# Version 2.0. +# +# Verilator is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +#****************************************************************************/ +# +# This file is intended only to be called from the top-level Verilator Makefile. + +#### Start of system configuration section. #### + +DOXYGEN = doxygen + +#### End of system configuration section. #### +###################################################################### + +.SUFFIXES: + +default: + @echo "error: make not supported here, run 'make docs' from Verilator top-level" + +clean mostlyclean distclean maintainer-clean:: + rm -f $(SCRIPTS) *.tmp + rm -f *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.log + rm -f *.pg *.pgs *.toc *.tp *.tps *.vr *.vrs *.idx + rm -f *.ev *.evs *.ov *.ovs *.cv *.cvs *.ma *.mas + rm -f *.tex + +distclean maintainer-clean:: + rm -f *.info* *.1 $(INFOS) + rm -f Makefile + +.PHONY: doxygen + +doxygen: + $(DOXYGEN) doxygen.config diff --git a/TODO b/docs/TODO similarity index 100% rename from TODO rename to docs/TODO diff --git a/doxygen-mainpage b/docs/doxygen-mainpage similarity index 100% rename from doxygen-mainpage rename to docs/doxygen-mainpage diff --git a/doxygen.config b/docs/doxygen.config similarity index 99% rename from doxygen.config rename to docs/doxygen.config index 384d563c0..3947cabad 100644 --- a/doxygen.config +++ b/docs/doxygen.config @@ -45,7 +45,7 @@ PROJECT_BRIEF = "Verilog to C translator" # exceed 55 pixels and the maximum width should not exceed 200 pixels. # Doxygen will copy the logo to the output directory. -PROJECT_LOGO = veripool-logo.png +PROJECT_LOGO = verilator_logo.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. diff --git a/verilator_logo.png b/docs/verilator_logo.png similarity index 100% rename from verilator_logo.png rename to docs/verilator_logo.png diff --git a/src/pod2latexfix b/src/pod2latexfix index 16929d823..e8f3f4ef8 100755 --- a/src/pod2latexfix +++ b/src/pod2latexfix @@ -26,7 +26,7 @@ my $header = ."\n" ."\\setlength{\\parindent}{0pt} \\setlength{\\parskip}{\\baselineskip}\n" ."\n" - ."\\title{\\includegraphics[width=6cm]{verilator_logo.png}\\\\ ${Opt_DistTitle}}\n" + ."\\title{\\includegraphics[width=6cm]{docs/verilator_logo.png}\\\\ ${Opt_DistTitle}}\n" ."\\date{${Opt_DistDate}}\n" ."\\author{http:\/\/www.veripool.org}\n" ."\\lhead[${Opt_DistTitle}]{${Opt_DistTitle}}\n" diff --git a/test_regress/t/t_dist_tabs.pl b/test_regress/t/t_dist_tabs.pl index 741efed54..272b45c8f 100755 --- a/test_regress/t/t_dist_tabs.pl +++ b/test_regress/t/t_dist_tabs.pl @@ -11,13 +11,15 @@ scenarios(dist => 1); my $root = ".."; +my $Tabs_Exempt_Re = qr!(\.out$)|(/gtkwave)|(Makefile)|(\.mk$)!; + if (!-r "$root/.git") { skip("Not in a git repository"); } else { ### Must trim output before and after our file list my %warns; my $prefix; - my $summary; + my $summary = ""; { my $diff = `cd $root && git diff HEAD`; #print "DS $diff\n" if $Debug; @@ -28,8 +30,7 @@ if (!-r "$root/.git") { foreach my $line ((split /\n/, $diff), "+++ b/_the_end") { if ($line =~ m!^\+\+\+ b/(.*)!) { if ($file && !$atab && $btab - && $file !~ m!\.out$! - && $file !~ m!/gtkwave!) { + && $file !~ $Tabs_Exempt_Re) { $summary = "File modifications adds new tabs (please untabify the patch):"; $warns{$file} = "File modification adds new tabs (please untabify the patch): $file"; } @@ -64,6 +65,7 @@ if (!-r "$root/.git") { if ($len >= 100 && $file !~ /\.out$/) { print" Wide $line\n" if $Self->{verbose}; + $summary = "File modification adds a new >100 column line:" if !$summary; $warns{$file} = "File modification adds a new >100 column line: $file:$lineno"; } }