File: generating-source.html

package info (click to toggle)
xmlroff 0.6.2-1.3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 36,460 kB
  • ctags: 25,964
  • sloc: ansic: 178,246; xml: 109,155; sh: 8,973; makefile: 1,331; perl: 30
file content (156 lines) | stat: -rw-r--r-- 6,887 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Generating Source</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<meta name="description" content="Generating source code">
<link rel="start" href="index.html" title="xmlroff Reference Manual">
<link rel="up" href="developers.html" title="Developers' Guide">
<link rel="prev" href="fo-area-c-file.html" title="Anatomy of a Formatting Object area source code file">
<link rel="next" href="debugging.html" title="Debugging xmlroff">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="users.html" title="Users' Guide">
<link rel="chapter" href="developers.html" title="Developers' Guide">
<link rel="chapter" href="object-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="object.html" title="FoObject is wonderful">
<link rel="chapter" href="node.html" title="FoNode is wonderful">
<link rel="chapter" href="interfaces.html" title="Interfaces are truly wonderful">
<link rel="chapter" href="formatting-objects.html" title="Formatting Objects are truly wonderful">
<link rel="chapter" href="properties.html" title="Properties">
<link rel="chapter" href="areas.html" title="Area Objects">
<link rel="chapter" href="datatypes.html" title="Datatype Objects">
<link rel="chapter" href="context.html" title="Property Context Object">
<link rel="chapter" href="other-objects.html" title="Other Objects">
<link rel="chapter" href="utility-objects.html" title="Utility Objects">
<link rel="chapter" href="utility-modules.html" title="Utility Modules">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="fo-area-c-file.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="developers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">xmlroff Reference Manual</th>
<td><a accesskey="n" href="debugging.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="section" lang="en">
<div class="titlepage"><div>
<div><h2 class="title" style="clear: both">
<a name="generating-source"></a>Generating Source</h2></div>
<div><h2 class="subtitle">Generating Source</h2></div>
<div><div class="abstract">
<p class="title"><b>Abstract</b></p>
<p>Generating source code</p>
</div></div>
</div></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="generating-source-text"></a>Generating Source</h3></div></div></div>
<p>The stylesheets in the 'codegen' package are used to generate C source and header files from the XML for the XSL 1.0 Recommendation.</p>
<p>The generated files are not guaranteed to be drop-in replacements for the existing xmlroff source code and header files, since many of the xmlroff source code and header files have had manual modifications.</p>
<p>You should use Emacs's ediff or some other diff/merge utility to compare the generated file and the existing version and only change what should be changed.</p>
<p>The exception are the .c and .h files created for a property that has just been added to dump-info.xml: since the property's files didn't exist before, you can just copy the generated files to the xmlroff source code.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="files"></a>Files</h3></div></div></div>
<p>The significant files are:</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">ChangeLog</span></p></td>
<td><p>Change log for the stylesheets, etc.</p></td>
</tr>
<tr>
<td><p><span class="term">README</span></p></td>
<td><p>README file</p></td>
</tr>
<tr>
<td><p><span class="term">conversion-lib.xsl</span></p></td>
<td><p>Stylesheet with common templates</p></td>
</tr>
<tr>
<td><p><span class="term">dump-info.xml</span></p></td>
<td><p>XML file controlling output</p></td>
</tr>
<tr>
<td><p><span class="term">fo-all-property-h-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping fo-all-property.h</p></td>
</tr>
<tr>
<td><p><span class="term">fo-context-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping fo-context.[ch]</p></td>
</tr>
<tr>
<td><p><span class="term">fo-object-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping fo-*.c and fo-*{-private}?.h</p></td>
</tr>
<tr>
<td><p><span class="term">fo-property-object-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping fo-property-*.[ch]</p></td>
</tr>
<tr>
<td><p><span class="term">Makefile.am</span></p></td>
<td><p>Automake file</p></td>
</tr>
<tr>
<td><p><span class="term">xmlroff-property-decl-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping entity declarations for property documentation files</p></td>
</tr>
<tr>
<td><p><span class="term">xmlroff-property-ref-dump.xsl</span></p></td>
<td><p>Stylesheet for dumping entity references for property documentation files</p></td>
</tr>
</tbody>
</table></div>
<p>Any other XSL files are evolutionary dead ends.</p>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="make-targets"></a>Make targets</h3></div></div></div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">make</span></p></td>
<td><p>Makes fo-context.[ch], fo/fo-*.c, fo/fo-*{-private}?.h, and property/fo-property-*.[ch].</p></td>
</tr>
<tr>
<td><p><span class="term">make all</span></p></td>
<td><p>As above.</p></td>
</tr>
<tr>
<td><p><span class="term">make fo-context-dump</span></p></td>
<td><p>Makes fo-context.[ch].</p></td>
</tr>
<tr>
<td><p><span class="term">make fo-object-dump</span></p></td>
<td><p>Makes fo/fo-*.c, fo/fo-*{-private}?.h.</p></td>
</tr>
<tr>
<td><p><span class="term">make fo-property-object-dump</span></p></td>
<td><p>Makes property/fo-property-*.[ch].</p></td>
</tr>
<tr>
<td><p><span class="term">make fo-all-property-h-dump</span></p></td>
<td><p>Makes property/fo-all-property.h.</p></td>
</tr>
<tr>
<td><p><span class="term">make property-entity-decl-dump</span></p></td>
<td><p>Makes xmlroff-property-decl.ent.</p></td>
</tr>
<tr>
<td><p><span class="term">make property-entity-ref-dump</span></p></td>
<td><p>Makes xmlroff-property-ref.ent.</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>