Skip to content

Commit

Permalink
doc: android/boot-image: invalid C declaration
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
xypron authored and trini committed Jan 4, 2021
1 parent 71fd11b commit 5154971
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/android/boot-image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down

0 comments on commit 5154971

Please sign in to comment.