---
name: log-insertion-rules
description: 組み込み機器の C/C++ のソースにデバッグログを追加するときの決まり。embedded-debug-loop のソースコード担当がログを追加するときに読む。
---

# ログ追加のルール

このルールは、embedded-debug-loop のソースコード担当が、C/C++ のソースにログを追加するときに従う（K-07）。ログ追加の決まりは、ここに書かれた内容で決まる。

## 基本

- ログは基本的に printf で出す（K-08）。
- 出すログは、実機のシェルコンソールに出る文字列にする。

## ログ関数を使う場合

ログ関数（logメッセージのような関数）を使う機器では、ここに書く（K-08）。

- ここを機器に合わせて書く：ログ関数の名前、定義されているヘッダーファイル、使い方の例。
- 何も書かないときは、printf を使う。

## 例について

Makefile、バッチファイル、複数段階ビルド、TFTP、CRC やサム値の調整は例であり、固定の仕様ではない（K-07）。機器ごとに異なる処理は、この欄に書いたルールで決まる。

## 守ること

- 頼みの制約で変えてはいけないと書かれたファイルは、変えない（K-14）。
- 変える範囲は、計画に書かれたものだけにする。