Skip to content

Commit bcd9ee1

Browse files
committed
update documentation for simdjson submodule
Change-Id: I9a3f9a33dd4f2e6fcb06e9c35146f14bf61c914d
1 parent c5cf681 commit bcd9ee1

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@ And finally a daemon that stores core, memory and QPI counters in shared memory
5555
Building PCM Tools
5656
--------------------------------------------------------------------------------
5757

58+
Clone PCM repository with submodules:
59+
60+
```
61+
git clone --recursive https://github.com/opcm/pcm.git
62+
```
63+
64+
or clone the repository first, and then update submodules with:
65+
66+
```
67+
git submodule update --init --recursive
68+
```
69+
5870
Install cmake then:
5971

6072
```

doc/PCM_RAW_README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ pcm-raw -e core/config=0x00000000004300c5,name=BR_MISP_RETIRED.ALL_BRANCHES -e c
3838
Collecting Events By Names From Event Lists (https://download.01.org/perfmon/)
3939
--------------------------------------------------------------------------------
4040

41-
pcm-raw can also automatically lookup the events from the json event lists (https://download.01.org/perfmon/) and translate them to raw encodings itself. To make this work you need to download simdjson library in the PCM source directory and recompile PCM:
41+
pcm-raw can also automatically lookup the events from the json event lists (https://download.01.org/perfmon/) and translate them to raw encodings itself. To make this work you need to checkout PCM with simdjson submodule:
42+
43+
* use git clone --recursive flag when cloning pcm repository, or
44+
* update submodule with command `git submodule update --init --recursive`, or
45+
* download simdjson library in the PCM source directory and recompile PCM:
4246

4347
1. change to PCM 'src/' directory
4448
2. git clone https://github.com/simdjson/simdjson.git

src/CMakeLists.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ if(SIMDJSON_IS_APPLICABLE)
113113
else()
114114
message(WARNING
115115
" ${CMAKE_CURRENT_SOURCE_DIR}/simdjson/singleheader/simdjson.h doesn't exist\n"
116-
" Run 'git clone https://github.com/simdjson/simdjson.git' in 'src' directory to get simdjson library")
116+
" Use `git clone --recursive` flag when cloning pcm repository to clone simdjson submodule as well or\n"
117+
" update submodule with command 'git submodule update --init --recursive' or\n"
118+
" run 'git clone https://github.com/simdjson/simdjson.git' in 'src' directory to get simdjson library")
117119
endif()
118120
endif(simdjson_FOUND)
119121
endif(SIMDJSON_IS_APPLICABLE)

0 commit comments

Comments
 (0)