> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 文档约定

本指南全文使用以下约定。

## 命令与代码

所有 shell 命令和代码示例均以等宽代码块显示。
除非指明存在占位符,否则请完全按照所示内容运行命令。
占位符使用尖括号表示法,必须替换为你的实际值。

```text theme={null}
git clone <repo-url> -b <branch>
```

## 文件路径

除非另有说明,路径均相对于内核源码根目录(`kernel-src/`)。仓库相对路径按原样显示;
主机绝对路径以 `/` 开头。

## 变量与替换标记

配方(recipe)和配置文件中的变量名以 `ALL_CAPS` 形式显示。当某个值取决于你的 SoC 或单板时,占位符遵循 `<SoC>`、`<board>` 或 `<variant>` 的模式。

```text theme={null}
KERNEL_DEVICETREE = "qcom/<SoC>-<board>-<variant>.dtb"
```

## 注释、警告与提示

<Note>
  注释用于突出显示重要信息,但即使被忽略也不会妨碍操作步骤的完成。
</Note>

<Warning>
  警告用于标识可能产生意外结果或需要格外小心的操作。
</Warning>

## 交叉引用

指向本指南其他章节的链接以内联超链接形式显示。
指向外部文档的链接也以内联超链接形式显示。