perf build: Add build documentation
tip-bot for Jiri Olsa
merge botCommit-ID: f819f703a42eed63443cef796b1852e6baf985bd Gitweb: http://git.kernel.org/tip/f819f703a42eed63443cef796b1852e6baf985bd Author: Jiri Olsa <[email protected]> AuthorDate: Wed, 14 Jan 2015 19:05:27 +0100 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Thu, 12 Feb 2015 17:53:00 -0300
perf build: Add build documentation
Adding file describing the basics of perf build process.
Signed-off-by Jiri Olsa <[email protected]>
Tested-by Sukadev Bhattiprolu <[email protected]>
Tested-by Will Deacon <[email protected]>
Cc Alexis Berlemont <[email protected]>
Cc Borislav Petkov <[email protected]>
Cc Corey Ashford <[email protected]>
Cc David Ahern <[email protected]>
Cc Frederic Weisbecker <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Paul Mackerras <[email protected]>
Cc Peter Zijlstra <[email protected]>
Cc Stephane Eranian <[email protected]>
Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
--- tools/perf/Documentation/Build.txt | 49 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+)
tools/perf/Documentation/Build.txt new file +49 -0
@@ -0,0 +1,49 @@ + +1) perf build +============= +The perf build process consists of several separated building blocks, +which are linked together to form the perf binary: + - libperf library (static) + - perf builtin commands + - traceevent library (static) + - GTK ui library + +Several makefiles govern the perf build: + + - Makefile + top level Makefile working as a wrapper that calls the main + Makefile.perf with a -j option to do parallel builds. + + - Makefile.perf + main makefile that triggers build of all perf objects including + installation and documentation processing. + + - tools/build/Makefile.build + main makefile of the build framework + + - tools/build/Build.include + build framework generic definitions + + - Build makefiles + makefiles that defines build objects + +Please refer to tools/build/Documentation/Build.txt for more +information about build framework. + + +2) perf build +============= +The Makefile.perf triggers the build framework for build objects: + perf, libperf, gtk + +resulting in following objects: + $ ls *-in.o + gtk-in.o libperf-in.o perf-in.o + +Those objects are then used in final linking: + libperf-gtk.so <- gtk-in.o libperf-in.o + perf <- perf-in.o libperf-in.o + + +NOTE this description is omitting other libraries involved, only + focusing on build framework outcomes