update docs dir ref to snake case

arkedge · Jul 26, 2023 · 8e2192e · 8e2192e
1 parent 85d201d
commit 8e2192e
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 
 
 ## ドキュメント
-- ドキュメント:  https://github.com/arkedge/c2a-core/tree/develop/Docs
+- ドキュメント:  https://github.com/arkedge/c2a-core/tree/develop/docs
 - リファレンス (TBD):  https://github.com/ut-issl/c2a-reference
 
 
@@ -36,7 +36,7 @@
 - 詳細は [Test](./examples/mobc/src/src_user/Test) 参照．
 
 ### ブランチ
-- `main`: リリース版（[詳細](./Docs/General/release.md)）
+- `main`: リリース版（[詳細](./docs/general/release.md)）
 - `develop`: 概ね検証された最新版（beta 機能含む）
 - `feature/*` : 開発ブランチ
 - `hotfix/*` : 重大バグ修正用ブランチ

diff --git a/Script/CI/check_coding_rule.json b/Script/CI/check_coding_rule.json
@@ -7,7 +7,7 @@
   ],
   "ignore_dirs" : [
     "src_core/examples",
-    "src_core/Docs",
+    "src_core/docs",
     "src_core/Script"
   ],
   "ignore_files" : [

diff --git a/TlmCmd/Ccsds/space_packet.h b/TlmCmd/Ccsds/space_packet.h
@@ -8,7 +8,7 @@
  *          CommonCmdPacket    -> CmdSpacePacket
  *        つまり， C2A Core 実装においては， Space Packet に依存したコードを書いてはならない！（これを include してはならない）  FIXME: 完全にできてないので直す
  * @note  Packet Secondary Header は C2A 独自定義． いくつかのバージョンを用意している
- * @note  /Docs/Core/communication.md などを参照
+ * @note  /docs/core/communication.md などを参照
  * @note  packet 構造
  *        |---------+-------+-------+------------------|
  *        | Pos     | Pos   | size  | name             |

diff --git a/TlmCmd/common_cmd_packet.h b/TlmCmd/common_cmd_packet.h
@@ -12,7 +12,7 @@
 // ここで CCP_DEST_TYPE を定義する
 // 詳細は
 // - /examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
-// - https://github.com/arkedge/c2a-core/blob/develop/Docs/Core/communication.md
+// - https://github.com/arkedge/c2a-core/blob/develop/docs/core/communication.md
 // を参照
 /* 例
 typedef enum

diff --git a/c2a_core_main.h b/c2a_core_main.h
@@ -6,7 +6,7 @@ void C2A_core_main(void);
 
 // C2A の バージョンは Semantic Versioning を採用する
 // これらの番号は，リリース時に手動で合わせる
-// 詳細: Docs/General/release.md
+// 詳細: docs/general/release.md
 #define C2A_CORE_VER_MAJOR (3)
 #define C2A_CORE_VER_MINOR (10)
 #define C2A_CORE_VER_PATCH (0)

diff --git a/docs/README.md b/docs/README.md
@@ -27,24 +27,24 @@ C2A に関する説明の棲み分けは，次のようになっています．
 ## 目次
 
 1. General Information
-    1. [Overview](./General/overview.md)
-    1. [Release](./General/release.md)
-    1. [Coding Rule](./General/coding_rule.md)
-    1. [Coding Acronyms](./General/coding_acronyms.md)
+    1. [Overview](./general/overview.md)
+    1. [Release](./general/release.md)
+    1. [Coding Rule](./general/coding_rule.md)
+    1. [Coding Acronyms](./general/coding_acronyms.md)
 1. Application Layer
-    1. [Overview](./Application/overview.md)
+    1. [Overview](./application/overview.md)
     1. How to add a application
 1. Core Layer
     1. Overview
-    1. [Communication](./Core/communication.md)
-    1. [Tips](./Core/tips.md)
+    1. [Communication](./core/communication.md)
+    1. [Tips](./core/tips.md)
 1. Driver
-    1. [Overview](./Driver/overview.md)
-    1. [Communication with Components](./Driver/communication_with_components.md)
+    1. [Overview](./driver/overview.md)
+    1. [Communication with Components](./driver/communication_with_components.md)
 1. SILS
     1. Overview
-    1. [S2E Integration](./Sils/s2e_integration.md)
+    1. [S2E Integration](./sils/s2e_integration.md)
 1. Tips
-    1. [Parameter Settings](./Tips/parameter_settings.md)
+    1. [Parameter Settings](./tips/parameter_settings.md)
 1. Tools
-    1. [Overview](./Tools/overview.md)
+    1. [Overview](./tools/overview.md)
diff --git a/docs/core/communication.md b/docs/core/communication.md
@@ -2,7 +2,7 @@
 
 ## 概要
 通信関連，ネットワーク関連などをまとめる．  
-コンポーネント間通信については [Driver/Communication with Components](../Driver/communication_with_components.md) などを参照のこと．
+コンポーネント間通信については [Driver/Communication with Components](../driver/communication_with_components.md) などを参照のこと．
 
 
 ## C2A 内部を流れるパケットについて (Common Packet)
@@ -184,7 +184,7 @@ https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e
 
 
 ## C2A 間通信について
-上記 [#コマンド配送におけるルーティングについて](#コマンド配送におけるルーティングについて) や [Driver/Communication with Components#c2a-間通信](../Driver/communication_with_components.md#c2a-間通信) などを参照すること．
+上記 [#コマンド配送におけるルーティングについて](#コマンド配送におけるルーティングについて) や [Driver/Communication with Components#c2a-間通信](../driver/communication_with_components.md#c2a-間通信) などを参照すること．
 
 
 ## CCSDS 準拠状況

diff --git a/docs/driver/communication_with_components.md b/docs/driver/communication_with_components.md
@@ -2,7 +2,7 @@
 
 ## 概要
 コンポーネント間通信などをまとめる．  
-なお，地上局との通信関連や， CCSDS などについて，衛星内コンポーネントのネットワーク関連などについては [Core Layer/Communication](../Core/communication.md) を参照のこと．
+なお，地上局との通信関連や， CCSDS などについて，衛星内コンポーネントのネットワーク関連などについては [Core Layer/Communication](../core/communication.md) を参照のこと．
 
 
 ## 通信レイヤ
@@ -14,7 +14,7 @@ CCSDS における APID によって制御されるデータ配送はネット
 
 この層を流れるデータ単位を `Packet` と呼ぶ．
 
-C2A では，地上局との通信や C2A 間通信において， [Core Layer/Communication](../Core/communication.md) の Common Packet が標準的に使用される．  
+C2A では，地上局との通信や C2A 間通信において， [Core Layer/Communication](../core/communication.md) の Common Packet が標準的に使用される．
 C2A を搭載した OBC と Common Packet に対応していないその他のコンポーネントでは，後述する EB90 Packet を可能な限り用いる．
 
 ### データリンク層
@@ -30,7 +30,7 @@ C2A では，CCSDS に準拠した地上局との通信では，それに準拠
 
 ## ネットワーク層 (Packet)
 ### Common Packet
-[Core Layer/Communication](../Core/communication.md) を参照のこと．
+[Core Layer/Communication](../core/communication.md) を参照のこと．
 
 ### EB90 Packet
 Common Packet ほどリッチな情報をやり取りしない通信に用いる．
@@ -109,5 +109,5 @@ C2A 間通信の具体的な実装については，本リポジトリに同封
 - https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e9/Examples/mobc/src/src_user/Drivers/Aocs/aobc.c#L1-L172
 - https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e9/Examples/subobc/src/src_user/Drivers/Etc/mobc.c#L1-L150
 
-地上局からのコマンドルーティングについては [Core Layer/Communication#コマンド配送におけるルーティングについて](../Core/communication.md#コマンド配送におけるルーティングについて) などを参照すること．
+地上局からのコマンドルーティングについては [Core Layer/Communication#コマンド配送におけるルーティングについて](../core/communication.md#コマンド配送におけるルーティングについて) などを参照すること．
 
diff --git a/docs/driver/overview.md b/docs/driver/overview.md
@@ -83,7 +83,7 @@ typedef struct DriverSuperStreamConfig DriverSuperStreamConfig;
 ### DriverSuper と C2A 間通信
 TBW
 
-[Driver/Communication with Components](../Driver/communication_with_components.md) なども参照．
+[Driver/Communication with Components](../driver/communication_with_components.md) なども参照．
 
 ### その他
 2021年の改良としては，大きく以下がある．

diff --git a/docs/general/coding_rule.md b/docs/general/coding_rule.md
@@ -339,7 +339,7 @@ PCDU_
 XTX_
 ```
 
-[Driver/Overview](../Driver/overview.md) も参照のこと．
+[Driver/Overview](../driver/overview.md) も参照のこと．
 
 
 ### hal

diff --git a/docs/general/overview.md b/docs/general/overview.md
@@ -7,4 +7,4 @@
 ## コマンド
 - ここで言う "コマンド" とは，単に地上局から衛星へ送信されるコマンド，という意味ではなく，処理の最小単位を指す．
 - つまり，C2A 内のアプリケーションから発行されるものもあれば，他のコンポーネントから発行されるものもある．
-- アプリケーションとコマンドの関係については，[Application Layer/Overview](../Application/overview.md) を参照のこと．
+- アプリケーションとコマンドの関係については，[Application Layer/Overview](../application/overview.md) を参照のこと．
diff --git a/docs/general/release.md b/docs/general/release.md
@@ -9,7 +9,7 @@
     - バージョンを上げる．
     - `v3.4.0` → `v3.5.0` など
 - Pre-release
-    - 主に， [Tools/Overview](../Tools/overview.md) などで非互換なアップデートが入った場合のリリース．
+    - 主に， [Tools/Overview](../tools/overview.md) などで非互換なアップデートが入った場合のリリース．
     - `beta` をリリースする．
         - `v3.4.0` → `v3.5.0-beta.0` など
 
@@ -46,7 +46,7 @@
 ただし，あるまとまった機能の実装の PR が複数に分割され，一部がまだマージされていない場合はリリースを控えること．
 
 ### Pre-release
-1.  [Tools/Overview](../Tools/overview.md) などに非互換なアップデートが含まれる PR を発行する．このとき， Pre-release PR となる．
+1.  [Tools/Overview](../tools/overview.md) などに非互換なアップデートが含まれる PR を発行する．このとき， Pre-release PR となる．
     - これは， `feature` ブランチから `develop` ブランチへの PR になるはず．
     - 対応する Tools の PR のリンクを貼る．
     - `#define C2A_CORE_VER_PRE` に `("beta.0")` などをセットする．
@@ -71,7 +71,7 @@
 
 
 ## C2A Tools との互換性について
-少なくとも， [Tools/Overview](../Tools/overview.md) の Tool に後方互換性のない更新があった場合は，新しいバージョンをリリースする．  
+少なくとも， [Tools/Overview](../tools/overview.md) の Tool に後方互換性のない更新があった場合は，新しいバージョンをリリースする．  
 Tool のリリースには，以下に注意する．
 
 - C2A と同様の規則で Relase を発行する．

diff --git a/examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h b/examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
@@ -20,7 +20,7 @@ typedef CmdSpacePacket CommonCmdPacket;
 /**
  * @enum   CCP_DEST_TYPE
  * @brief  コマンドの解釈の宛先を規定
- * @note   詳細は https://github.com/arkedge/c2a-core/blob/develop/Docs/Core/communication.md を参照
+ * @note   詳細は https://github.com/arkedge/c2a-core/blob/develop/docs/core/communication.md を参照
  * @note   4bit を想定
  */
 typedef enum

diff --git a/examples/subobc/README.md b/examples/subobc/README.md
@@ -8,4 +8,4 @@ C2A 間通信の開発のために， [`examples/mobc`](/examples/mobc) とセ
 - あくまで C2A 間通信開発のためなので，最小限の Tlm, Cmd などしか登録されてないなど，大幅に省略している．
 - したがって，C2A の User のサンプルとしては， [`examples/mobc`](/examples/mobc) を参照するほうが望ましい．
 - 一方で， MOBC との通信部分や， sub OBC としての振る舞いについてはこちらを参照すること．
-- C2A 間通信については， [`Docs/Driver/Communication with Components`](/Docs/Driver/communication_with_components.md) も参照すること．
+- C2A 間通信については， [`docs/Driver/Communication with Components`](/docs/driver/communication_with_components.md) も参照すること．
diff --git a/examples/subobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h b/examples/subobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
@@ -20,7 +20,7 @@ typedef CmdSpacePacket CommonCmdPacket;
 /**
  * @enum   CCP_DEST_TYPE
  * @brief  コマンドの解釈の宛先を規定
- * @note   詳細は https://github.com/arkedge/c2a-core/blob/develop/Docs/Core/communication.md を参照
+ * @note   詳細は https://github.com/arkedge/c2a-core/blob/develop/docs/core/communication.md を参照
  * @note   4bit を想定
  */
 typedef enum