Merge branch 'alteriso-3.1-docs' into dev

Author: Hayao0819

default.conf

@@ -297,15 +297,13 @@ dependence=(
     "alterlinux-keyring"
     "arch-install-scripts"
     "curl"
-    "cmake"
     "dosfstools"
     "git"
     "libburn"
     "libisofs"
     "lz4"
     "lzo"
     "make"
-    "ninja"
     "pyalpm"
     "squashfs-tools"
     "libisoburn"

docs/jp/AUR.md

@@ -1,11 +1,18 @@
 ## AURについて
 AlterISO 3ではAURのパッケージをビルドに含めることができます。公式パッケージのインストールが終わった後、chrootでビルド用の一般ユーザーが作成されてビルドされます。初期のAlter ISO3では`makepkg`を使用してインストールを行っていましたが、現在は`yay`を使用してインストールされます。
 
+## yayについて
+yayは最も使用されているAURヘルパーです。AlterISOはまず一時的な一般ユーザーを作成した後、yayをmakepkgでビルドしてインストールします。  
+全てのAURパッケージはyayコマンドを利用してインストールされます。それにより高度な依存関係の解決を行うことができます。
+
 ## AURビルドを無効化する
 チャンネルの`config.<arch>`かビルド時に`--noaur`を指定することでAURのビルドをスキップできます。  
-`config.<arch>`に以下を追記して下さい。
+`config.<arch>`に以下を追記して下さい。  
+AURビルドを無効化すると一部のパッケージがインストールされなくなり、その後のプロセスで予期せぬエラーが発生する可能性があります。  
+(例えば`gnome`チャンネルではGnome拡張機能の大半をAURからインストールします。)
 
 ```bash
 # Do not install the AUR package.
 noaur=true
 ```
+AURからのインストールを無効化すると、その後の`PKGBUILD`からのパッケージのインストールのための依存関係をインストールできず、エラーが発生する場合があります。（デフォルトで設定されているCalamaresはAURのパッケージを依存関係に含んでいます。）エラーが発生する場合には`--nopkgbuild`も一緒に指定することでこのエラーを回避できます。

docs/jp/BUILD.md

@@ -2,11 +2,18 @@
 ビルドは実機のArch Linuxを利用する方法とDocker上でビルドする方法があります。  
 Dockerでビルドする方法は[この手順](DOCKER.md)を参照してください。  
 
-実機でビルドする場合は、必ずOSがArch LinuxかAlter Linuxでなければなりません。  
+実機でビルドする場合は、OSがArch LinuxかAlter Linuxでなければなりません。  
+（Manjaroや他のディストリビューションでも必要なコマンドをインストールすれば理論上は可能ですが動作は保証されません。）
 以下では実機でビルドする方法を解説します。  
 
 ArchやAlter上で直接ビルドする場合、ビルドはいくつかの方法で行うことができます。
 
+## アーキテクチャについて
+現在Alter Linuxは主に`i686`と`x86_64`をサポートしています。限定的に`i486`のサポートも行っています。  
+また、現在`aarch64`のサポートもテストされています。  
+ビルドを行うホスト環境と互換性のあるアーキテクチャでしかビルドできませんので十分注意してください。  
+(x86_64上でi686のビルドはできますがaarh64上でi486のビルドを行うといったことはできません。)  
+
 ### 準備
 
 ソースコードを取得します。  
@@ -25,12 +32,7 @@ sudo ./tools/keyring.sh --alter-add --arch32-add
 ビルドに必要なパッケージをインストールします。
 
 ```bash
-sudo pacman -S --needed git make ninja arch-install-scripts squashfs-tools libisoburn dosfstools ninja cmake pyalpm
-git clone https://aur.archlinux.org/yay.git
-cd yay
-makepkg -siAcC
-cd ..
-rm -rf yay/
+sudo pacman -S --needed curl dosfstools git libburn libisofs lz4 lzo make pyalpm squashfs-tools libisoburn xz zlib zstd qt5-base
 ```
 
 ### TUIを使用する
@@ -41,10 +43,10 @@ make menuconfig
 ```
 
 ### GUIを使用する
-GUIで設定を行ってビルドできます。
+GUIで設定を行ってビルドできます。GUIには`python-gobject`が必須です。  
 
 ```bash
-python ./build-wizard.py
+python ./tools/build-helper.py
 ```
 
 ### ビルドウィザードを使用する
@@ -55,7 +57,7 @@ bashで書かれていますのでターミナルから実行してください
 ウィザードの使い方の詳細は[公式ブログ](https://blog.fascode.net/2020/04/17/build-alterlinux/)で紹介しています。  
 
 ```bash
-./wizard.sh
+sudo make wizard
 ```
 
 ### 手動でオプションを指定してビルドする
@@ -69,6 +71,7 @@ sudo ./build.sh [options] [channel]
 ### build.shの使い方
 
 主なオプションは以下のとおりです。完全なオプションと使い方は`./build -h`を実行して下さい。  
+（以下のオプション以外にもデバッグ用の様々なオプションが用意されています。）  
 
 用途 | 使い方
 --- | ---
@@ -82,24 +85,27 @@ sudo ./build.sh [options] [channel]
 出力先ディレクトリを指定する| -o [dir]
 作業ディレクトリを指定する | -w [dir]
 
+また引数では設定できない細かい挙動を変更する方法もあります。詳しくは[CONFIG.md](CONFIG.md)を参照してください。  
+
 #### 例
 以下の条件でビルドするにはこのようにします。
 
 - Plymouthを有効化
 - 圧縮方式は`gzip`
-- カーネルは`linux-lqx`
+- カーネルは`linux-lts`
 - パスワードは`ilovearch`
+- チャンネルは`xfce`
 
 ```bash
-./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' xfce
+./build.sh -b -c "gzip" -k "lts" -p 'ilovearch' xfce
 ```
 
 
 ### 注意事項
 #### チャンネルについて
 チャンネルは、インストールするパッケージと含めるファイルを切り替えます。  
 この仕組みにより様々なバージョンのAlter Linuxをビルドすることが可能になります。  
-2020年8月17日現在でサポートされているチャンネルは以下のとおりです。  
+2021年5月07日現在でサポートされているチャンネルは以下のとおりです。  
 完全なチャンネルの一覧は`./build.sh -h`を参照して下さい。  
 
 名前 | 目的
@@ -111,19 +117,21 @@ i3 | i3とカスタマイズ可能なpolybarを搭載したrelengを除いて最
 lxde | LXDEと最小限のアプリケーションのみが入っている軽量なチャンネル
 plasma | PlasmaとQtアプリを搭載した現在開発中のチャンネル
 releng | 純粋なArchLinuxのライブ起動ディスクをビルドできるチャンネル
+serene | Serene Linuxを移植したチャンネル
 xfce | デスクトップ環境にXfce4を使用し、様々なソフトウェアを追加したデフォルトのチャンネル
 xfce-pro | xfceチャンネルのウィンドウマネージャを変更し、多くのソフトを追加したチャンネル
 
 
 #### カーネルについて
 `i686`アーキテクチャと`x86_64`アーキテクチャでは共にArchLinuxの公式カーネルである`linux`や`linux-lts`、`linux-zen`をサポートしています。  
-また`x86_64`では公式カーネルに加えて以下のカーネルをサポートしています。
-カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。
+また`x86_64`では公式カーネルに加えて以下ようなカーネルをサポートしています。  
+カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。  
+AlterISO3からは非公式なカーネルはyayによりコンパイル、インストールされます。カーネルのコンパイルに時間がかかる場合が有るので注意してください。  
+この一覧に無いカーネルもサポートしています。完全な一覧は`./build.sh -h`を参照して下さい。  
 
 名前 | 特徴
 --- | ---
 ck | linux-ck にはシステムのレスポンスを良くするためのパッチが含まれています。
-lts | coreリポジトリにある長期サポート版 (Long term support, LTS) の Linux カーネルとモジュール。
 lqx | デスクトップ・マルチメディア・ゲーム用途に Debian 用の設定と ZEN カーネルソースを使ってビルドされたディストロカーネル代替
 rt | このパッチを使うことでカーネルのほとんど全てをリアルタイム実行できるようになります。
 zen-letsnote | Let's Noteでサスペンドの問題が発生しないようにパッチを当てた`linux-zen`カーネル（Alter Linux独自）

docs/jp/CHANNEL.md

@@ -11,7 +11,7 @@ AlterISO 2の複数アーキテクチャ対応により大幅に仕様が変更
 
 
 # ドキュメントの見方
-`<arch>`はビルド時のアーキテクチャ名、`<locale>`は言語名、`<ch_name>`はチャンネル名に置き換えてください。  
+`<arch>`はビルド時のアーキテクチャ名、`<locale>`は言語名、`<ch_name>`はチャンネル名、`<md_name>`はモジュール名に置き換えてください。  
 
 
 # スクリプトにチャンネルを認識させる
@@ -153,6 +153,9 @@ Plymouthを強制的に無効化したい場合は`exclude`ではなく各チャ
 
 また、`exclude`はパッケージを削除するわけではないため依存関係によってインストールされるパッケージを除外することはできません。  
 
+#### additional_exclude_pkg
+もしビルドに失敗するなどの理由で一時的にインストールしたくないパッケージが存在する場合、`custom.con`を使用して`additional_exclude_pkg`配列を設定することでそのパッケージのインストールを除外することができます。
+
 
 ### excludeの適用されるタイミング
 `exclude`はパッケージが全て読み込まれた後に適用されます。  
@@ -191,18 +194,20 @@ PNG形式の画像で640x480の画像を配置してください。この変更
 既存のビルド設定を上書きするスクリプトです。かならずシェルスクリプトの構文で記述して下さい。  
 雛形が`build.sh`と同じ階層に設置してあります。  
 各チャンネルのディレクトリに配置された設定ファイルは**引数による設定さえ**上書きしてしまうため、最小限の必須項目のみを記述するようしてください。（例えばPlymouthのテーマ名やパッケージ名など）  
+引数によって変更可能な変数をこのファイルで設定することは推奨されていません。  
 
 ### 警告
 スクリプト内では変数のスコープを明示しないでください。また、変数定義以外の処理を記述すると思わぬ動作につながる場合はあります。  
 
 
 ### アーキテクチャごとの設定と優先順位
-`channels/<ch_name>/config.any`が読み込まれた後`channels/<ch_name>/config.<arch>`が読み込まれます。
+`channels/<ch_name>/config.any`が読み込まれた後`channels/<ch_name>/config.<arch>`が読み込まれます。  
+このアーキテクチャの優先順位はモジュールにおいても共通です。  
 
 
 ## architecture
 そのチャンネルで利用可能なアーキテクチャの一覧です。`#`はコメントとして扱われます。  
-AlterISO 3は現在`x86_64`と`i686`アーキテクチャのみをサポートしています。
+チャンネル内でカーネル設定ファイルやpacman設定ファイルなどを適切に設定することでアーキテクチャを独自で定義することも可能です。
 
 ## kernel_list-<arch>
 使用可能なカーネルの一覧を記述します。このファイルが存在しない場合、対応している全てのカーネルを使用可能です。  
@@ -228,4 +233,12 @@ rt
 ## over_isofs
 `over_isofs`ディレクトリ内でビルドされるISOファイルの`/`にファイルを上書きします。  
 `airootfs`と似ていますが`over_isofs`ではビルドされるイメージファイル内のファイルを直接操作することができます。  
-既存のファイルを上書きしてしまうとブートできなくなる可能性があるので注意して下さい。
+既存のファイルを上書きしてしまうとブートできなくなる可能性があるので注意して下さい。  
+`over_isofs`はsquashfsの作成が終わった後にisoファイルを作成する直前で上書きされます。  
+
+## pkgbuild.any pkgbuild.<arch>
+チャンネルディレクトリ内に`pkgbuild.any(arch)/任意のディレクトリ名/PKGBUILD`を配置するとmakepkgによってビルドし、インストールされます。  
+依存関係もpacmanによって自動的にインストールされますが、注意が必要です。  
+自動的にインストールされる依存関係はあくまでArch Linuxの公式リポジトリに存在しているものだけです。  
+依存しているパッケージが一つでもAUR上に存在している場合は、その依存パッケージをAURのパッケージリストに書かなければなりません。  
+また、PKGBUILDを格納するディレクトリ名は絶対に重複しないようにしてください。

docs/jp/CHANNEL_2_to_3.md

@@ -21,6 +21,10 @@ AlterISO3では様々な新機能が追加されました。そしてそれと
 以前の`japanese`変数は意味を成しません。AlterISO3では言語名を`locale_name`変数で行っています。  
 特定の言語を強制的に使用させたい場合は、`-l`オプションで指定する言語名を`locale_name`変数で指定して下さい。  
 
+### モジュールについて
+AlterISO 3.1用に開発する場合はモジュール一覧も定義する必要があります。  
+詳細は後ほど追記します。
+
 #### 詳細設定を行う
 AlterISO3は`locale_name`の値を元にいくつかの変数を`system/locale-<arch>`から参照します。  
 チャンネルの`config`ファイルでは変数を上書きできるので、これらを詳細に書き換えることができます。  

docs/jp/CONFIG.md

@@ -11,14 +11,25 @@ alterisoではビルドに様々な設定が存在しています。
 変更できる値の完全な一覧は`default.conf`にかかれています。  
 設定を別ファイルにコピーして変更する際はそのコメントも一緒にコピーすることを推奨します。  
 
+# custom.confについて
+`custom.conf`は`defaulf.conf`を上書きするために使用されます。  
+デフォルト値を書き換えたい場合やよく使用するビルド設定はこのファイルに記述しておくと楽です。  
+また、`build.sh`の引数で変更できない細かい設定を変更することもできるようになります。  
+
+# モジュールについて
+モジュールの設定ファイルは、モジュールが設定された順番で読み込まれます。つまり`config`で配列の後ろのほうに記述したモジュールほど優先順位が高くなります。  
+
 # 読み込まれるファイル一覧
 上から順番に読み込まれます。`<arch>`と`<ch_name>`はそれぞれアーキテクチャとチャンネル名に置き換えてください。 
-同じ変数が設定されていた場合、設定ファイルが読み込まれるごとに上書きされます。
+同じ変数が設定されていた場合、設定ファイルが読み込まれるごとに上書きされます。  
 
 ファイルパス | 備考
 --- | ---
 default.conf | 全ての値がここで設定されます（必須）
+custom.conf
 channels/share/config.any | 
 channels/share/config.<arch> | 
 channels/<ch_name>/config.any | 
 channels/<ch_name>/config.<arch> | 
+modules/<md_name>/config.any | 
+modules/<md_name>/config.<arch> | 

docs/jp/KERNEL.md

@@ -1,12 +1,11 @@
 ## カーネルの設定ファイルについて
-
 AlterISOは様々なカーネルをサポートしています。カーネルは各アーキテクチャごとの設定ファイルで定義されます。
+ここではAlterISOに新しいカーネルのサポートを追加する方法を説明します。  
+AlterISO全体ではなくチャンネル内部でのみ追加する方法は[チャンネルで独自に新しいカーネルをサポートする](ORIGINAL_KERNEL.md)を参照してください。  
 
 
 ### 1.リポジトリを作成する
-リポジトリには2種類のパッケージを追加する必要があります。カーネル本体とheadersパッケージです。  
-`build.sh`はカーネルをpacmanを利用してインストールしようとします。もしあなたが公式リポジトリに無いカーネルを追加したい場合はまずはpacmanのリポジトリを作成してください。  
-カーネルのパッケージをAURからビルドすることはできません。（`pacstrap`で初期の段階でインストールされるため。）
+AlterISO3ではカーネルをAURからインストールすることはできなかったため、リポジトリを構築する必要がありました。3.1からはAURによるカーネルパッケージリストがサポートされたため、その必要はなくなっています。  
 
 
 ### 2.カーネル設定ファイルを構成する

docs/jp/LANG.md

@@ -44,4 +44,4 @@ ArchLinux32とArchLinuxでは文字列が異なるので注意してください
 ライブ環境のタイムゾーンの設定です。`/usr/share/zoneinfo`以下のパスを記述して下さい。
 
 ## fullname
-その言語のフルネームです。ビルド時のメッセージ等に使用されます。
+その言語のフルネームです。ビルド時のメッセージ等に使用されます。

docs/jp/ORIGINAL_KERNEL.md

@@ -4,7 +4,7 @@ AlterISO3ではカーネルに関する処理が大幅に変更され、チャ
 
 ## 追加したいカーネルの情報を把握する
 カーネルを追加するにはいくつかの設定ファイルを編集する必要があります。  
-それぞれの設定ファイルの詳細については[CHANNEL.md](./CHANNEL.md)を参考にして下さい。  
+それぞれの設定ファイルの詳細については[KERNEL.md](./KERNEL.md)を参考にして下さい。  
 
 カーネルを設定するには以下の情報が必要です。
 - カーネルのパッケージ名
@@ -17,6 +17,7 @@ AlterISO3ではカーネルに関する処理が大幅に変更され、チャ
 - カーネルの略称（他のカーネルと重複しない名前ならなんでもOK）
 
 ## カーネル設定ファイルを作成する
+もしチャンネルディレクトリに`kernel-<arch>`というファイルがある場合は`/system/kernel-<arch>`の代わりにそのファイルが参照されます。  
 カーネルの情報を`/system/kernel-<arch>`を参考に作成して下さい。その後作成した設定ファイルをチャンネル内に配置して下さい。  
 ビルドスクリプトは、`/system/kernel-<arch>`の代わりにチャンネル内の設定ファイルを使用します。  
 その設定ファイル内の記述されているカーネルしか使用できなくなるので、`/system/kernel-<arch>`で既に設定されているカーネルも記述して下さい。