From 07462af2dd2cd6a5d846e1dc45b885e43c06552e Mon Sep 17 00:00:00 2001 From: hayao Date: Wed, 25 Mar 2020 18:14:19 +0900 Subject: [PATCH] [update] : Added latest info and cleaned. --- docs/build_on_docker.md | 28 --------------- docs/channels-jp.md | 53 ++++++++++++++++++++++++++++ docs/docker-en.md | 11 ++++++ docs/docker-jp.md | 10 ++++++ docs/{add_new_kernel.md => new_kernel-jp.md} | 22 ++++++------ 5 files changed, 84 insertions(+), 40 deletions(-) delete mode 100644 docs/build_on_docker.md create mode 100644 docs/channels-jp.md create mode 100644 docs/docker-en.md create mode 100644 docs/docker-jp.md rename docs/{add_new_kernel.md => new_kernel-jp.md} (87%) diff --git a/docs/build_on_docker.md b/docs/build_on_docker.md deleted file mode 100644 index 741d1e5e..00000000 --- a/docs/build_on_docker.md +++ /dev/null @@ -1,28 +0,0 @@ - -## Japanese - -### ビルド -dockerがインストール済みのLinux環境で行ってください。 - -```bash -git clone https://github.com/SereneTeam/alterlinux.git -cd alterlinux -sudo ./docker-build.sh -``` -#### ビルドオプションについて -DockerfileのCMD欄を書き換えることでオプションが選べます。 - - -## English - -### Build -Please go in the Linux environment where docker is installed. - -```bash -git clone https://github.com/SereneTeam/alterlinux.git -cd alterlinux -sudo ./docker-build.sh -``` - -#### About build options -Options can be selected by rewriting the CMD column of Dockerfile. diff --git a/docs/channels-jp.md b/docs/channels-jp.md new file mode 100644 index 00000000..5c241260 --- /dev/null +++ b/docs/channels-jp.md @@ -0,0 +1,53 @@ +## チャンネルとは +チャンネルは、イメージファイルに含めるためのファイル（airootfs）やインストールするパッケージ、実行するスクリプトなどを簡単に切り替えられるように作られたAlterLinux独自の仕組みです。 + +初期ではパッケージの切り替えしかできませんでしたが、現在は大幅に仕様が変更されています。 + + +## チャンネルの仕様 +仕様を正しく理解しないと思わぬ動作を引き起こす可能性が有ります。 + + +### スクリプトにチャンネルを認識させる +スクリプトがチャンネルを認識する条件は以下のとおりです。 + +- `channel`内にチャンネル名のディレクトリがある +- そのディレクトリが空ではない + +空のディレクトリを作成したり、別の場所に作成してもスクリプトは認識しません。 + + +### それぞれのチャンネルの仕様 +それそれのチャンネルは2つのディレクトリがあります。`airootfs`と`packages`です。 +`airootfs`ディレクトリはパッケージをインストールし`mksquashfs`を実行する直前に`/`を上書きします。 +`packages`ディレクトリはインストールするパッケージのリストを記述したテキストファイルを格納します。 + + +#### `airootfs` +このディレクトリ内を`/`としてファイルを配置して下さい。全てのファイルの権限はなるべく引き継がれるようになっています。 + + +### 特殊なチャンネル +特殊なチャンネルとして`share`チャンネルがあります。`share`チャンネルは指定されたチャンネルに関わらず使用される共有チャンネルです。 +`share`はその他のチャンネルと同じ構造をしていますが、`share`単体をチャンネルとして指定することができません。 +全てのチャンネルでインストールされる基本パッケージや共通のファイルなどをここに追加します。 + +`airootfs`でファイルが重複した場合、`share`のファイルは上書きされます。例えば`xfce`チャンネルでは`share`の`/root/customize_airootfs.sh`を上書きしています。 + + +### 特殊なファイル +各チャンネルの`airootfs`で、`/root/customize_airootfs_<チャンネル名>.sh`といゆファイルが配置された場合、ビルドスクリプトは、`customize_airootfs.sh`が実行された後に実行します。 + + +#### `packages` +このディレクトリ内に配置された、ファイル名が`.x86_64`で終わるがパッケージリストとして読み込まれます。 +1行で1つのパッケージとして扱い、`#`から始まる行はコメントとして扱われます。 + +特殊なパッケージリストとして、`jp.x86_64`と`non-jp.x86_64`があります。 +`-j`オプションによって日本語が有効化されている時、スクリプトは`jp.x86_64`を読み込みます。 +反対に日本語が有効化されていない場合、スクリプトは`non-jp.x86_64`を使用します。 + +パッケージ名やパッケージリストのファイル名に空白文字や全角文字を含めると正常に動作しない可能性があります。 + +一部、パッケージリストに記述してはいけないパッケージが有ります。 +詳細は[こちら](packages.md)を参照して下さい。 \ No newline at end of file diff --git a/docs/docker-en.md b/docs/docker-en.md new file mode 100644 index 00000000..00a9c336 --- /dev/null +++ b/docs/docker-en.md @@ -0,0 +1,11 @@ +## Docker +Please go in the Linux environment where docker is installed. + +```bash +git clone https://github.com/SereneTeam/alterlinux.git +cd alterlinux +sudo ./docker-build.sh +``` + +### About build options +Options can be selected by rewriting the CMD column of Dockerfile. diff --git a/docs/docker-jp.md b/docs/docker-jp.md new file mode 100644 index 00000000..4029586c --- /dev/null +++ b/docs/docker-jp.md @@ -0,0 +1,10 @@ +## Docker +dockerがインストール済みのLinux環境で行ってください。 + +```bash +git clone https://github.com/SereneTeam/alterlinux.git +cd alterlinux +sudo ./docker-build.sh +``` +### ビルドオプションについて +DockerfileのCMD欄を書き換えることでオプションが選べます。 diff --git a/docs/add_new_kernel.md b/docs/new_kernel-jp.md similarity index 87% rename from docs/add_new_kernel.md rename to docs/new_kernel-jp.md index c6d1a0aa..5f49c187 100644 --- a/docs/add_new_kernel.md +++ b/docs/new_kernel-jp.md @@ -1,17 +1,15 @@ -## 日本語 - -### 新しいカーネルに対応させる +## 新しいカーネルに対応させる Alter Linuxを新しいカーネルに対応させる手順です。ここでは`linux-fooo`を追加する手順を説明します。実際に行う場合はこの文字を置き換えてください。 リポジトリには2種類のパッケージを追加する必要があります。カーネル本体とheadersパッケージです。 -#### 1.リポジトリを作成する +### 1.リポジトリを作成する `build.sh`はカーネルをpacmanを利用してインストールしようとします。もしあなたが公式リポジトリに無いカーネルを追加したい場合はまずはpacmanのリポジトリを作成してください。 リポジトリはGitHubを利用して簡単に作成できます。 -#### 2.カーネル一覧に追加する +### 2.カーネル一覧に追加する `kernel_list`にカーネル名を追記してください。`build.sh`に渡された値が正しいかどうかはこの変数を利用して判定されます。 リストに追加する値は`linux-`の後の文字です。今回の場合は`fooo`になります。 @@ -20,7 +18,7 @@ Alter Linuxを新しいカーネルに対応させる手順です。ここでは echo "fooo" >> ./system/kernel_list ``` -#### 3.ファイルを作成する +### 3.ファイルを作成する そのカーネル用のファイルを6つ作成する必要があります。以下はカーネルの一覧です。 「既存のファイルを名前を変えてコピーし、カーネルへのパスを修正する」という方法が最も簡単です。 ファイル名は`fooo`に置き換えてあります。 @@ -34,24 +32,24 @@ echo "fooo" >> ./system/kernel_list 7. airootfs/usr/share/calamares/modules/unpackfs/unpackfs-fooo.conf 8. airootfs/usr/share/calamares/modules/initcpio/initcpio-fooo.conf -##### 1 2 +#### 1と2のファイル 7行目、18行目、29行目のパスを変更してください。 -##### 3 4 +#### 3と4のファイル 7行目のパスを変更してください。 -##### 5 6 +#### 5と6のファイル 2行目のパスを変更してください。 -##### 7 +#### 7のファイル 95行目、97行目のパスを変更してください。 -##### 8 +#### 8のファイル 18行目のパスを変更してください。 -#### 4.プルリクエストを送る +### 4.プルリクエストを送る [ここ](https://github.com/SereneTeam/alterlinux/pulls)へプルリクエストを投稿してください。 -- 2.11.0