Merge branch 'main' of github.com:simotin13/CodeCoverage

Author: simotin13

README-ja.md

@@ -7,17 +7,22 @@ Pinのプラグインとして動作します。
 # サポートしているプラットフォーム
 - GNU/Linux
 
-# 使い方
-
-# Quick Start
+# 使い方(Quick Start)
 本レポジトリをダウンロードしてください。
+```
+git clone [email protected]:simotin13/CodeCoverage.git
+```
 
-また、実行にはPin本体が必要になります。
+実行にはPin本体が必要になります。
 Pin本体は[Intel Pin](https://www.intel.com/content/www/us/en/developer/articles/tool/pin-a-dynamic-binary-instrumentation-tool.html)のサイトからダウンロードする必要があります。
 
 ダウンロード＆ビルド、および実行例のスクリプトがこのレポジトリに含まれています。
 
 まずは、`00_setup.sh`を実行してください。
+```
+cd CodeCoverage/
+./00_setup.sh
+```
 
 `00_setup.sh` では、
 [Pin 3.27](https://software.intel.com/sites/landingpage/pintool/downloads/pin-3.27-98718-gbeaa5d51e-gcc-linux.tar.gz)
@@ -48,3 +53,12 @@ pinのツールをビルドする際の作法として、PIN本体のディレ
 ../pin-3.27-98718-gbeaa5d51e-gcc-linux/pin -t ./obj-intel64/CodeCoverage.so -- <target_module_path> <target_args...>
 ```
 のようにコマンドを実行してください。
+
+# 注意事項
+このカバレッジツールでは行番号の情報を取得するためにDWARFのデバッグ情報を利用しています。
+Pin 3.27ではデバッグ情報としてDWARF4をサポートしています。カバレッジの計測対象のアプリケーションのをビルドする際は `-g` オプションと `-gdwarf-4` オプションをつけてビルドしてください。
+
+例).
+```
+gcc -g -gdwarf-4 main.c
+```

README.md

@@ -7,12 +7,21 @@ This repository is a code coverage tool that utilizes [Pin](https://www.intel.co
 - GNU/Linux
 
 # How to use (Quick Start)
-Please download this repository.
+First, download this repository.
+```
+git clone [email protected]:simotin13/CodeCoverage.git
+```
 
-In addition, the Pin tool itself is required to run the code.
+Pin tool itself is required to run the code.
 You can download the Pin tool from the Intel Pin website.
 
-Scripts for downloading, building, and running examples are included in this repository. Please start by running `00_setup.sh.`
+Scripts for downloading, building, and running examples are included in this repository.
+Please start by running `00_setup.sh.`
+
+```
+cd CodeCoverage/
+./00_setup.sh
+```
 
 In `00_setup.sh`, Pin 3.27 is downloaded and extracted to the same directory as this repository. Then, the source code in this repository is built.
 
@@ -45,3 +54,11 @@ To run this tool, execute the following command:
 
 where <target_module_path> and <target_args...> are the path and any arguments for the target module you want to measure code coverage for.
 
+# Note
+This coverage tool uses DWARF debugging information to obtain line number information.
+Pin 3.27 supports DWARF4 as debugging information. When building the application for which you want to measure coverage, please build it with the `-g` and `-gdwarf-4` options.
+
+例).
+```
+gcc -g -gdwarf-4 main.c
+```