linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 08/17] lib: bitmap.c: get rid of some doc warnings
Date: Tue, 17 Mar 2020 15:54:17 +0100	[thread overview]
Message-ID: <ac57e12e0b75cb723597db61296950ce2d6d8577.1584456635.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1584456635.git.mchehab+huawei@kernel.org>

There are two ascii art drawings there. Use a block markup tag there
in order to get rid of those warnings:

	./lib/bitmap.c:189: WARNING: Unexpected indentation.
	./lib/bitmap.c:190: WARNING: Block quote ends without a blank line; unexpected unindent.
	./lib/bitmap.c:190: WARNING: Unexpected indentation.
	./lib/bitmap.c:191: WARNING: Line block ends without a blank line.

It should be noticed that there's actually a syntax violation
right now, as something like:

	/**
	 ...
	 @src:

will be handled as a definition for @src parameter, and not as
part of a diagram. So, we need to add something before it, in
order for this to be processed the way it should.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 lib/bitmap.c | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/lib/bitmap.c b/lib/bitmap.c
index 89260aa342d6..21a7640c5eed 100644
--- a/lib/bitmap.c
+++ b/lib/bitmap.c
@@ -182,21 +182,22 @@ EXPORT_SYMBOL(__bitmap_shift_left);
  *
  * In pictures, example for a big-endian 32-bit architecture:
  *
- * @src:
- * 31                                   63
- * |                                    |
- * 10000000 11000001 11110010 00010101  10000000 11000001 01110010 00010101
- *                 |  |              |                                    |
- *                16  14             0                                   32
+ * The @src bitmap is::
  *
- * if @cut is 3, and @first is 14, bits 14-16 in @src are cut and @dst is:
+ *   31                                   63
+ *   |                                    |
+ *   10000000 11000001 11110010 00010101  10000000 11000001 01110010 00010101
+ *                   |  |              |                                    |
+ *                  16  14             0                                   32
  *
- * 31                                   63
- * |                                    |
- * 10110000 00011000 00110010 00010101  00010000 00011000 00101110 01000010
- *                    |              |                                    |
- *                    14 (bit 17     0                                   32
- *                        from @src)
+ * if @cut is 3, and @first is 14, bits 14-16 in @src are cut and @dst is::
+ *
+ *   31                                   63
+ *   |                                    |
+ *   10110000 00011000 00110010 00010101  00010000 00011000 00101110 01000010
+ *                      |              |                                    |
+ *                      14 (bit 17     0                                   32
+ *                          from @src)
  *
  * Note that @dst and @src might overlap partially or entirely.
  *
-- 
2.24.1


  parent reply	other threads:[~2020-03-17 14:54 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1584456635.git.mchehab+huawei@kernel.org>
2020-03-17 14:54 ` [PATCH 01/17] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 03/17] docs: pci: boot-interrupts.rst: improve html output Mauro Carvalho Chehab
2020-03-17 22:06   ` Bjorn Helgaas
2020-03-17 14:54 ` [PATCH 04/17] kernel: futex.c: get rid of a docs build warning Mauro Carvalho Chehab
2020-03-17 16:58   ` Peter Zijlstra
2020-03-17 17:36     ` Jonathan Corbet
2020-03-17 19:16       ` Peter Zijlstra
2020-03-20 15:28   ` Thomas Gleixner
2020-03-20 15:43     ` Jonathan Corbet
2020-03-20 16:00     ` Mauro Carvalho Chehab
2020-03-23 16:33       ` Thomas Gleixner
2020-03-17 14:54 ` [PATCH 05/17] devfreq: devfreq.h: get rid of some doc warnings Mauro Carvalho Chehab
2020-03-18  4:08   ` Chanwoo Choi
2020-03-17 14:54 ` [PATCH 06/17] firewire: firewire-cdev.hL get rid of a docs warning Mauro Carvalho Chehab
2020-03-17 17:27   ` Stefan Richter
2020-03-17 14:54 ` [PATCH 07/17] scripts: kernel-doc: proper handle @foo->bar() Mauro Carvalho Chehab
2020-03-17 14:54 ` Mauro Carvalho Chehab [this message]
2020-03-17 14:54 ` [PATCH 09/17] rcu: update.c: get rid of some doc warnings Mauro Carvalho Chehab
2020-03-17 16:45   ` Paul E. McKenney
2020-03-17 14:54 ` [PATCH 10/17] net: phy: sfp-bus.c: get rid of docs warnings Mauro Carvalho Chehab
2020-03-18  6:39   ` David Miller
2020-03-17 14:54 ` [PATCH 11/17] net: core: dev.c: fix a documentation warning Mauro Carvalho Chehab
2020-03-18  6:40   ` David Miller
2020-03-17 14:54 ` [PATCH 12/17] gpio: gpiolib.c: fix a doc warning Mauro Carvalho Chehab
2020-03-18  9:15   ` Bartosz Golaszewski
2020-03-27 10:22   ` Linus Walleij
2020-03-27 13:47     ` Mauro Carvalho Chehab
2020-03-27 19:25   ` Linus Walleij
2020-03-17 14:54 ` [PATCH 13/17] i2c: include/linux/i2c.h: " Mauro Carvalho Chehab
2020-03-17 15:03   ` Wolfram Sang
2020-03-17 15:05     ` Mauro Carvalho Chehab
2020-03-22 16:21   ` Wolfram Sang
2020-03-17 14:54 ` [PATCH 14/17] infiniband: pa_vnic_encap.h: get rid of a warning Mauro Carvalho Chehab
2020-03-19  0:36   ` Jason Gunthorpe
2020-03-27 14:32     ` Mauro Carvalho Chehab
2020-03-27 15:51       ` Jason Gunthorpe
2020-03-17 14:54 ` [PATCH 15/17] ata: libata-core: fix a doc warning Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 16/17] fs: inode.c: get rid of docs warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 17/17] regulator: driver.h: fix regulator_map_* function names Mauro Carvalho Chehab
2020-03-18 21:57   ` Applied "regulator: driver.h: fix regulator_map_* function names" to the regulator tree Mark Brown

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ac57e12e0b75cb723597db61296950ce2d6d8577.1584456635.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).