From fb5929b9a4817ca7231ffed7b9cbb42982afa233 Mon Sep 17 00:00:00 2001 From: DCHii <13780064348@163.com> Date: Wed, 22 May 2024 15:55:19 +0800 Subject: [PATCH] Add readme description --- README.en.md | 23 +++++++++++++++++++++++ README.md | 23 +++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/README.en.md b/README.en.md index b139f6b..fd417fe 100644 --- a/README.en.md +++ b/README.en.md @@ -12,6 +12,29 @@ For sampling, symbols are resolved according to ips or pc from data packet. Each Symbol resolve module is developed on elfin-parser, a library for parsing elf and dwarf. The module manages all symbol data in well-designed data structures for fast query. +#### Download + +Git method: + +```shell +git clone --recurse-submodules https://gitee.com/openeuler/libkperf.git +``` +If you only use +```shell +git clone https://gitee.com/openeuler/libkperf.git +``` +Please continue with the execution +```shell +cd libkperf +git submodule update --init --recursive +``` + +When unable to use git: + +1. Download the libkperf compressed file and decompress it. + +2. Go to the third_party directory of libkperf on Gitee, click on the link(as shown in the example elfin-parser@13e57e2 Click on the submit ID after @), to redirect and download the compressed package of the third-party library. After decompression, place it in the third_party directory of the local libkperf project. (elfin Parser is necessary for installation) + #### Installation Run bash script: diff --git a/README.md b/README.md index 99ee66e..c4b274c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,29 @@ Pmu收集模块是在syscall perf_event_open上开发的,用于启用内核pmu 符号解析模块是在elfin-parser上开发的,elfin-parser是一个解析elf和dwarf的库。该模块以设计良好的数据结构管理所有符号数据,以实现快速查询。 +#### 下载 + +git方法: + +```shell +git clone --recurse-submodules https://gitee.com/openeuler/libkperf.git +``` +如果你只使用 +```shell +git clone https://gitee.com/openeuler/libkperf.git +``` +请再执行 +```shell +cd libkperf +git submodule update --init --recursive +``` + +无法使用git时: + +1.下载libkperf压缩包并解压。 + +2.进入gitee上的libkperf的third_party目录,点击链接(如elfin-parser@13e57e2,点击@后面的提交ID),进行跳转并下载第三方库的压缩包,解压后放置于本地的libkperf项目的third_party目录。(elfin-parser对于安装是必须的) + #### 安装 运行bash脚本: -- Gitee