platform_bionic/docs
Elliott Hughes ecaa192929 Add a README.md to docs/, as a guide to what we have available.
I was actually here to add some new documentation, but realized there wasn't really a good place to put it...

Change-Id: I8a2fc93e61a89e87aa53dd0beb9dfcc6561687ca
2024-06-04 18:20:05 +00:00
..
img Publish the current draft of my ELF TLS doc 2018-11-09 15:24:16 -08:00
32-bit-abi.md Admit to another LP32 bug. 2024-02-13 00:43:24 +00:00
clang_fortify_anatomy.md docs: add a clang_fortify_anatomy doc 2022-06-07 13:28:51 -07:00
defines.md Clarify the defines documentation further. 2023-05-18 17:10:37 +00:00
EINTR.md Add some documentation about EINTR. 2021-12-13 10:16:57 -08:00
elf-tls.md ELS TLS documentation: s/module/module_id/. 2023-04-03 14:31:37 +00:00
fdsan.md s/master/main/ 2023-10-04 23:36:48 +00:00
fdtrack.md s/master/main/ 2023-10-04 23:36:48 +00:00
libc_assembler.md More cleanup for #inclusivefixit. 2020-07-31 10:35:03 -07:00
native_allocator.md s/master/main/ 2023-10-04 23:36:48 +00:00
NOTICE Fix/update notices. 2021-02-16 15:06:50 -08:00
README.md Add a README.md to docs/, as a guide to what we have available. 2024-06-04 18:20:05 +00:00
status.md Update the _FORTIFY_SOURCE documentation. 2024-05-02 19:13:37 +00:00

bionic documentation

bionic is Android's C library, math library, and dynamic linker.

User documentation

  • Android bionic status - where we are in terms of standards, and what changed with each OS release.
  • 32-bit ABI bugs - historical accidents we can never fix.
  • EINTR - what is the EINTR failure, and how can code deal with it?
  • When to use which #define - how to choose between __ANDROID__ and __BIONIC__ and all the other options for conditional compilation.
  • fdsan - bionic's file descriptor sanitizer, which detects use-after-close() bugs.
  • fdtrack - bionic's file descriptor tracker, which helps debug file descriptor leaks.

Maintainer documentation

If you're trying to make changes to bionic itself, start with the bionic maintainer documentation.

We also have more detail on several specific parts of the implementation: