Re: [PATCH 05/11] docs: Get rid of the "basic profiling" guide

From: Mauro Carvalho Chehab
Date: Wed Oct 26 2016 - 20:20:58 EST


Em Wed, 26 Oct 2016 17:19:33 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> The document has not been touched in over 11 years and doesn't reflect how
> profiling is done in the perf era.

I sent you an alternative patch for this one, but I'm OK if you want to
just nuke this file.

>
> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
> ---
> Documentation/admin-guide/basic-profiling.rst | 68 ---------------------------
> Documentation/admin-guide/index.rst | 1 -
> 2 files changed, 69 deletions(-)
> delete mode 100644 Documentation/admin-guide/basic-profiling.rst
>
> diff --git a/Documentation/admin-guide/basic-profiling.rst b/Documentation/admin-guide/basic-profiling.rst
> deleted file mode 100644
> index 72babc71b771..000000000000
> --- a/Documentation/admin-guide/basic-profiling.rst
> +++ /dev/null
> @@ -1,68 +0,0 @@
> -Basic kernel profiling
> -======================
> -
> -
> -These instructions are deliberately very basic. If you want something clever,
> -go read the real docs ;-)
> -
> -Please don't add more stuff, but feel free to
> -correct my mistakes ;-) (mbligh@xxxxxxxxxxx)
> -
> -Thanks to John Levon, Dave Hansen, et al. for help writing this.
> -
> -``<test>`` is the thing you're trying to measure.
> -Make sure you have the correct ``System.map`` / ``vmlinux`` referenced!
> -
> -It is probably easiest to use ``make install`` for linux and hack
> -``/sbin/installkernel`` to copy ``vmlinux`` to ``/boot``, in addition to
> -``vmlinuz``, ``config``, ``System.map``, which are usually installed by default.
> -
> -Readprofile
> ------------
> -
> -A recent ``readprofile`` command is needed for 2.6, such as found in util-linux
> -2.12a, which can be downloaded from:
> -
> - http://www.kernel.org/pub/linux/utils/util-linux/
> -
> -Most distributions will ship it already.
> -
> -Add ``profile=2`` to the kernel command line.
> -
> -Some ``readprofile`` commands::
> -
> - clear readprofile -r
> - <test>
> - dump output readprofile -m /boot/System.map > captured_profile
> -
> -Oprofile
> ---------
> -
> -Get the source (see Changes for required version) from
> -http://oprofile.sourceforge.net/ and add ``idle=poll`` to the kernel command
> -line.
> -
> -Configure with ``CONFIG_PROFILING=y`` and ``CONFIG_OPROFILE=y`` & reboot on new kernel::
> -
> - ./configure --with-kernel-support
> - make install
> -
> -For superior results, be sure to enable the local APIC. If opreport sees
> -a 0Hz CPU, APIC was not on. Be aware that idle=poll may mean a performance
> -penalty.
> -
> -One time setup::
> -
> - opcontrol --setup --vmlinux=/boot/vmlinux
> -
> -Some ``opcontrol`` commands::
> -
> - clear opcontrol --reset
> - start opcontrol --start
> - <test>
> - stop opcontrol --stop
> - dump output opreport > output_file
> -
> -To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file``
> -
> -A reset is needed to clear old statistics, which survive a reboot.
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index d737ae71efc6..2872c0c70ea4 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -58,4 +58,3 @@ configure specific aspects of kernel behavior to your liking.
> binfmt-misc
> mono
> java
> - basic-profiling



Thanks,
Mauro