• Masahiro Yamada's avatar
    docs: kbuild: fix invalid ReST syntax · 4fef9dec
    Masahiro Yamada authored
    I see the following warnings when I open this document with a ReST
    viewer, retext:
    
    /home/masahiro/ref/linux/Documentation/kbuild/makefiles.rst:1142: (WARNING/2) Inline emphasis start-string without end-string.
    /home/masahiro/ref/linux/Documentation/kbuild/makefiles.rst:1152: (WARNING/2) Inline emphasis start-string without end-string.
    /home/masahiro/ref/linux/Documentation/kbuild/makefiles.rst:1154: (WARNING/2) Inline emphasis start-string without end-string.
    
    These hunks were added by commit e846f0dc ("kbuild: add support
    for ensuring headers are self-contained") and commit 1e21cbfa
    ("kbuild: support header-test-pattern-y"), respectively. They were
    written not for ReST but for the plain text, and merged via the
    kbuild tree.
    
    In the same development cycle, this document was converted to ReST
    by commit cd238eff ("docs: kbuild: convert docs to ReST and rename
    to *.rst"), and merged via the doc sub-system.
    
    Merging them together into Linus' tree resulted in the current situation.
    
    To fix the syntax, surround the asterisks with back-quotes, and
    use :: for the code sample.
    
    Fixes: 39ceda5c ("Merge tag 'kbuild-v5.3' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild")
    Signed-off-by: default avatarMasahiro Yamada <yamada.masahiro@socionext.com>
    4fef9dec
makefiles.rst 47.9 KB