Source Code Organization (MicroBenchmark Reference Manual)

The source code tree is organized onto the following directories:

. (Project Directory)
Contains common files such as README, NEWS and ChangeLog⁷. It also contains the main project definitions: Makefile.am and configure.ac.
build-aux/
Utilities needed for the build process⁸.
doc/
Documentation of the project, such as this document.
doc/examples/
Examples of the library usage. They can be executed with make run-examples. The output included into this manual can be regenerated by make regen-doc-examples.
etc/
Exported m4 macros and pkg-config files.
m4/
Macros for configure and Makefile generation. Most files are copied in by autoreconf. mbenchmark.m4 contains macros used by MicroBenchmark itself.
include/internal/
Header files for internal usage.
include/mbenchmark/
Header files installed by the library.
guile/
Guile modules.
lib/
Helper and language binding libraries.
src/
Core modules.
tests/
Test suite.

ChangeLog is generated using gnulib’s gitlog-to-changelog by the build process on git checkouts.

gitlog-to-changelog and test-driver.scm are downloaded at build time when they aren’t present.