| Message ID | 20230120123534.137413-2-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation fixes for linux-next (Jan 20) | expand |
On 1/20/2023 5:35 AM, Bagas Sanjaya wrote: > Stephen Rothwell reported htmldocs warning then merging accel tree: > > Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string. > > Sphinx confuses the file wildcards with inline emphasis (italics), hence > the warning. > > Fix the warning by escaping wildcards. > > Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/ > Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Thanks for addressing this before I even saw the warning report. Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
On Fri, Jan 20, 2023 at 5:00 PM Jeffrey Hugo <quic_jhugo@quicinc.com> wrote: > > On 1/20/2023 5:35 AM, Bagas Sanjaya wrote: > > Stephen Rothwell reported htmldocs warning then merging accel tree: > > > > Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string. > > > > Sphinx confuses the file wildcards with inline emphasis (italics), hence > > the warning. > > > > Fix the warning by escaping wildcards. > > > > Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/ > > Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path") > > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > > Thanks for addressing this before I even saw the warning report. > > Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com> Thanks. Picked up to my tree (as the original commit is in my tree). Oded
diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst index 11cade51f387a6..89984dfececf0b 100644 --- a/Documentation/accel/introduction.rst +++ b/Documentation/accel/introduction.rst @@ -67,9 +67,9 @@ tree - drivers/accel/. The accelerator devices will be exposed to the user space with the dedicated 261 major number and will have the following convention: -- device char files - /dev/accel/accel* -- sysfs - /sys/class/accel/accel*/ -- debugfs - /sys/kernel/debug/accel/*/ +- device char files - /dev/accel/accel\* +- sysfs - /sys/class/accel/accel\*/ +- debugfs - /sys/kernel/debug/accel/\*/ Getting Started ===============
Stephen Rothwell reported htmldocs warning then merging accel tree: Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string. Sphinx confuses the file wildcards with inline emphasis (italics), hence the warning. Fix the warning by escaping wildcards. Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/ Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/accel/introduction.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)