numatop/0003-Update-README.patch

57 lines
1.4 KiB
Diff

From ff75e35508183b5ed39d50122c71293e8e65a86f Mon Sep 17 00:00:00 2001
From: Zhengjun Xing <zhengjun.xing@linux.intel.com>
Date: Mon, 31 Oct 2022 15:25:04 +0800
Subject: [PATCH 03/15] Update README
Update README, add "check" for build Build Dependencies, add tips
for running NumaTOP.
Signed-off-by: Zhengjun Xing <zhengjun.xing@linux.intel.com>
---
README.md | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 6910c78..d16a486 100644
--- a/README.md
+++ b/README.md
@@ -12,12 +12,34 @@ the `mgen` program for help information.
## Build Dependencies
-NumaTOP requires following libraries:
+NumaTOP requires following libraries or packages:
* numactl-devel or libnuma-dev(el)
* libncurses
* libpthread
+* check
+
+## Run NumaTOP
+
+NumaTOP requires running as root.
+ # ./numatop
+
+In many systems, the default max open files are 1024, for platforms (like SPR)
+that have more CPUs, they require the system with the max open files should
+bigger than 1024, otherwise, the error can be "Fail to setup perf":
+
+ # ulimit -n
+ 1024 <------the max open files are 1024
+ # ./numatop
+ NumaTOP is starting ...
+ Fail to setup perf (probably permission denied)!
+
+Need to enlarge the max open files:
+
+ # ulimit -n 8192
+ # ulimit -n
+ 8192 <------now the max open files are 8192
## Supported Kernels
--
2.31.1