annotate docs/ccguide/sbrk.refentry @ 2106:c4c7facbd082

Fixed up some warnings
author boisy
date Sat, 07 Oct 2006 12:11:22 +0000
parents 1d37d3a84a7c
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="sbrk">
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>Sbrk</refname>
574
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
4 <refname>Ibrk</refname>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
5 <refpurpose>request additional working memory</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
10 <funcprototype>
574
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
11 <funcdef>char *<function>sbrk</function></funcdef>
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
12 <paramdef>int <parameter>increase</parameter></paramdef>
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
13 </funcprototype>
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
14 <funcprototype>
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
15 <funcdef>char *<function>ibrk</function></funcdef>
c49be44efba2 All function prototypes are added.
roug
parents: 552
diff changeset
16 <paramdef>int <parameter>increase</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
17 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
18 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
19
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
20 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
21
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
22 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
23 <para>
604
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
24 Sbrk requests an allocation from free memory and returns a
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
25 pointer to its base.
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
26 </para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
27 <para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
28 "Sbrk()" requests the system to allocate "new" memory from
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
29 outside the initial allocation.
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
30 </para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
31 <para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
32 Users should read the Memory Management section of this manual
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
33 for a fuller explanation of the arrangement.
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
34 </para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
35 <para>
1d37d3a84a7c All refentries finished.
roug
parents: 574
diff changeset
36 Ibrk requests memory from inside the initial memory allocation.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
37 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
38 </refsect1>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
39
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
40 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
41 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
42 Sbrk and ibrk return -1 if the requested amount of contiguous
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
43 memory is unavailable.
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
44 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
45 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
46
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
47 </refentry>