From dfc000b389566d26d31f7102c60180fe43528c7b Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Tue, 1 Oct 2024 11:45:36 +0900
Subject: [PATCH] update: doc on how to run test

---
 docs/src/about_software.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/docs/src/about_software.md b/docs/src/about_software.md
index 087a62f..97eef52 100644
--- a/docs/src/about_software.md
+++ b/docs/src/about_software.md
@@ -27,8 +27,35 @@ backspaceでjulianモードに戻り(左側が`julia>`になってる)、`using
 テストでは実際にデータベースを作成している。
 デフォルトでは全部は実行しないが、master log fileをおき、かつ環境変数`LOCAL_TEST`を設定することで、master log fileが必要な工程まで含めて実行できる。[^1]
 
+Pkgモード(`]`を押す)で`test`とうつと実行できる。
+環境変数の設定は`ENV["LOCAL_TEST"] = "1"`とでも書く。
+自動でsqlite browserを開く設定になっている。
+
 [^1]: master log fileはgitには入れたくないので、このような形態をとっている。
 
+## Master logを用意する
+
+[`start-shiftwork`](https://gitlab.cern.ch/dhashimo/PS_Board_QAQC/-/blob/master/Software_Test/ShiftWorks/script/start-shiftwork?ref_type=heads)が生成するログファイル(同じリポジトリの`../log`のところ、通常はJATHub Masterにある)を`test/input/`以下に置く。
+以下のようにする。
+
+```sh
+$ tree -L 2 test/input/
+test/input/
+└── log
+    ├── 100.log
+    ├── 101_long.log
+    ├── 102_long.log
+    ├── 103.log
+    ├── 104_long.log
+    ├── 105.log
+    ├── 106_long.log
+    ├── 107.log
+    ├── 108_long.log
+    ├── 109_long.log
+    ├── 110.log
+...
+```
+
 # 新しいQAQCキャンペーン時に更新すべき内容
 
 - [`PSBoardDataBase.insert_qaqc_campaign_id`](@ref): キャンペーンの日時