Re: [PATCH net-next] doc: sfp-phylink: correct code indentation

[Russell King - ARM Linux admin <linux@armlinux.org.uk>]

On Tue, Mar 03, 2020 at 03:35:46PM -0800, David Miller wrote:
> From: Russell King <rmk+kernel@armlinux.org.uk>
> Date: Tue, 03 Mar 2020 13:29:42 +0000
> 
> > Using vim to edit the phylink documentation reveals some mistakes due
> > to the "invisible" pythonesque white space indentation that can't be
> > seen with other editors. Fix it.
> > 
> > Signed-off-by: Russell King <rmk+kernel@armlinux.org.uk>
> 
> I applied this, but you do know that GIT is going to warn about the
> trailing whitespace to me:
> 
> .git/rebase-apply/patch:29: trailing whitespace.
> 	
> .git/rebase-apply/patch:39: trailing whitespace.
> 	
> warning: 2 lines add whitespace errors.
> 
> Do the empty lines really need that leading TAB?

If vim's syntax colouring is correct, then it does need the tab for
the code sequence to be recognised as a block of code.

As kerneldoc is based on python, and white-space indentation defining
a block of code is a very (annoying) pythonesque thing, it seems that
vim's probably correct.  But... unless someone knows how the .rst
format really works...

It could be that vim's syntax colouring for .rst files is broken.
I was hoping that the documentation people would've spoken up about
that though, as I explicitly stated in the commit message that the
patch was based on vim's behaviour.

Not having the tabs causes vim to reverse-bold a lot of the file,
making it basically uneditable without sunglasses.

-- 
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTC broadband for 0.8mile line in suburbia: sync at 12.1Mbps down 622kbps up
According to speedtest.net: 11.9Mbps down 500kbps up