Re: [PATCH v2 04/24] docs: lockdep-design: fix some warning issues

From: Matthew Wilcox
Date: Tue Oct 13 2020 - 09:11:23 EST


On Tue, Oct 13, 2020 at 02:52:06PM +0200, Peter Zijlstra wrote:
> On Tue, Oct 13, 2020 at 02:14:31PM +0200, Mauro Carvalho Chehab wrote:
> > + ===== ===================================================
> > + ``.`` acquired while irqs disabled and not in irq context
> > + ``-`` acquired in irq context
> > + ``+`` acquired with irqs enabled
> > + ``?`` acquired in irq context with irqs enabled.
> > + ===== ===================================================
>
> NAK!

You're seriously suggesting that:

- === ===================================================
- '.' acquired while irqs disabled and not in irq context
- '-' acquired in irq context
- '+' acquired with irqs enabled
- '?' acquired in irq context with irqs enabled.
- === ===================================================
+ ===== ===================================================
+ ``.`` acquired while irqs disabled and not in irq context
+ ``-`` acquired in irq context
+ ``+`` acquired with irqs enabled
+ ``?`` acquired in irq context with irqs enabled.
+ ===== ===================================================

this change makes the lockdep docs less readable?

It's not the markup that makes the lockdep documentation hard to
understand.