rockbox/firmware/include
Thomas Jarosch 66df5f3891 Improve core_alloc() / buflib_alloc() documentation
Document the fact that buffers are movable by default.
Care must be taken to not pass them to functions that yield().

Also clarify other things:
- Passing NULL as "ops" to buflib_alloc_ex() causes
  buffers to be movable by default (but not shrinkable).

- If you want shrinkable buffers during compaction,
  you have to provide a shrink callback.

- To disable buffer movement, you have to pass NULL
  for the move_callback inside the callback structure.

- The concept of default callbacks was removed
  long ago, remove the only reference of it.

Change-Id: I3bf0ea6b08b507d80a19f3c2c835aca32b3f7800
2015-01-02 18:51:15 +01:00
..
_ansi.h Move some gcc extensions to new gcc_extensions.h header 2010-07-25 14:44:29 +00:00
assert.h strncpy.c / assert.h : need to include _ansi.h 2010-07-25 14:53:06 +00:00
bitarray.h Add multi-reader, single-writer locks to kernel. 2014-08-06 02:47:47 +02:00
buflib.h Improve core_alloc() / buflib_alloc() documentation 2015-01-02 18:51:15 +01:00
core_alloc.h buflib: Properly support allocations without any name, to avoid wasting space 2014-02-02 19:40:38 +01:00
crc32-mi4.h crc-mi4: use const lookup table for crc 2014-07-07 12:54:50 +02:00
crc32-rkw.h Add RKW firmware file format loader 2012-03-04 00:34:26 +01:00
crc32.h buflib: Add crc field protecting buflib cookie integrity 2014-01-16 10:17:39 +01:00
dbgcheck.h Rockbox as an application: Replace many occurences of #ifdef SIMULATOR with #if (CONFIG_PLATFORM & PLATFORM_HOSTED) (or equivalently). 2010-06-21 16:53:00 +00:00
diacritic.h FS#11187 - diacritic.c is in 'drivers' but it does not belong there 2010-04-07 20:41:18 +00:00
dir.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
dircache.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
dircache_redirect.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
disk_cache.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
file.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
file_internal.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
fileobj_mgr.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
filesystem-native.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
font_cache.h fonts: Do not unload completely on USB. 2014-01-15 23:37:39 +01:00
format.h format() (and its alias vuprintf) return values are uncheck -> void 2010-09-20 08:55:45 +00:00
fs_attr.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
gcc_extensions.h Add a NO_INLINE attribute to gcc_extensions. 2012-04-26 16:04:43 -04:00
linked_list.h Add common linked list functions 2014-08-16 00:27:01 -04:00
loader_strerror.h Move load_firmware() to separate file 2013-06-27 13:50:11 +02:00
lru.h Finish r30818 revert 2011-10-22 08:23:52 +00:00
memset16.h Move memset6() declaration to string-extra.h, kills a warning compiling for android since it ships a memory.h. 2010-08-12 13:55:01 +00:00
rb-loader.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
rbendian.h Fix up maemo port after byte swap header refactoring 2014-12-17 23:29:44 +01:00
rbunicode.h Rewrite filesystem code (WIP) 2014-08-30 03:48:23 +02:00
strcasecmp.h Move c/h files implementing/defining standard library stuff into a new libc directory, also standard'ify some parts of the code base (almost entirely #include fixes). 2010-05-06 21:04:40 +00:00
strcasestr.h Fix tabs in .c and .h files in firmware/ 2011-05-08 11:37:18 +00:00
string-extra.h Hopefully fix most of the errors and warnings from the last push 2014-08-29 23:36:11 -04:00
strlcat.h Move c/h files implementing/defining standard library stuff into a new libc directory, also standard'ify some parts of the code base (almost entirely #include fixes). 2010-05-06 21:04:40 +00:00
strlcpy.h Move c/h files implementing/defining standard library stuff into a new libc directory, also standard'ify some parts of the code base (almost entirely #include fixes). 2010-05-06 21:04:40 +00:00
strnatcmp.h
strtok_r.h Make the sim buildable with mingw again 2010-05-14 22:57:52 +00:00
timefuncs.h Remove USB time sync code when there's no RTC. 2011-12-16 00:09:28 +00:00
version.h Prevent spurious recompiles on account of changed version. 2014-08-28 15:48:56 +02:00