From 35eac0c4573de5d516b5894ee656cbd117c89e13 Mon Sep 17 00:00:00 2001
From: Wilson Snyder <wsnyder@wsnyder.org>
Date: Sun, 5 Sep 2021 11:33:20 -0400
Subject: [PATCH] Commentary: Fix profcfunc naming.
---
bin/verilator_profcfunc | 2 +-
...rofcfuncs.rst => exe_verilator_profcfunc.rst} | 16 ++++++++++------
docs/guide/executables.rst | 2 +-
docs/spelling.txt | 1 -
4 files changed, 12 insertions(+), 9 deletions(-)
rename docs/guide/{exe_verilator_profcfuncs.rst => exe_verilator_profcfunc.rst} (58%)
diff --git a/bin/verilator_profcfunc b/bin/verilator_profcfunc
index 5d02d1ea5..1b564b5ec 100755
--- a/bin/verilator_profcfunc
+++ b/bin/verilator_profcfunc
@@ -180,7 +180,7 @@ the functions are then transformed, assuming the user used Verilator's
in each Verilog block.
For documentation see
-https://verilator.org/guide/latest/exe_verilator_profcfuncs.html
+https://verilator.org/guide/latest/exe_verilator_profcfunc.html
Copyright 2002-2021 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU
diff --git a/docs/guide/exe_verilator_profcfuncs.rst b/docs/guide/exe_verilator_profcfunc.rst
similarity index 58%
rename from docs/guide/exe_verilator_profcfuncs.rst
rename to docs/guide/exe_verilator_profcfunc.rst
index f3ac26b81..1283e6f2a 100644
--- a/docs/guide/exe_verilator_profcfuncs.rst
+++ b/docs/guide/exe_verilator_profcfunc.rst
@@ -1,20 +1,24 @@
.. Copyright 2003-2021 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
-verilator_profcfuncs
-====================
+verilator_profcfunc
+===================
Verilator_profcfunc reads a profile report created by gprof. The names of
the functions are then transformed, assuming the user used Verilator's
--prof-cfuncs, and a report printed showing the percentage of time, etc, in
each Verilog block.
-For an overview of use of verilator_profcfuncs, see :ref:`Profiling`.
+Due to rounding errors in gprof reports, the input report's percentages may
+not total to 100%. In the verilator_profcfunc report this will get
+reported as a rounding error.
-verilator_profcfuncs Arguments
-------------------------------
+For an overview of use of verilator_profcfunc, see :ref:`Profiling`.
-.. program:: verilator_profcfuncs
+verilator_profcfunc Arguments
+-----------------------------
+
+.. program:: verilator_profcfunc
.. option:: <filename>
diff --git a/docs/guide/executables.rst b/docs/guide/executables.rst
index e9c3fc700..248553266 100644
--- a/docs/guide/executables.rst
+++ b/docs/guide/executables.rst
@@ -15,5 +15,5 @@ options to each executable.
exe_verilator.rst
exe_verilator_coverage.rst
exe_verilator_gantt.rst
- exe_verilator_profcfuncs.rst
+ exe_verilator_profcfunc.rst
exe_sim.rst
diff --git a/docs/spelling.txt b/docs/spelling.txt
index 278dd6b76..82c6984da 100644
--- a/docs/spelling.txt
+++ b/docs/spelling.txt
@@ -676,7 +676,6 @@ prev
printf
printtimescale
profcfunc
-profcfuncs
prototyptes
ps
pthread