From 1070827f12ca6613fde6f2abb8f8334cf4c3879c Mon Sep 17 00:00:00 2001 From: Lisa Nguyen Date: Thu, 29 Sep 2016 10:21:40 -0700 Subject: Update documentation for idlestat Add a BUILD file with instructions on how to cross-compile for arm and arm64. Also update the README file to inform users where they can submit feedback and patches to and fix trivial spelling errors. [Daniel Lezcano] : Reformated the text for better readability. Signed-off-by: Lisa Nguyen Signed-off-by: Daniel Lezcano --- BUILD | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README | 37 ++++++++++++++++++++++++++++++++++--- 2 files changed, 94 insertions(+), 3 deletions(-) create mode 100644 BUILD diff --git a/BUILD b/BUILD new file mode 100644 index 0000000..f8a58e7 --- /dev/null +++ b/BUILD @@ -0,0 +1,60 @@ +To build idlestat natively, run 'make' from the top-level directory. + +Cross Compiling for ARM +======================= + +These are instructions to cross compile for ARM and ARM64 on an Ubuntu system +running x86_64. + +Requirements +------------ + +Depending on the target platform, you will need to download either the gnueabi +or gnueabihf toolchain. + +For arm, run: + + 'sudo apt-get install gcc-arm-linux-gnueabi' + +or + + 'sudo apt-get install gcc-arm-linux-gnueabihf' + +Alternatively you can also download these toolchains from Linaro at: + + http://releases.linaro.org/components/toolchain/binaries/latest-5/arm-linux-gnueabi + +or + +http://releases.linaro.org/components/toolchain/binaries/latest-5/arm-linux-gnueabihf + +For arm64, go to: + + http://releases.linaro.org/components/toolchain/binaries/latest-5/aarch64-linux-gnu/ + +to download the latest aarch64 toolchain from Linaro. Then untar the toolchain +tarball. + +Add the aarch64 toolchain directory path to the PATH environment variable by +running 'export PATH=$PATH:' + +For instance: + + 'export PATH=$PATH:/home//gcc-linaro-5.3-2016.02-x86_64_aarch64-linux-gnu/bin' + +Steps +------ + +To build for arm, run from the top-level directory: + + 'make ARCH=arm CROSS_COMPILE=arm-linux-gnueabi-' + +To build for arm64, run from the top-level directory: + + 'make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu-' + +Usage +------ + +Please refer to the README file or the idlestat manpage for details on how to +use idlestat. diff --git a/README b/README index b519d1e..3203ba4 100644 --- a/README +++ b/README @@ -51,6 +51,37 @@ sudo ./idlestat --trace -f /tmp/mytrace -t 10 -- /bin/sleep 10 sudo ./idlestat --trace -f /tmp/myoutput -t 10 -- cyclictest -t 4 -i 2000 -q -D 5 Selective trace output -sudo ./idlestate --import -f /tmp/mytrace -w -sudo ./idlestate --import -f /tmp/mytrace -c -p -sudo ./idlestate --import -f /tmp/mytrace -p -w \ No newline at end of file +sudo ./idlestat --import -f /tmp/mytrace -w +sudo ./idlestat --import -f /tmp/mytrace -c -p +sudo ./idlestat --import -f /tmp/mytrace -p -w + +Bugs +---- + +If you believe that you have encountered a bug, please file a bug report on +Linaro Bugzilla at https://bugs.linaro.org. You may be prompted to register +for a new account first. + +Once you log in, click on +"New" --> "Power Management" --> "Idlestat" as the component. Then fill +in the form. + +Helpful tips for filing a bug report: + 1. Provide logs, be verbose as possible + 2. Outline steps to reproduce the bug + 3. Describe the environment you are running idlestat on (e.g. Android, + OpenEmbedded, Ubuntu, etc.) + 4. What hardware you're using + +Contribution +------------ + +If you wish to submit patches to improve idlestat, please send them to +the Linaro sched-tools mailing list at sched-tools@lists.linaro.org with +"PATCH IDLESTAT" as the subject prefix. + +Feedback +-------- + +Please submit questions and comments to the Linaro sched-tools mailing list at +sched-tools@lists.linaro.org with "idlestat" as part of the subject. -- cgit v1.2.3