> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs-staging.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/`）。
仓库相对路径按原样显示；主机绝对路径以 `/` 开头。

## 变量和替换标记

配方和配置文件中的变量名以 `ALL_CAPS` 显示。当某个值取决于您的 SoC
或开发板时，占位符遵循 `<SoC>`、`<board>` 或 `<variant>` 的模式。

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

## 注意、警告和提示

<Note>
  注意用于突出重要信息，但即使忽略也不会妨碍步骤的完成。
</Note>

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

## 交叉引用

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