I decided to give a try with Sphinx last stable version (1.17.4), and noticed several issues. The worse one was with the networking book: a non-standard footnote there with [*] instead of a number causes it to break PDF building.
So, I took some spare time to address some warnings all over the tree, and moved a few text documents to a book. I with I had more time to move the other ones and to solve other warnings.
Mauro Carvalho Chehab (18): docs: can.rst: fix a footnote reference docs: fix location of request_firmware & friends docs: */index.rst: Add newer documents to their respective index.rst docs: admin-guide: add bcache documentation docs: core-api: add cachetlb documentation docs: core-api: add cgroup-v2 documentation docs: core-api: add circular-buffers documentation docs: driver-api: add clk documentation net: mac80211.h: fix a bad comment line rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff() docs: crypto_engine.rst: Fix two parse warnings time: timer.c: adjust a kernel-doc comment wait: wait.h: Get rid of a kernel-doc/Sphinx warnings fbdev: modedb.c: fix a kernel-doc markup iio: iio.h: use nested struct support on kernel-doc markup mtd: rawnand.h: use nested union kernel-doc markups docs: uio-howto.rst: use a code block to solve a warning w1: w1_io.c: fix a kernel-doc warning
Documentation/00-INDEX | 10 ------- .../{bcache.txt => admin-guide/bcache.rst} | 0 .../cgroup-v2.rst} | 0 Documentation/admin-guide/index.rst | 2 ++ .../admin-guide/kernel-parameters.txt | 2 +- .../{cachetlb.txt => core-api/cachetlb.rst} | 0 .../circular-buffers.rst} | 0 Documentation/core-api/index.rst | 2 ++ Documentation/crypto/crypto_engine.rst | 8 +++--- Documentation/crypto/index.rst | 1 + Documentation/dell_rbu.txt | 4 +-- Documentation/{clk.txt => driver-api/clk.rst} | 0 .../firmware/fallback-mechanisms.rst | 2 +- .../driver-api/firmware/request_firmware.rst | 17 +++++++----- Documentation/driver-api/index.rst | 2 ++ Documentation/driver-api/infrastructure.rst | 2 +- Documentation/driver-api/uio-howto.rst | 3 ++- Documentation/memory-barriers.txt | 4 +-- Documentation/networking/can.rst | 4 +-- .../power/suspend-and-cpuhotplug.txt | 2 +- Documentation/process/index.rst | 1 + Documentation/security/index.rst | 2 ++ .../translations/ko_KR/memory-barriers.txt | 4 +-- drivers/video/fbdev/core/modedb.c | 22 ++++++++-------- drivers/w1/w1_io.c | 1 + include/linux/iio/iio.h | 24 ++++++++--------- include/linux/mtd/rawnand.h | 26 +++++++++++++------ include/linux/rcupdate.h | 5 ++-- include/linux/wait.h | 2 +- include/net/mac80211.h | 2 +- kernel/time/timer.c | 14 +++++----- 31 files changed, 93 insertions(+), 75 deletions(-) rename Documentation/{bcache.txt => admin-guide/bcache.rst} (100%) rename Documentation/{cgroup-v2.txt => admin-guide/cgroup-v2.rst} (100%) rename Documentation/{cachetlb.txt => core-api/cachetlb.rst} (100%) rename Documentation/{circular-buffers.txt => core-api/circular-buffers.rst} (100%) rename Documentation/{clk.txt => driver-api/clk.rst} (100%)
Use code blocks to avoid those warnings and make it look nicer.
./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org --- drivers/video/fbdev/core/modedb.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/drivers/video/fbdev/core/modedb.c b/drivers/video/fbdev/core/modedb.c index 2510fa728d77..7284324fbd77 100644 --- a/drivers/video/fbdev/core/modedb.c +++ b/drivers/video/fbdev/core/modedb.c @@ -642,23 +642,23 @@ static int fb_try_mode(struct fb_var_screeninfo *var, struct fb_info *info, * @default_mode fails, all modes in the video mode database will * be tried. * - * Valid mode specifiers for @mode_option: + * Valid mode specifiers for @mode_option:: * - * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m] or - * <name>[-<bpp>][@<refresh>] + * <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m] or + * <name>[-<bpp>][@<refresh>] * * with <xres>, <yres>, <bpp> and <refresh> decimal numbers and * <name> a string. * - * If 'M' is present after yres (and before refresh/bpp if present), - * the function will compute the timings using VESA(tm) Coordinated - * Video Timings (CVT). If 'R' is present after 'M', will compute with - * reduced blanking (for flatpanels). If 'i' is present, compute - * interlaced mode. If 'm' is present, add margins equal to 1.8% - * of xres rounded down to 8 pixels, and 1.8% of yres. The char - * 'i' and 'm' must be after 'M' and 'R'. Example: + * If 'M' is present after yres (and before refresh/bpp if present), + * the function will compute the timings using VESA(tm) Coordinated + * Video Timings (CVT). If 'R' is present after 'M', will compute with + * reduced blanking (for flatpanels). If 'i' is present, compute + * interlaced mode. If 'm' is present, add margins equal to 1.8% + * of xres rounded down to 8 pixels, and 1.8% of yres. The char + * 'i' and 'm' must be after 'M' and 'R'. Example:: * - * 1024x768MR-8@60m - Reduced blank with margins at 60Hz. + * 1024x768MR-8@60m - Reduced blank with margins at 60Hz. * * NOTE: The passed struct @var is _not_ cleared! This allows you * to supply values for e.g. the grayscale and accel_flags fields.
On Monday, May 07, 2018 06:35:50 AM Mauro Carvalho Chehab wrote:
Use code blocks to avoid those warnings and make it look nicer.
./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string. ./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org
Acked-by: Bartlomiej Zolnierkiewicz b.zolnierkie@samsung.com
Best regards, -- Bartlomiej Zolnierkiewicz Samsung R&D Institute Poland Samsung Electronics
On Mon, 7 May 2018 06:35:36 -0300 Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
I decided to give a try with Sphinx last stable version (1.17.4), and noticed several issues. The worse one was with the networking book: a non-standard footnote there with [*] instead of a number causes it to break PDF building.
So, I took some spare time to address some warnings all over the tree, and moved a few text documents to a book.
OK, I've applied the ones that seem to make sense for me to take now. There's comments on the firmware one, and I'd rather have Tejun's OK for the cgroup one. The code-comment changes should probably go via the usual maintainers.
I with I had more time to move the other ones and to solve other warnings.
You and me both - but each step helps!
Thanks,
jon
On Tue, May 08, 2018 at 10:13:42AM -0600, Jonathan Corbet wrote:
On Mon, 7 May 2018 06:35:36 -0300 Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
I decided to give a try with Sphinx last stable version (1.17.4), and noticed several issues. The worse one was with the networking book: a non-standard footnote there with [*] instead of a number causes it to break PDF building.
So, I took some spare time to address some warnings all over the tree, and moved a few text documents to a book.
OK, I've applied the ones that seem to make sense for me to take now. There's comments on the firmware one,
I'll fold in the fixes for the firmware API which do apply to my queue.
Luis
dri-devel@lists.freedesktop.org