aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/getting_started_make_guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/getting_started_make_guide.md')
-rw-r--r--docs/ja/getting_started_make_guide.md34
1 files changed, 25 insertions, 9 deletions
diff --git a/docs/ja/getting_started_make_guide.md b/docs/ja/getting_started_make_guide.md
index 45284a0b9..07d7f0597 100644
--- a/docs/ja/getting_started_make_guide.md
+++ b/docs/ja/getting_started_make_guide.md
@@ -1,8 +1,8 @@
1# より詳細な `make` 手順 1# より詳細な `make` 手順
2 2
3<!--- 3<!---
4 original document: 0.10.33:docs/getting_started_make_guide.md 4 original document: 0.12.43:docs/getting_started_make_guide.md
5 git diff 0.10.33 HEAD -- docs/getting_started_make_guide.md | cat 5 git diff 0.12.43 HEAD -- docs/getting_started_make_guide.md | cat
6--> 6-->
7 7
8`make` コマンドの完全な構文は `<keyboard_folder>:<keymap>:<target>` です: 8`make` コマンドの完全な構文は `<keyboard_folder>:<keymap>:<target>` です:
@@ -19,16 +19,32 @@
19`<target>` は以下を意味します 19`<target>` は以下を意味します
20* target が指定されない場合は、以下の `all` と同じです 20* target が指定されない場合は、以下の `all` と同じです
21* `all` は指定されたキーボード/リビジョン/キーマップの可能な全ての組み合わせのコンパイルを行います。例えば、`make planck/rev4:default` は1つの .hex を生成しますが、`make planck/rev4:all` は planck で利用可能な全てのキーマップについて hex を生成します。 21* `all` は指定されたキーボード/リビジョン/キーマップの可能な全ての組み合わせのコンパイルを行います。例えば、`make planck/rev4:default` は1つの .hex を生成しますが、`make planck/rev4:all` は planck で利用可能な全てのキーマップについて hex を生成します。
22* `flash`、`dfu`、`teensy`、`avrdude`、`dfu-util` または `bootloadHID` はファームウェアをコンパイルし、キーボードにアップロードします。コンパイルが失敗すると、何もアップロードされません。使用するプログラマはキーボードに依存します。ほとんどのキーボードでは `dfu` ですが、ChibiOS キーボードについては `dfu-util` 、標準的な Teensy については `teensy` を使います。キーボードに使うコマンドを見つけるには、キーボード固有の readme をチェックしてください。 22* `flash`、`dfu`、`teensy`、`avrdude`、`dfu-util`、`bootloadHID` はファームウェアをコンパイルし、キーボードにアップロードします。コンパイルが失敗すると、何もアップロードされません。使用するプログラマはキーボードに依存します。ほとんどのキーボードでは `dfu` ですが、ChibiOS キーボードについては `dfu-util` 、標準的な Teensy については `teensy` を使います。キーボードに使うコマンドを見つけるには、キーボード固有の readme をチェックしてください。
23* **注意**: 一部のオペレーティングシステムではこれらのコマンドが機能するためには root アクセスが必要です。その場合、例えば `sudo make planck/rev4:default:flash` を実行する必要があります。 23 利用可能なブートローダの詳細は[ファームウェアの書き込み](ja/flashing.md)ガイドを参照してください。
24 * **Note**: 一部のオペレーティングシステムでは、これらのコマンドが機能するためには特権アクセスが必要です。これは、root アクセスなしでこれらにアクセスするために [`udev ルール`](ja/faq_build.md#linux-udev-rules) を設定するか、あるいは root アクセスでコマンドを実行する (`sudo make planck/rev4:default:flash`) 必要があるかもしれないことを意味します。
24* `clean` は、全てをゼロからビルドするためにビルド出力フォルダを掃除します。説明できない問題がある場合は、通常のコンパイルの前にこれを実行してください。 25* `clean` は、全てをゼロからビルドするためにビルド出力フォルダを掃除します。説明できない問題がある場合は、通常のコンパイルの前にこれを実行してください。
26* `distclean` は、.hex ファイルと .bin ファイルを削除します。
27
28次のターゲットは開発者向けです:
29
30* `show_path` ソースとオブジェクトファイルのパスを表示します。
31* `dump_vars` makefile 変数をダンプします。
32* `objs-size` 個々のオブジェクトファイルのサイズを表示します。
33* `show_build_options` 'rules.mk' のオプションセットを表示します。
34* `check-md5` 生成されたバイナリファイルの md5 チェックサムを表示します。
25 35
26make コマンドの最後、つまり target の後に追加のオプションを追加することもできます 36make コマンドの最後、つまり target の後に追加のオプションを追加することもできます
27 37
28* `make COLOR=false` - カラー出力をオフ 38* `make COLOR=false` - カラー出力をオフ
29* `make SILENT=true` - エラー/警告以外の出力をオフ 39* `make SILENT=true` - エラー/警告以外の出力をオフ
30* `make VERBOSE=true` - 全ての gcc のものを出力 (デバッグする必要が無い限り面白くありません) 40* `make VERBOSE=true` - 全ての gcc のものを出力 (デバッグする必要が無い限り面白くありません)
31* `make EXTRAFLAGS=-E` - コンパイルせずにコードを前処理 (#define コマンドをデバッグしようとする場合に便利) 41* `make VERBOSE_LD_CMD=yes` - -v オプションを指定して ld コマンドを実行します。
42* `make VERBOSE_AS_CMD=yes` - -v オプションを指定して as コマンドを実行します。
43* `make VERBOSE_C_CMD=<c_source_file>` - 指定された C ソースファイルをコンパイルするときに -v オプションを追加します。
44* `make DUMP_C_MACROS=<c_source_file>` - 指定された C ソースファイルをコンパイルするときにプリプロセッサマクロをダンプします。
45* `make DUMP_C_MACROS=<c_source_file> > <logfile>` - 指定された C ソースファイルをコンパイルするときにプリプロセッサマクロを `<logfile>` にダンプします。
46* `make VERBOSE_C_INCLUDE=<c_source_file>` - 指定された C ソースファイルをコンパイルするときにインクルードされるファイル名をダンプします。
47* `make VERBOSE_C_INCLUDE=<c_source_file> 2> <logfile>` - 指定された C ソースファイルをコンパイルするときにインクルードされるファイル名を `<logfile>` にダンプします。
32 48
33make コマンド自体にもいくつかの追加オプションがあります。詳細は `make --help` を入力してください。最も有用なのはおそらく `-jx` です。これは複数の CPU を使ってコンパイルしたいことを指定し、`x` は使用したい CPU の数を表します。設定すると、特に多くのキーボード/キーマップをコンパイルしている場合は、コンパイル時間を大幅に短縮することができます。通常は、コンパイル中に他の作業を行うための余裕をもたせるために、持っている CPU の数より1つ少ない値に設定します。全てのオペレーティングシステムと make バージョンがオプションをサポートしているわけではないことに注意してください。 49make コマンド自体にもいくつかの追加オプションがあります。詳細は `make --help` を入力してください。最も有用なのはおそらく `-jx` です。これは複数の CPU を使ってコンパイルしたいことを指定し、`x` は使用したい CPU の数を表します。設定すると、特に多くのキーボード/キーマップをコンパイルしている場合は、コンパイル時間を大幅に短縮することができます。通常は、コンパイル中に他の作業を行うための余裕をもたせるために、持っている CPU の数より1つ少ない値に設定します。全てのオペレーティングシステムと make バージョンがオプションをサポートしているわけではないことに注意してください。
34 50
@@ -104,7 +120,7 @@ make コマンド自体にもいくつかの追加オプションがあります
104 120
105これにより、送信したい文字に対応するニーモニックを入力することで Unicode 文字を送信することができます。キーマップファイル内にマッピングテーブルを保持する必要があります。可能な全てのコードポイント( `0x10FFFF` まで)がサポートされます。 121これにより、送信したい文字に対応するニーモニックを入力することで Unicode 文字を送信することができます。キーマップファイル内にマッピングテーブルを保持する必要があります。可能な全てのコードポイント( `0x10FFFF` まで)がサポートされます。
106 122
107詳細と制限については、[Unicode ページ](ja/feature_unicode.md) を見てください。 123詳細と制限については、[Unicode ページ](ja/feature_unicode.md)を見てください。
108 124
109`AUDIO_ENABLE` 125`AUDIO_ENABLE`
110 126
@@ -116,11 +132,11 @@ C6 ピン(抽象化が必要)でオーディオ出力できます。詳細は[
116 132
117`API_SYSEX_ENABLE` 133`API_SYSEX_ENABLE`
118 134
119これにより Quantum SYSEX API を使って文字列を送信することができます (どこに?) 135これにより Quantum SYSEX API を使って文字列を(どこかに?)送信することができます
120 136
121`KEY_LOCK_ENABLE` 137`KEY_LOCK_ENABLE`
122 138
123これは [キーロック](ja/feature_key_lock.md) を有効にします。 139これは[キーロック](ja/feature_key_lock.md)を有効にします。
124 140
125`SPLIT_KEYBOARD` 141`SPLIT_KEYBOARD`
126 142
@@ -132,7 +148,7 @@ ARM ベースの分割キーボード用の標準分割通信ドライバはま
132 148
133`CUSTOM_MATRIX` 149`CUSTOM_MATRIX`
134 150
135デフォルトのマトリックス走査ルーチンを独自のコードで置き換えます。詳細については、[カスタムマトリックスページ](ja/custom_matrix.md) を見てください。 151デフォルトのマトリックス走査ルーチンを独自のコードで置き換えます。詳細については、[カスタムマトリックスページ](ja/custom_matrix.md)を見てください。
136 152
137`DEBOUNCE_TYPE` 153`DEBOUNCE_TYPE`
138 154