annotate docs/ccguide/defdrive.refentry @ 2979:978396f33bb2

Move bootman to 3rdparty/wip and add a ReadMe file
author Tormod Volden <debian.tormod@gmail.com>
date Sat, 05 Apr 2014 10:19:12 +0200
parents 1e1552ce8388
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
1 <refentry id="defdrive">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
3 <refname>Defdrive</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
4 <refpurpose>get default system drive</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
5 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcprototype>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
10 <funcdef>char *<function>defdrive</function></funcdef>
634
1e1552ce8388 Convert to Docbook XML format
roug
parents: 552
diff changeset
11 <void/>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
12 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
13 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
14
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
15 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
16
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
17 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
18 <para>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
19 A call to defdrive returns a pointer to a string containing the
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
20 name of the default system drive. The method used is to
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
21 consult the "Init" module for the default directory name. The
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
22 name is copied to a static data area and a pointer to it is
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
23 returned.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
24 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
25 </refsect1>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
26
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
27 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
28 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
29 -1 is returned if the "Init" module cannot be linked to.
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
30 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
31 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
32
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
33 </refentry>