dump-build-information/Readme.md

## Motivation
Print as much information about the build process as you can get from within the binary.
Espacially, compiler flags - they are quite important when comparing performance.
The information should be included in the binary, so it can't be lost and is right next to, for example, a benchmark result.
So there's no chance to mix up different flags.

## Other options
Another option would be -g -grecord-gcc-switches and search for DW_AT_producer.
Sadly, this doesn't produce the wanted information with clang:
  * clang++: DW_AT_producer    : (indirect string, offset: 0x0): clang version 3.9.1 (tags/RELEASE_391/final)
  * g++: DW_AT_producer    : (indirect string, offset: 0x37): GNU C++ 4.9.4 -mtune=generic -march=x86-64 -g -O3 -frecord-gcc-switches -fstack-protector-strong

Passing the CPPFLAGS and so on as -DMY_FLAGS=.... to the compiler call will not include some information set by the compiler itself (compare the parameters set in the Makefile with the printed output).

## Known limitations
* Works only with GCC for now.
fix h2 lines 2017-08-27 12:24:17 +00:00			`## Motivation`
add more text to the readme 2017-08-27 12:23:19 +00:00			`Print as much information about the build process as you can get from within the binary.`
			`Espacially, compiler flags - they are quite important when comparing performance.`
			`The information should be included in the binary, so it can't be lost and is right next to, for example, a benchmark result.`
			`So there's no chance to mix up different flags.`

fix h2 lines 2017-08-27 12:24:17 +00:00			`## Other options`
add more text to the readme 2017-08-27 12:23:19 +00:00			`Another option would be -g -grecord-gcc-switches and search for DW_AT_producer.`
			`Sadly, this doesn't produce the wanted information with clang:`
			`* clang++: DW_AT_producer : (indirect string, offset: 0x0): clang version 3.9.1 (tags/RELEASE_391/final)`
			`* g++: DW_AT_producer : (indirect string, offset: 0x37): GNU C++ 4.9.4 -mtune=generic -march=x86-64 -g -O3 -frecord-gcc-switches -fstack-protector-strong`

			`Passing the CPPFLAGS and so on as -DMY_FLAGS=.... to the compiler call will not include some information set by the compiler itself (compare the parameters set in the Makefile with the printed output).`

fix h2 lines 2017-08-27 12:24:17 +00:00			`## Known limitations`
add more text to the readme 2017-08-27 12:23:19 +00:00			`* Works only with GCC for now.`