1 /* ==> Do not modify this file!! It is created automatically
2 from fsf_callg_bl.m using the gen-c-prog.awk script. <== */
3
4 #include <stdio.h>
5 #include "ansidecl.h"
6
7 void fsf_callg_blurb (FILE *);
8 void
9 fsf_callg_blurb (FILE *file)
10 {
11 fputs ("\n", file);
12 fputs (" This table describes the call tree of the program, and was sorted by\n", file);
13 fputs (" the total amount of time spent in each function and its children.\n", file);
14 fputs ("\n", file);
15 fputs (" Each entry in this table consists of several lines. The line with the\n", file);
16 fputs (" index number at the left hand margin lists the current function.\n", file);
17 fputs (" The lines above it list the functions that called this function,\n", file);
18 fputs (" and the lines below it list the functions this one called.\n", file);
19 fputs (" This line lists:\n", file);
20 fputs (" index A unique number given to each element of the table.\n", file);
21 fputs (" Index numbers are sorted numerically.\n", file);
22 fputs (" The index number is printed next to every function name so\n", file);
23 fputs (" it is easier to look up where the function is in the table.\n", file);
24 fputs ("\n", file);
25 fputs (" % time This is the percentage of the `total' time that was spent\n", file);
26 fputs (" in this function and its children. Note that due to\n", file);
27 fputs (" different viewpoints, functions excluded by options, etc,\n", file);
28 fputs (" these numbers will NOT add up to 100%.\n", file);
29 fputs ("\n", file);
30 fputs (" self This is the total amount of time spent in this function.\n", file);
31 fputs ("\n", file);
32 fputs (" children This is the total amount of time propagated into this\n", file);
33 fputs (" function by its children.\n", file);
34 fputs ("\n", file);
35 fputs (" called This is the number of times the function was called.\n", file);
36 fputs (" If the function called itself recursively, the number\n", file);
37 fputs (" only includes non-recursive calls, and is followed by\n", file);
38 fputs (" a `+' and the number of recursive calls.\n", file);
39 fputs ("\n", file);
40 fputs (" name The name of the current function. The index number is\n", file);
41 fputs (" printed after it. If the function is a member of a\n", file);
42 fputs (" cycle, the cycle number is printed between the\n", file);
43 fputs (" function's name and the index number.\n", file);
44 fputs ("\n", file);
45 fputs ("\n", file);
46 fputs (" For the function's parents, the fields have the following meanings:\n", file);
47 fputs ("\n", file);
48 fputs (" self This is the amount of time that was propagated directly\n", file);
49 fputs (" from the function into this parent.\n", file);
50 fputs ("\n", file);
51 fputs (" children This is the amount of time that was propagated from\n", file);
52 fputs (" the function's children into this parent.\n", file);
53 fputs ("\n", file);
54 fputs (" called This is the number of times this parent called the\n", file);
55 fputs (" function `/' the total number of times the function\n", file);
56 fputs (" was called. Recursive calls to the function are not\n", file);
57 fputs (" included in the number after the `/'.\n", file);
58 fputs ("\n", file);
59 fputs (" name This is the name of the parent. The parent's index\n", file);
60 fputs (" number is printed after it. If the parent is a\n", file);
61 fputs (" member of a cycle, the cycle number is printed between\n", file);
62 fputs (" the name and the index number.\n", file);
63 fputs ("\n", file);
64 fputs (" If the parents of the function cannot be determined, the word\n", file);
65 fputs (" `<spontaneous>' is printed in the `name' field, and all the other\n", file);
66 fputs (" fields are blank.\n", file);
67 fputs ("\n", file);
68 fputs (" For the function's children, the fields have the following meanings:\n", file);
69 fputs ("\n", file);
70 fputs (" self This is the amount of time that was propagated directly\n", file);
71 fputs (" from the child into the function.\n", file);
72 fputs ("\n", file);
73 fputs (" children This is the amount of time that was propagated from the\n", file);
74 fputs (" child's children to the function.\n", file);
75 fputs ("\n", file);
76 fputs (" called This is the number of times the function called\n", file);
77 fputs (" this child `/' the total number of times the child\n", file);
78 fputs (" was called. Recursive calls by the child are not\n", file);
79 fputs (" listed in the number after the `/'.\n", file);
80 fputs ("\n", file);
81 fputs (" name This is the name of the child. The child's index\n", file);
82 fputs (" number is printed after it. If the child is a\n", file);
83 fputs (" member of a cycle, the cycle number is printed\n", file);
84 fputs (" between the name and the index number.\n", file);
85 fputs ("\n", file);
86 fputs (" If there are any cycles (circles) in the call graph, there is an\n", file);
87 fputs (" entry for the cycle-as-a-whole. This entry shows who called the\n", file);
88 fputs (" cycle (as parents) and the members of the cycle (as children.)\n", file);
89 fputs (" The `+' recursive calls entry shows the number of function calls that\n", file);
90 fputs (" were internal to the cycle, and the calls entry for each member shows,\n", file);
91 fputs (" for that member, how many times it was called from other members of\n", file);
92 fputs (" the cycle.\n", file);
93 fputs (" \n", file);
94 fputs ("Copyright (C) 2012-2023 Free Software Foundation, Inc.\n", file);
95 fputs ("\n", file);
96 fputs ("Copying and distribution of this file, with or without modification,\n", file);
97 fputs ("are permitted in any medium without royalty provided the copyright\n", file);
98 fputs ("notice and this notice are preserved.\n", file);
99 }