Merge pull request #26 from arkedge/feature/rename-examples-dir

Rename Examples/ -> examples/

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     name: mobc
     uses: arkedge/workflows-c2a/.github/workflows/build.yml@v2.5.0
     with:
-      c2a_dir: Examples/mobc
+      c2a_dir: examples/mobc
       c2a_custom_setup: |
         cd ../..
         pwd
@@ -27,7 +27,7 @@ jobs:
     name: subobc
     uses: arkedge/workflows-c2a/.github/workflows/build.yml@v2.5.0
     with:
-      c2a_dir: Examples/subobc
+      c2a_dir: examples/subobc
       c2a_custom_setup: |
         cd ../..
         pwd

.github/workflows/build_as_cxx.yml

@@ -25,13 +25,13 @@ jobs:
         run: ./setup.bat
 
       - name: cmake
-        working-directory: ./Examples/${{ matrix.example }}/src/s2e_mockup
+        working-directory: ./examples/${{ matrix.example }}/src/s2e_mockup
         run: |
           mkdir build
           cd build
           cmake --version
           cmake .. -A Win32
 
       - name: build
-        working-directory: ./Examples/${{ matrix.example }}/src/s2e_mockup/build
+        working-directory: ./examples/${{ matrix.example }}/src/s2e_mockup/build
         run: cmake --build .

.github/workflows/build_with_s2e.yml

@@ -95,5 +95,5 @@ jobs:
         run: |
           cl.exe
           cmake --version
-          cmake -G "Visual Studio 17 2022" -A Win32 -DCMAKE_CONFIGURATION_TYPES:STRING="Debug" -DEXT_LIB_DIR=../s2e-core/ExtLibraries -DFLIGHT_SW_DIR=../c2a-core -DC2A_NAME=Examples/${{ matrix.example }} -DUSE_C2A=ON
+          cmake -G "Visual Studio 17 2022" -A Win32 -DCMAKE_CONFIGURATION_TYPES:STRING="Debug" -DEXT_LIB_DIR=../s2e-core/ExtLibraries -DFLIGHT_SW_DIR=../c2a-core -DC2A_NAME=examples/${{ matrix.example }} -DUSE_C2A=ON
           cmake --build . --clean-first

.github/workflows/check_coding_rule.yml

@@ -30,7 +30,7 @@ jobs:
         id: check
         shell: bash -e {0}
         continue-on-error: true
-        working-directory: ./Examples/${{ matrix.example }}/src
+        working-directory: ./examples/${{ matrix.example }}/src
         run: |
           python ./src_core/Script/CI/check_coding_rule.py ./src_core/Script/CI/check_coding_rule.json | tee /tmp/coding-rule.log
           status="${PIPESTATUS[0]}"
@@ -45,7 +45,7 @@ jobs:
         run: |
           sed 's/.\/src_core\///g' < /tmp/coding-rule.log \
           | > ./coding-rule.log \
-            sed 's/.\/src_user/Examples\/${{ matrix.example }}\/src\/src_user/g'
+            sed 's/.\/src_user/examples\/${{ matrix.example }}\/src\/src_user/g'
           cat ./coding-rule.log
 
       - name: reviewdog(github-pr-review)

.gitignore

@@ -58,10 +58,10 @@ dkms.conf
 ._*
 
 # for c2a user sample
-Examples/mobc/src/src_core
-Examples/mobc/build
-Examples/subobc/src/src_core
-Examples/subobc/build
+examples/mobc/src/src_core
+examples/mobc/build
+examples/subobc/src/src_core
+examples/subobc/build
 *.pyc
 
 # Added by cargo

Docs/Driver/communication_with_components.md

@@ -96,14 +96,14 @@ C2A 間通信によって，以下のような機能が提供される．
 
 - OBC 間の簡易な Driver 実装と自動コード生成
     - [c2a-tlm-cmd-code-generator](https://github.com/ut-issl/c2a-tlm-cmd-code-generator) 参照．
-    - [`Examples/mobc/src/src_user/Drivers/Aocs`](/Examples/mobc/src/src_user/Drivers/Aocs/) などの多くのコードが自動生成される．
+    - [`examples/mobc/src/src_user/Drivers/Aocs`](/examples/mobc/src/src_user/Drivers/Aocs/) などの多くのコードが自動生成される．
 - OBC と地上局でネットワークを形成．
     - 地上局から MOBC をルーターとして， sub OBC へコマンド配送．
     - sub OBC のテレメトリを MOBC を経由して地上局まで配送．
     - OBC A から OBC B に対してコマンド発行 / テレメ送信．
     - 他
 
-C2A 間通信の具体的な実装については，本リポジトリに同封されている User Sample である [`Examples/mobc`](/Examples/mobc) と [`Examples/subobc`](/Examples/subobc) での通信（前者が MOBC，後者が AOBC を想定）を参考にされたい．
+C2A 間通信の具体的な実装については，本リポジトリに同封されている User Sample である [`examples/mobc`](/examples/mobc) と [`examples/subobc`](/examples/subobc) での通信（前者が MOBC，後者が AOBC を想定）を参考にされたい．
 具体的なドライバのコードは以下となる．
 
 - https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e9/Examples/mobc/src/src_user/Drivers/Aocs/aobc.c#L1-L172

Docs/Driver/overview.md

@@ -9,11 +9,11 @@ Driver とは，各コンポーネントとの通信において， HW 依存部
 
 実装方法は，基本的には [driver_super.h](https://github.com/arkedge/c2a-core/blob/develop/Drivers/Super/driver_super.h) をみればわかるようにしてあるが，現時点で
 
-- UART test: https://github.com/arkedge/c2a-core/blob/develop/Examples/mobc/src/src_user/Drivers/Etc/uart_test.c
-- GS: https://github.com/arkedge/c2a-core/blob/develop/Examples/mobc/src/src_user/Drivers/Com/gs.c
+- UART test: https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/Drivers/Etc/uart_test.c
+- GS: https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/Drivers/Com/gs.c
 - C2A 間通信:
-    - https://github.com/arkedge/c2a-core/blob/develop/Examples/mobc/src/src_user/Drivers/Aocs/aobc.c
-    - https://github.com/arkedge/c2a-core/blob/develop/Examples/subobc/src/src_user/Drivers/Etc/mobc.c
+    - https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/Drivers/Aocs/aobc.c
+    - https://github.com/arkedge/c2a-core/blob/develop/examples/subobc/src/src_user/Drivers/Etc/mobc.c
 
 が実装されているので，それを参考のこと．  
 `load_init_setting` については下を参照．

Docs/General/coding_rule.md

@@ -427,7 +427,7 @@ Settings/Modes/Transitions
 -> void BCL_load_sl_hoge(void);
 ```
 
-例として [Block Command Definitions](https://github.com/arkedge/c2a-core/blob/develop/Examples/mobc/src/src_user/TlmCmd/block_command_definitions.c) を参考にすること．
+例として [Block Command Definitions](https://github.com/arkedge/c2a-core/blob/develop/examples/mobc/src/src_user/TlmCmd/block_command_definitions.c) を参考にすること．
 
 
 ## 細かな記法 [M]

README.md

@@ -9,7 +9,7 @@
 ### C2A core
 - 各 C2A で共通利用される C2A の中核部のコード
 - 基本的には，各々の C2A user repository （サンプル： TBW） にて， git submodule で参照される．
-- core 開発のための最小限の user 部は [`Examples`](./Examples) にあり，これを用いてビルドし，検証する．
+- core 開発のための最小限の user 部は [`examples`](./examples) にあり，これを用いてビルドし，検証する．
 
 
 ## ドキュメント
@@ -27,13 +27,13 @@
 ### SILS (Software-In-the-Loop-Simulation) 環境
 - C2A は， [S2E](https://github.com/ut-issl/s2e-core) などの SILS を用いて，フライトソフトウェアがそのまま実行される SILS を構築できる．
 - つまり，ターゲットの OBC 上で動くソフトウェアが， PC などの上で，そのままエミュレートできる．
-- [`Examples/mobc`](./Examples/mobc) にある， 最小限の C2A 実行サンプルは， [S2E User for C2A Core](https://github.com/ut-issl/s2e-user-for-c2a-core) によってエミュレーション可能である．
-    - また， [`Examples/subobc`](./Examples/subobc) にある sub OBC (非 MOBC) の user 部を使うことで， C2A 間通信も模擬できる．
+- [`examples/mobc`](./examples/mobc) にある， 最小限の C2A 実行サンプルは， [S2E User for C2A Core](https://github.com/ut-issl/s2e-user-for-c2a-core) によってエミュレーション可能である．
+    - また， [`examples/subobc`](./examples/subobc) にある sub OBC (非 MOBC) の user 部を使うことで， C2A 間通信も模擬できる．
 
 ### テスト
-- 特定の user を仮定しないと，各種パラメタが確定しないため， [`Examples/mobc`](./Examples/mobc) でテストする．
-- C2A 間通信に関連する部分のテストのみは [`Examples/subobc`](./Examples/subobc) を用いる．
-- 詳細は [Test](./Examples/mobc/src/src_user/Test) 参照．
+- 特定の user を仮定しないと，各種パラメタが確定しないため， [`examples/mobc`](./examples/mobc) でテストする．
+- C2A 間通信に関連する部分のテストのみは [`examples/subobc`](./examples/subobc) を用いる．
+- 詳細は [Test](./examples/mobc/src/src_user/Test) 参照．
 
 ### ブランチ
 - `main`: リリース版（[詳細](./Docs/General/release.md)）

Script/CI/check_coding_rule.json

@@ -6,7 +6,7 @@
     "src_user/"
   ],
   "ignore_dirs" : [
-    "src_core/Examples",
+    "src_core/examples",
     "src_core/Docs",
     "src_core/Script"
   ],

Script/CI/check_encoding.json

@@ -37,6 +37,6 @@
     "Library/",
     "System/",
     "TlmCmd/",
-    "Examples/mobc/src/src_user/"
+    "examples/mobc/src/src_user/"
   ]
 }

Script/GitHooks/pre-commit

@@ -9,14 +9,14 @@ my $DEBUG = 0;
 my $err_flag = 0;
 
 my @Targets = (
-		"Examples/mobc/src/src_user/Settings/TlmCmd/DataBase/CMD_DB/SAMPLE_MOBC_CMD_DB.xlsm",
-		"Examples/mobc/src/src_user/Settings/TlmCmd/DataBase/TLM_DB/SAMPLE_MOBC_TLM_DB.xlsm",
-		"Examples/mobc/src/src_user/Settings/sils_define.h",
-		"Examples/mobc/src/src_user/Settings/build_settings.h",
-		"Examples/subobc/src/src_user/Settings/TlmCmd/DataBase/CMD_DB/SAMPLE_AOBC_CMD_DB.xlsm",
-		"Examples/subobc/src/src_user/Settings/TlmCmd/DataBase/TLM_DB/SAMPLE_AOBC_TLM_DB.xlsm",
-		"Examples/subobc/src/src_user/Settings/sils_define.h",
-		"Examples/subobc/src/src_user/Settings/build_settings.h",
+		"examples/mobc/src/src_user/Settings/TlmCmd/DataBase/CMD_DB/SAMPLE_MOBC_CMD_DB.xlsm",
+		"examples/mobc/src/src_user/Settings/TlmCmd/DataBase/TLM_DB/SAMPLE_MOBC_TLM_DB.xlsm",
+		"examples/mobc/src/src_user/Settings/sils_define.h",
+		"examples/mobc/src/src_user/Settings/build_settings.h",
+		"examples/subobc/src/src_user/Settings/TlmCmd/DataBase/CMD_DB/SAMPLE_AOBC_CMD_DB.xlsm",
+		"examples/subobc/src/src_user/Settings/TlmCmd/DataBase/TLM_DB/SAMPLE_AOBC_TLM_DB.xlsm",
+		"examples/subobc/src/src_user/Settings/sils_define.h",
+		"examples/subobc/src/src_user/Settings/build_settings.h",
 	);
 
 print "[] pwd\n" if $DEBUG;

TlmCmd/common_cmd_packet.h

@@ -11,7 +11,7 @@
 
 // ここで CCP_DEST_TYPE を定義する
 // 詳細は
-// - /Examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
+// - /examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
 // - https://github.com/arkedge/c2a-core/blob/develop/Docs/Core/communication.md
 // を参照
 /* 例

Examples/mobc/src/src_user/Test/README.md → examples/mobc/src/src_user/Test/README.md

@@ -1,7 +1,7 @@
 # C2A PYTEST
 - CI などで自動でテストできるようにした pytest．
 - C2A は現状関数レベルのテストはなく，コマンド送信とテレメ結果で判断する，結合テストのみしかない．
-- なお， C2A 間通信のテストについては， [Examples/subobc/src/src_user/Test](../../../../subobc/src/src_user/Test) を参照すること．
+- なお， C2A 間通信のテストについては， [examples/subobc/src/src_user/Test](../../../../subobc/src/src_user/Test) を参照すること．
 
 ## 環境
 - python3 系列と以下のライブラリ

Examples/subobc/README.md → examples/subobc/README.md

@@ -1,11 +1,11 @@
 # C2A SUB OBC USER SAMPLE for CORE DEVELOPMENT
 
 ## 概要
-C2A 間通信の開発のために， [`Examples/mobc`](/Examples/mobc) とセットで実行し，それと通信し合うことを目的とした sub OBC (非 MOBC) の User Sample.
+C2A 間通信の開発のために， [`examples/mobc`](/examples/mobc) とセットで実行し，それと通信し合うことを目的とした sub OBC (非 MOBC) の User Sample.
 
 ## 注意
 - sub OBC という名前だが，コード上は AOBC を想定している．（APID など）
 - あくまで C2A 間通信開発のためなので，最小限の Tlm, Cmd などしか登録されてないなど，大幅に省略している．
-- したがって，C2A の User のサンプルとしては， [`Examples/mobc`](/Examples/mobc) を参照するほうが望ましい．
+- したがって，C2A の User のサンプルとしては， [`examples/mobc`](/examples/mobc) を参照するほうが望ましい．
 - 一方で， MOBC との通信部分や， sub OBC としての振る舞いについてはこちらを参照すること．
 - C2A 間通信については， [`Docs/Driver/Communication with Components`](/Docs/Driver/communication_with_components.md) も参照すること．