# バッチ設計書 32-make all

## 概要

本ドキュメントは、mrubyプロジェクトにおけるMakeターゲット `make all` のバッチ設計書である。MakefileからRakeを呼び出して全ターゲットをビルドするラッパーコマンドについて記述する。

### 本バッチの処理概要

`make all` は、Makefileで定義されたデフォルトターゲットであり、Rakeコマンドを内部的に呼び出してmrubyの全ビルドターゲットを構築する。Makeに慣れた開発者がmrubyをビルドする際の標準的なエントリポイントとなる。

**業務上の目的・背景**：mrubyのビルドシステムはRakeをベースとしているが、多くのC/C++プロジェクトではMakeが標準的なビルドツールである。Make経由でのビルドを可能にすることで、Rakeに不慣れな開発者やCI/CDシステムからのアクセシビリティを向上させる。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行する。ソースコードの変更後にビルドが必要な場合に使用される。Makefileのデフォルトゴール（`.DEFAULT_GOAL := all`）であるため、引数なしの `make` コマンドでも実行される。

**主要な処理内容**：
1. Rakeコマンドの存在チェック（check_rake依存ターゲット）
2. `$(RAKE)`（= `rake`）コマンドを引数なしで実行
3. Rake側で `rake all`（デフォルトタスク）が実行され、gensym、build、ビルドサマリー出力が順に行われる

**前後の処理との関連**：本タスクはRakefileの `all` タスクのラッパーである。`all` タスク内部では `:gensym` タスク（プリシンボル生成）が前提として実行され、その後 `:build` タスクが実行される。No.33 `make test` は本タスクに依存する。

**影響範囲**：プロジェクトのbuildディレクトリ配下にビルド成果物が生成される。bin/ディレクトリにバイナリがインストールされる。

## バッチ種別

ビルド処理（Rakeラッパー）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（開発者によるコマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby | Rubyランタイムがインストールされていること |
| Rake | Rakeコマンドが利用可能であること（check_rakeで検証） |
| Cコンパイラ | GCCまたはClang等のCコンパイラが利用可能であること |

### 実行可否判定

Makefileの `check_rake` ターゲットが先に実行され、`command -v rake` でRakeコマンドの存在を確認する。存在しない場合は「Error: rake is not installed or not in PATH.」メッセージを出力して終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAKE | Makefile変数 | No | rake | 使用するRakeコマンド |
| MRUBY_CONFIG | 環境変数 | No | build_config/default.rb | mrubyビルド設定ファイルパス |
| CC | 環境変数 | No | システムデフォルト | Cコンパイラ |
| CXX | 環境変数 | No | システムデフォルト | C++コンパイラ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Makefile | Make | ターゲット定義とRakeコマンド呼び出し |
| Rakefile | Ruby | 実際のビルドロジック定義 |
| mrubyソースコード一式 | C/Ruby | ビルド対象のソースコード |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| build/ | バイナリ/オブジェクト | ビルド成果物（オブジェクトファイル、ライブラリ等） |
| bin/ | 実行可能バイナリ | mrbc、mruby、mirb等の実行可能ファイル |
| 標準出力 | テキスト | ビルドサマリー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | ビルドターゲットに依存（libmruby.a、mrbc等） |
| 出力先 | build/ および bin/ |
| 文字コード | N/A（バイナリファイル） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. check_rake実行
   └─ rakeコマンドの存在確認
2. $(RAKE)実行（= rake）
   └─ 引数なしで実行されるため、Rakefileのdefaultタスク（= all）が起動
3. Rakefile: gensymタスク
   └─ プリシンボルリストとヘッダーファイルの生成
4. Rakefile: buildタスク
   └─ 全ビルドターゲットのproductsを生成
5. ビルドサマリー出力
   └─ 各ターゲットのビルドサマリーを標準出力に表示
6. Lockfileの書き出し
   └─ MRuby::Lockfile.writeを実行
```

### フローチャート

```mermaid
flowchart TD
    A[make all 開始] --> B[check_rake: rakeコマンド存在確認]
    B --> C{rakeが存在?}
    C -->|なし| D[エラー出力・終了]
    C -->|あり| E["$(RAKE) 実行"]
    E --> F[Rakefile: gensymタスク]
    F --> G[Rakefile: buildタスク]
    G --> H[ビルドサマリー出力]
    H --> I[Lockfile書き出し]
    I --> J[正常終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コマンド未検出 | rakeコマンドがPATHに存在しない | Rubyおよびrake gemをインストールする |
| 非0終了 | コンパイルエラー | ソースコードのコンパイル失敗 | エラーメッセージを確認し、ソースコードを修正する |
| 非0終了 | リンクエラー | リンク時のシンボル未解決 | 依存ライブラリの設定を確認する |
| 非0終了 | 設定エラー | MRUBY_CONFIGで指定されたファイルが存在しない | 正しい設定ファイルパスを指定する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ビルド失敗時は、標準出力・標準エラー出力のログを確認し、失敗したコンパイル対象を特定する。`make clean` でビルド成果物を削除してからリビルドすることで解決する場合がある。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（データベーストランザクションなし） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | mruby全ソースファイル |
| 目標処理時間 | 環境依存（一般的に数分以内） |
| メモリ使用量上限 | システム依存 |

## 排他制御

ビルドディレクトリへの同時書き込みを避けるため、同一ビルドディレクトリに対する並行実行は行わないこと。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ビルド開始時 | コンパイル対象ファイルの情報 |
| 進捗ログ | コンパイル中 | 各ファイルのコンパイル状況 |
| 終了ログ | ビルド完了時 | ビルドサマリー（各ターゲットの情報） |
| エラーログ | エラー発生時 | コンパイルエラー・リンクエラーの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 特に定めなし | 標準出力 |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- `make` を引数なしで実行した場合も `.DEFAULT_GOAL := all` により本ターゲットが実行される
- 内部的にはRakeのデフォルトタスク（`:default => :all`）を呼び出すラッパーである
- Makefileのコメント `## build all targets, install (locally) in-repo` がhelpターゲットで表示される
- Rakeに渡す追加オプションが必要な場合は、直接 `rake` コマンドを使用すること
