@@@ much mess, mostly manpages

[mLib] / test / tvec-bench.3.in

diff --git a/test/tvec-bench.3.in b/test/tvec-bench.3.in
new file mode 100644 (file)
index 0000000..c51799c
--- /dev/null
+++ b/test/tvec-bench.3.in
@@ -0,0 +1,67 @@
+.\" -*-nroff-*-
+.\"
+.\" Manual for bencharking with the test-vector framework
+.\"
+.\" (c) 2024 Straylight/Edgeware
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of the mLib utilities library.
+.\"
+.\" mLib is free software: you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or (at
+.\" your option) any later version.
+.\"
+.\" mLib 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 Library General Public
+.\" License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with mLib.  If not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
+.\" USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../defs.man \" @@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
+.TH tvec-bench 3mLib "11 March 2024" "Straylight/Edgeware" "mLib utilities library"
+.\" @TVEC_BENCHENV
+.\" @TVEC_BENCHINIT
+.\" @tvec_benchreport
+.
+.\"--------------------------------------------------------------------------
+.SH NAME
+tvec-bench \- benchmarking with the test vector framework
+.
+.\"--------------------------------------------------------------------------
+.SH SYNOPSIS
+.
+.nf
+.B "#include <mLib/tvec.h>"
+.PP
+.ta 2n
+.B "struct tvec_benchenv {"
+.B "   struct tvec_env _env;"
+.B "   struct bench_state **bst;"
+.B "   unsigned long niter;"
+.B "   int riter, rbuf;"
+.B "   const struct tvec_env *env;"
+.B "};"
+.B "struct bench_state *tvec_benchstate;"
+.B "#define TVEC_BENCHENV ..."
+.B "#define TVEC_BENCHINIT ..."
+.B "enum {"
+.B "   TVBU_OP = ...,"
+.B "   TVBU_BYTE = ...,"
+.B "   ...,"
+.B "   TVBU_LIMIT"
+.B "};"
+.PP
+.ta \w'\fBvoid tvec_benchreport('u
+.BI "void tvec_benchreport(const struct gprintf_ops *" gops ", void *" go ,
+.BI "  unsigned " unit ", const struct bench_timing *" tm );
+.fi