diff --git a/README.md b/README.md
index 143c762b1d9b415e8f9d18e526fc223e9a16b92d..a031fbc14c7a282c390f52284f75d7df5606edb2 100644 (file)
--- a/README.md
+++ b/README.md
What are the big pieces of bionic?
----------------------------------
-libc/ --- libc.so, libc.a
- The C library. Stuff like fopen(3) and kill(2).
-libm/ --- libm.so, libm.a
- The math library. Traditionally Unix systems kept stuff like sin(3) and
- cos(3) in a separate library to save space in the days before shared
- libraries.
-libdl/ --- libdl.so
- The dynamic linker interface library. This is actually just a bunch of
- stubs that the dynamic linker replaces with pointers to its own
- implementation at runtime. This is where stuff like dlopen(3) lives.
-libstdc++/ --- libstdc++.so
- The C++ ABI support functions. The C++ compiler doesn't know how to
- implement thread-safe static initialization and the like, so it just calls
- functions that are supplied by the system. Stuff like __cxa_guard_acquire
- and __cxa_pure_virtual live here.
-
-linker/ --- /system/bin/linker and /system/bin/linker64
- The dynamic linker. When you run a dynamically-linked executable, its ELF
- file has a DT_INTERP entry that says "use the following program to start me".
- On Android, that's either linker or linker64 (depending on whether it's a
- 32-bit or 64-bit executable). It's responsible for loading the ELF executable
- into memory and resolving references to symbols (so that when your code tries
- to jump to fopen(3), say, it lands in the right place).
-
-tests/ --- unit tests
- The tests/ directory contains unit tests. Roughly arranged as one file per
- publicly-exported header file.
-benchmarks/ --- benchmarks
- The benchmarks/ directory contains benchmarks.
+#### libc/ --- libc.so, libc.a
+
+The C library. Stuff like `fopen(3)` and `kill(2)`.
+
+#### libm/ --- libm.so, libm.a
+
+The math library. Traditionally Unix systems kept stuff like `sin(3)` and
+`cos(3)` in a separate library to save space in the days before shared
+libraries.
+
+#### libdl/ --- libdl.so
+
+The dynamic linker interface library. This is actually just a bunch of stubs
+that the dynamic linker replaces with pointers to its own implementation at
+runtime. This is where stuff like `dlopen(3)` lives.
+
+#### libstdc++/ --- libstdc++.so
+
+The C++ ABI support functions. The C++ compiler doesn't know how to implement
+thread-safe static initialization and the like, so it just calls functions that
+are supplied by the system. Stuff like `__cxa_guard_acquire` and
+`__cxa_pure_virtual` live here.
+
+#### linker/ --- /system/bin/linker and /system/bin/linker64
+
+The dynamic linker. When you run a dynamically-linked executable, its ELF file
+has a `DT_INTERP` entry that says "use the following program to start me". On
+Android, that's either `linker` or `linker64` (depending on whether it's a
+32-bit or 64-bit executable). It's responsible for loading the ELF executable
+into memory and resolving references to symbols (so that when your code tries to
+jump to `fopen(3)`, say, it lands in the right place).
+
+#### tests/ --- unit tests
+
+The `tests/` directory contains unit tests. Roughly arranged as one file per
+publicly-exported header file.
+
+#### benchmarks/ --- benchmarks
+
+The `benchmarks/` directory contains benchmarks.
What's in libc/?
----------------
+<pre>
libc/
arch-arm/
arch-arm64/
zoneinfo/
# Android-format time zone data.
# See 'Updating tzdata' later.
+</pre>
Adding system calls
1. Run update-tzdata.py.
+Verifying changes
+-----------------
+
+If you make a change that is likely to have a wide effect on the tree (such as a
+libc header change), you should run `make checkbuild`. A regular `make` will
+_not_ build the entire tree; just the minimum number of projects that are
+required for the device. Tests, additional developer tools, and various other
+modules will not be built. Note that `make checkbuild` will not be complete
+either, as `make tests` covers a few additional modules, but generally speaking
+`make checkbuild` is enough.
+
+
Running the tests
-----------------