Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f819f703 authored by Jiri Olsa's avatar Jiri Olsa Committed by Arnaldo Carvalho de Melo
Browse files

perf build: Add build documentation 



Adding file describing the basics of perf build process.

Signed-off-by: default avatarJiri Olsa <jolsa@kernel.org>
Tested-by: default avatarSukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
Tested-by: default avatarWill Deacon <will.deacon@arm.com>
Cc: Alexis Berlemont <alexis.berlemont@gmail.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: Corey Ashford <cjashfor@linux.vnet.ibm.com>
Cc: David Ahern <dsahern@gmail.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Link: http://lkml.kernel.org/n/tip-ibgf7vxyduwohlqqfayl11xb@git.kernel.org


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent db848662

tools/perf/Documentation/Build.txt

0 → 100644
+49 −0
Original line number Diff line number Diff line 


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