From 15c64c39268a24e4470096cf3bee85bf3ef1e027 Mon Sep 17 00:00:00 2001
From: Oliver Schmidt
Date: Sat, 14 Mar 2015 18:41:57 +0100
Subject: [PATCH] Replaced 'Limits' with 'Notes'.
Quite some items in the 'Limits' sections aren't actual limitations so it seems appropriate to just use a more neutral term.
---
doc/funcref.sgml | 507 ++++++++++++++++++++++-------------------------
1 file changed, 236 insertions(+), 271 deletions(-)
diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index 60b8360ed..cc45d9037 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -744,8 +744,7 @@ communication.
+
- The function is actually a macro.
+
- The function is actually a macro.
+
- The function is actually a macro.
+
- The function is actually a macro.
- A "regular file" means anything with data in it. This might still mean
that special processing is needed, when accessing the file. Relative files of
@@ -841,8 +837,7 @@ the CBM systems are classified as being "regular" files, for example.
/
+
- The minimum blocksize that can be added is 6 bytes; the function will
ignore smaller blocks.
@@ -870,8 +865,7 @@ ignore smaller blocks.
/, / or /.
-
+
- Passing a pointer to a block that was is not the result of one of the
allocation functions, or that has been free'd will give unpredicable results.
@@ -921,8 +915,7 @@ be allocated from the heap using /.
+
- This function is of less use than usually assumed, since the returned
heap space may be available but not in one block. So even if this function
says that several times more heap space is available than needed,
[/ with an
argument of
+
]- Since operating system specific error code are - you guessed it -
operating system specific, the value in
+
- The randomness of the seed depends on the machine hardware.
+
- Since operating system specific error code are - you guessed it -
operating system specific, the parameter and the string returned depend on the
cc65 target.
@@ -1028,7 +1020,7 @@ used in presence of a prototype.
+
- The memory areas may not overlap, otherwise the results are undefined.
- The function is only available as fastcall function, so it may only be
used in presence of a prototype.
@@ -1054,7 +1046,7 @@ specified in the
+
- Bits 4 and 5 of the flags value in the The function is only available as fastcall function, so it may only be
@@ -1075,7 +1067,7 @@ used in presence of a prototype.
+
- The function is actually a macro.
- The inserted instruction may lead to unexpected results if no debugger
is present.
@@ -1099,7 +1091,7 @@ is present.
+
- The function is actually a macro.
- Disabling interrupts may lead to unexpected results.
@@ -1121,7 +1113,7 @@ already enabled (the default).
+
- The function is actually a macro.
- This function depends highly on the platform and environment.
@@ -1144,7 +1136,7 @@ and return the value read.
+
- The function is actually a macro.
- This function depends highly on the platform and environment.
- The order in which the two bytes are read is unspecified and may
@@ -1168,7 +1160,7 @@ depend of the address expression used.
+
- The function is actually a macro.
- This function depends highly on the platform and environment.
- Careless use will cause the program to act strange or may crash the
@@ -1193,7 +1185,7 @@ machine.
+
- The function is actually a macro.
- This function depends highly on the platform and environment.
- Careless use will cause the program to act strange or may crash the
@@ -1220,7 +1212,7 @@ depend of the address expression used.
+
- The function is actually a macro.
- Disabling interrupts may lead to unexpected results.
@@ -1261,7 +1253,7 @@ on stderr, then terminates the program with an exit code of 3.
+
- The return value is undefined if The function is only available as fastcall function, so it may only be
used in presence of a prototype.
@@ -1284,7 +1276,7 @@ used in presence of a prototype.
+
- The function is actually a macro.
+
- A maximum of 5 exit functions can be registered.
- There is no way to unregister an exit function.
- The function is only available as fastcall function, so it may only be
@@ -1366,7 +1358,7 @@ atmos_save("hires", 0xa000, 0xc000);
+
- There is no way to detect any conversion errors.
- The function does not check for an numerical overflow when converting.
- The function is only available as fastcall function, so it may only be
@@ -1393,7 +1385,7 @@ used in presence of a prototype.
+
- There is no way to detect any conversion errors.
- The function does not check for an numerical overflow when converting.
- The function is only available as fastcall function, so it may only be
@@ -1421,7 +1413,7 @@ used in presence of a prototype.
+
- Background colors are system dependent. The function may have no effect
on systems where the background color cannot be changed.
- The function is only available as fastcall function, so it may only be
@@ -1445,7 +1437,7 @@ used in presence of a prototype.
+
- Border colors are system dependent. The function may have no effect
on systems where the border color cannot be changed.
- The function is only available as fastcall function, so it may only
@@ -1474,8 +1466,7 @@ matches the one pointed to by
+
- The contents of the array must be sorted in ascending order according to
the compare function given.
- If there are multiple members that match the key, the function will
@@ -1500,8 +1491,7 @@ be used in presence of a prototype.
+
- The function is non standard and therefore only available in non ANSI
mode. You should use / instead.
- The function is only available as fastcall function, so it may only
@@ -1526,7 +1516,7 @@ be used in presence of a prototype.
/
+
- The function is specific to the C128.
- The function will not return to the caller.
@@ -1547,8 +1537,7 @@ be used in presence of a prototype.
of size
+
- Clearing the memory may not have the expected effect on all platforms:
pointers in the block may not be
+
-
+
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1659,7 +1648,7 @@ address as the current secondary address. If the device on the
channel is a serial device, which requires a TALK command and
sometimes a secondary address, function will send them over the
serial bus.
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1687,7 +1676,7 @@ secondary address if necessary. This routine always buffers the
current character, and defers sending it until the next byte is
buffered. When the UNLISTEN command is sent, the last byte will be
sent with an End or Identify (EOI).
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1716,7 +1705,7 @@ file, its device as the current device, and its secondary address as
the current secondary address. If the device on the channel uses the
serial bus, and therefore requires a LISTEN command and possibly a
secondary address, this information will be sent on the bus.
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1739,7 +1728,7 @@ only be used in presence of a prototype.
+
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1787,7 +1776,7 @@ the screen. Also, if the current input device was formerly a serial
device, the routine sends it an UNTALK command on the serial bus, and
if a serial device was formerly the current output device, the routine
sends it an UNLISTEN command.
-
+
-
/
+
-
+
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1888,7 +1877,7 @@ loaded into memory starting at the location specified by the header.
Function returns the address of the highest RAM location loaded.
Before this function can be called, the KERNAL SETLFS, and SETNAM
routines must be called.
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1914,7 +1903,7 @@ Input/Output operations. In order to specify the logical file number,
the device number, and the secondary address if any, the cbm_k_setlfs() function must first be called.
Likewise, in order to designate the filename, the cbm_k_setnam() function must be used first. After these two
functions are called, cbm_k_open() is then called.
-
+
-
/
+
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -1980,7 +1969,7 @@ only be used in presence of a prototype.
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -2001,7 +1990,7 @@ only be used in presence of a prototype.
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -2024,7 +2013,7 @@ only be used in presence of a prototype.
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -2050,7 +2039,7 @@ bus. Only devices previously commanded to LISTEN are affected. This
function is normally used after the host computer is finished sending data
to external devices. Sending the UNLISTEN commands the listening devices
to get off the serial bus so it can be used for other purposes.
-
+
-
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -2094,7 +2083,7 @@ at a specific screen position.
+
- The function is only available as fastcall function, so it may
only be used in presence of a prototype.
@@ -2118,7 +2107,7 @@ only be used in presence of a prototype.
no character available,
+
- If the system supports a keyboard buffer,
@@ -2140,7 +2129,7 @@ from this buffer and wait only if the buffer is empty.
+
- The character used to draw the horizontal line is system dependent.
If available, a line drawing character is used. Drawing a line that is partially
off screen leads to undefined behaviour.
@@ -2166,7 +2155,7 @@ used in presence of a prototype.
+
- The character used to draw the horizontal line is system dependent.
If available, a line drawing character is used. Drawing a line that is partially
off screen leads to undefined behaviour.
@@ -2192,7 +2181,7 @@ used in presence of a prototype.
+
- The function is only available as fastcall function, so it may only be
used in presence of a prototype.
@@ -2216,7 +2205,7 @@ used in presence of a prototype.
time used by the program. The time is returned in implementation defined
units. It can be converted to seconds by dividing by the value of the macro
+
- Since the machines, cc65 generated programs run on, cannot run multiple
processes, the function will actually return the time since some
implementation defined point in the past.
@@ -2257,7 +2246,7 @@ the upper left corner.
+
- The function is only available as fastcall function, so it may only
be used in presence of a prototype.
@@ -2280,7 +2269,7 @@ be used in presence of a prototype.
+
- The function is only available as fastcall function, so it may only
be used in presence of a prototype.
@@ -2303,7 +2292,7 @@ be used in presence of a prototype.
+
- / with
The function is only available as fastcall function, so it may only
@@ -2329,7 +2318,7 @@ be used in presence of a prototype.
formatted according to the format string given. The resulting string is output
to the console. /. -->
-
+
- Like all other
@@ -2354,7 +2343,7 @@ between
+
- Like all other The function is only available as fastcall function, so it may only
@@ -2381,7 +2370,7 @@ be used in presence of a prototype.
+
- Like all other The function is only available as fastcall function, so it may only
@@ -2408,7 +2397,7 @@ be used in presence of a prototype.
+
- Like all other The function is only available as fastcall function, so it may only
@@ -2435,7 +2424,7 @@ be used in presence of a prototype.
+
- Like all other The function is only available as fastcall function, so it may only
@@ -2463,7 +2452,7 @@ be used in presence of a prototype.
+
- The function is only available as fastcall function, so it may only
be used in presence of a prototype.
@@ -2485,7 +2474,7 @@ be used in presence of a prototype.
+
- The character used to draw the vertical line is system dependent.
If available, a line drawing character is used. Drawing a line that is partially
off screen leads to undefined behaviour.
@@ -2511,7 +2500,7 @@ used in presence of a prototype.
+
- The character used to draw the vertical line is system dependent.
If available, a line drawing character is used. Drawing a line that is partially
off screen leads to undefined behaviour.
@@ -2537,8 +2526,7 @@ used in presence of a prototype.
+
- The function is only available as fastcall function, so it may only
be used in presence of a prototype.
@@ -2562,7 +2550,7 @@ the contents of the memory window have been changed, these changes may be lost
if /,