summaryrefslogtreecommitdiff
path: root/doc/timevar.texi
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2018-09-30 19:27:56 +0200
committerBruno Haible <bruno@clisp.org>2018-09-30 19:27:56 +0200
commitaf502d1026949c53efbccbd289d5e2b2da586a62 (patch)
tree4f2899af8051ae4664822d9d9997fb0b939a3a03 /doc/timevar.texi
parentfb63c8672e829296e1aa5d67fc8320f6dcb5099d (diff)
downloadgnulib-af502d1026949c53efbccbd289d5e2b2da586a62.tar.gz
timevar: Include documentation in gnulib manual.
* doc/timevar.texi: Change node and section name to 'Profiling of program phases'. In the code snippets, tweak the #includes and use GNU coding style. * doc/gnulib.texi: Include timevar.texi.
Diffstat (limited to 'doc/timevar.texi')
-rw-r--r--doc/timevar.texi16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/timevar.texi b/doc/timevar.texi
index 86ef8115e4..ae818fbdd4 100644
--- a/doc/timevar.texi
+++ b/doc/timevar.texi
@@ -1,7 +1,8 @@
-@node timevar
-@section timevar
+@node Profiling of program phases
+@section Profiling of program phases
-A simple self-profiling module based on timers.
+The module @samp{timevar} provides a simple self-profiling facility,
+based on timers.
@smallexample
Execution times (seconds)
@@ -44,11 +45,13 @@ the following example.
#include <config.h>
#include "timevar.h"
+#include <stdio.h>
#include "read.h"
#include "work.h"
#include "output.h"
-int main (void)
+int
+main (void)
@{
timevar_enabled = true;
timevar_init ();
@@ -76,9 +79,10 @@ with, for instance, in @file{work.c}
@smallexample
#include <config.h>
-#include <work.h>
+#include "work.h"
-void work (void)
+void
+work (void)
@{
timevar_push (tv_work_phase1);
work1 ();