diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2020-12-30 17:55:22 +0100 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2021-01-04 09:10:16 -0500 |
| commit | 51549711b5960f2280629fe6231a07338bbcd57c (patch) | |
| tree | c0f5bc92d3caf73b6e4be5a932848dc3c600e7e1 /doc | |
| parent | 71fd11b9013eda5b618737f91e2b19daabb775a3 (diff) | |
doc: android/boot-image: invalid C declaration
make htmldocs results in an error:
doc/android/boot-image.rst:33:
WARNING: Unparseable C cross-reference: 'struct andr_img_hdr'
Invalid C declaration: Expected identifier in nested name, got keyword:
struct [error at 6]
Follow the style prescribed in
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#highlights-and-cross-references
Add missing definite article.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/android/boot-image.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/android/boot-image.rst b/doc/android/boot-image.rst index 195da688f4..fa8f2a47ee 100644 --- a/doc/android/boot-image.rst +++ b/doc/android/boot-image.rst @@ -30,9 +30,10 @@ next image headers: v2, v1 and v0 formats are backward compatible. -Android Boot Image format is represented by :c:type:`struct andr_img_hdr` in -U-Boot, and can be seen in ``include/android_image.h``. U-Boot supports booting -Android Boot Image and also has associated command +The Android Boot Image format is represented by +:c:type:`struct andr_img_hdr <andr_img_hdr>` in U-Boot, and can be seen in +``include/android_image.h``. U-Boot supports booting Android Boot Image and also +has associated command Booting ------- |