OSDN Git Service

[add] : Added a document about config.
authorhayao <shun819.mail@gmail.com>
Sun, 14 Jun 2020 02:44:29 +0000 (11:44 +0900)
committerhayao <shun819.mail@gmail.com>
Sun, 14 Jun 2020 02:44:29 +0000 (11:44 +0900)
docs/jp/CONFIG.md [new file with mode: 0644]

diff --git a/docs/jp/CONFIG.md b/docs/jp/CONFIG.md
new file mode 100644 (file)
index 0000000..57347ed
--- /dev/null
@@ -0,0 +1,24 @@
+# 設定について
+alterisoではビルドに様々な設定が存在しています。  
+ユーザーはこれらの設定の一部を引数で変更することができますが、中には設定ファイルを編集することでしか変更できないものも存在しています。  
+また、チャンネルの開発者は一部の値の変更を禁止したいかもしれません。  
+ここでは設定できる値と読み込まれる設定ファイルの順番について説明しています。  
+
+# 構文
+設定は全てbashスクリプトで書かれています。また設定の読み込みは全てbashの組み込みコマンドである`source`コマンドで行われます。
+
+# 設定できる値
+変更できる値の完全な一覧は`default.conf`にかかれています。  
+設定を別ファイルにコピーして変更する際はそのコメントも一緒にコピーすることを推奨します。  
+
+# 読み込まれるファイル一覧
+上から順番に読み込まれます。`<architecture>`と`<channel_name>`はそれぞれアーキテクチャとチャンネル名に置き換えてください。 
+同じ変数が設定されていた場合、設定ファイルが読み込まれるごとに上書きされます。
+  
+ファイルパス | 備考
+--- | ---
+default.conf | 全ての値がここで設定されます(必須)
+channels/share/config.any | 
+channels/share/config.<architecture> | 
+channels/<channel_name>/config.any | 
+channels/<channel_name>/config.<architecture> |