LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Jiri Olsa <jolsa@kernel.org>
To: linux-kernel@vger.kernel.org
Cc: Jiri Olsa <jolsa@kernel.org>,
	Alexis Berlemont <alexis.berlemont@gmail.com>,
	Arnaldo Carvalho de Melo <acme@redhat.com>,
	Borislav Petkov <bp@alien8.de>,
	Corey Ashford <cjashfor@linux.vnet.ibm.com>,
	David Ahern <dsahern@gmail.com>,
	Frederic Weisbecker <fweisbec@gmail.com>,
	Ingo Molnar <mingo@kernel.org>,
	Namhyung Kim <namhyung@kernel.org>,
	Paul Mackerras <paulus@samba.org>,
	Peter Zijlstra <peterz@infradead.org>,
	Stephane Eranian <eranian@google.com>
Subject: [PATCH 31/36] perf build: Add build documentation
Date: Mon, 26 Jan 2015 11:12:31 +0100	[thread overview]
Message-ID: <1422267156-13873-32-git-send-email-jolsa@kernel.org> (raw)
In-Reply-To: <1422267156-13873-1-git-send-email-jolsa@kernel.org>

Adding file describing the basics of perf build process.

Signed-off-by: Jiri Olsa <jolsa@kernel.org>
Tested-by: Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
Tested-by: Will Deacon <will.deacon@arm.com>
Cc: Alexis Berlemont <alexis.berlemont@gmail.com>
Cc: Arnaldo Carvalho de Melo <acme@redhat.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: Ingo Molnar <mingo@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
---
 tools/perf/Documentation/Build.txt | 49 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 tools/perf/Documentation/Build.txt

diff --git a/tools/perf/Documentation/Build.txt b/tools/perf/Documentation/Build.txt
new file mode 100644
index 000000000000..f6fc6507ba55
--- /dev/null
+++ b/tools/perf/Documentation/Build.txt
@@ -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
-- 
1.9.3


  parent reply	other threads:[~2015-01-26 10:15 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-26 10:12 [PATCHv4 00/36] perf tools: New build framework Jiri Olsa
2015-01-26 10:12 ` [PATCH 01/36] tools build: Add new build support Jiri Olsa
2015-01-26 10:12 ` [PATCH 02/36] tools build: Add detected config support Jiri Olsa
2015-01-26 10:12 ` [PATCH 03/36] tools build: Add subdir support Jiri Olsa
2015-01-26 10:12 ` [PATCH 04/36] perf tools: Remove api fs object from python build Jiri Olsa
2015-01-26 10:12 ` [PATCH 05/36] perf build: Disable make's built-in rules Jiri Olsa
2015-01-26 10:12 ` [PATCH 06/36] perf build: Add bench objects building Jiri Olsa
2015-01-26 10:12 ` [PATCH 07/36] perf build: Add tests " Jiri Olsa
2015-01-26 10:12 ` [PATCH 08/36] perf build: Add builtin " Jiri Olsa
2015-01-26 10:12 ` [PATCH 09/36] perf build: Add libperf " Jiri Olsa
2015-01-26 10:12 ` [PATCH 10/36] perf build: Add probe " Jiri Olsa
2015-01-26 10:12 ` [PATCH 11/36] perf build: Add dwarf " Jiri Olsa
2015-01-26 10:12 ` [PATCH 12/36] perf build: Add dwarf unwind " Jiri Olsa
2015-01-26 10:12 ` [PATCH 13/36] perf build: Add ui " Jiri Olsa
2015-01-26 10:12 ` [PATCH 14/36] perf build: Add slang " Jiri Olsa
2015-01-26 10:12 ` [PATCH 15/36] perf build: Add gtk " Jiri Olsa
2015-01-26 10:12 ` [PATCH 16/36] perf build: Add scripts " Jiri Olsa
2015-01-26 10:12 ` [PATCH 17/36] perf build: Add perf regs " Jiri Olsa
2015-01-26 10:12 ` [PATCH 18/36] perf build: Add zlib " Jiri Olsa
2015-01-26 10:12 ` [PATCH 19/36] perf build: Add perf.o object building Jiri Olsa
2015-01-26 10:12 ` [PATCH 20/36] perf build: Add arch x86 objects building Jiri Olsa
2015-01-26 10:12 ` [PATCH 21/36] perf build: Add arch arm " Jiri Olsa
2015-01-26 10:12 ` [PATCH 22/36] perf build: Add arch arm64 " Jiri Olsa
2015-01-26 10:12 ` [PATCH 23/36] perf build: Add arch powerpc " Jiri Olsa
2015-01-26 10:12 ` [PATCH 24/36] perf build: Add arch s390 " Jiri Olsa
2015-01-26 10:12 ` [PATCH 25/36] perf build: Add arch sh " Jiri Olsa
2015-01-26 10:12 ` [PATCH 26/36] perf build: Add arch sparc " Jiri Olsa
2015-01-26 10:12 ` [PATCH 27/36] perf build: Add single target build framework support Jiri Olsa
2015-01-26 10:12 ` [PATCH 28/36] perf build: Remove directory dependency rules Jiri Olsa
2015-01-26 10:12 ` [PATCH 29/36] perf build: Remove uneeded variables Jiri Olsa
2015-01-26 10:12 ` [PATCH 30/36] perf build: Remove PERF-CFLAGS file Jiri Olsa
2015-01-26 10:12 ` Jiri Olsa [this message]
2015-01-26 10:12 ` [PATCH 32/36] tools lib api: Use tools build framework Jiri Olsa
2015-01-26 10:12 ` [PATCH 33/36] tools lib api: Rename libapikfs.a to libapi.a Jiri Olsa
2015-01-26 10:12 ` [PATCH 34/36] tools lib traceevent: Use tools build framework Jiri Olsa
2015-01-26 10:12 ` [PATCH 35/36] tools lib lockdep: " Jiri Olsa
2015-01-26 10:12 ` [PATCH 36/36] perf build: Display make commands on V=1 Jiri Olsa
2015-02-02 10:32 ` [PATCHv4 00/36] perf tools: New build framework Jiri Olsa
2015-02-02 15:26   ` David Ahern
  -- strict thread matches above, loose matches on Subject: below --
2015-01-20 16:38 [PATCHv3 " Jiri Olsa
2015-01-20 16:39 ` [PATCH 31/36] perf build: Add build documentation Jiri Olsa
2015-01-15 12:54 [PATCHv2 00/36] perf tools: New build framework Jiri Olsa
2015-01-15 12:55 ` [PATCH 31/36] perf build: Add build documentation Jiri Olsa

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1422267156-13873-32-git-send-email-jolsa@kernel.org \
    --to=jolsa@kernel.org \
    --cc=acme@redhat.com \
    --cc=alexis.berlemont@gmail.com \
    --cc=bp@alien8.de \
    --cc=cjashfor@linux.vnet.ibm.com \
    --cc=dsahern@gmail.com \
    --cc=eranian@google.com \
    --cc=fweisbec@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=paulus@samba.org \
    --cc=peterz@infradead.org \
    --subject='Re: [PATCH 31/36] perf build: Add build documentation' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).