Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

On Mon, May 25, 2020 at 03:44:29PM +0200, Peter Zijlstra wrote: > I've never claimed that. My claim is that RST is shite and has no added > value. Or rather, it has negative value, for it makes comments less readable.

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

On Mon, May 25, 2020 at 11:36:49AM +0200, Ahmed S. Darwish wrote: > Peter Zijlstra wrote: > > I will not let sensible code comments deteriorate to the benefit of some > > external piece of crap. > > > > As a programmer the primary interface to all this is a text editor, not > > a web broswer or a

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

Peter Zijlstra wrote: > On Fri, May 22, 2020 at 08:26:44PM +0200, Thomas Gleixner wrote: > > Peter Zijlstra writes: > > > On Fri, May 22, 2020 at 08:02:54PM +0200, Peter Zijlstra wrote: > > >> On Tue, May 19, 2020 at 11:45:32PM +0200, Ahmed S. Darwish wrote: > > >> > Mark all C code samples insid

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

On Fri, May 22, 2020 at 08:26:44PM +0200, Thomas Gleixner wrote: > Peter Zijlstra writes: > > On Fri, May 22, 2020 at 08:02:54PM +0200, Peter Zijlstra wrote: > >> On Tue, May 19, 2020 at 11:45:32PM +0200, Ahmed S. Darwish wrote: > >> > Mark all C code samples inside seqlock.h kernel-doc text with

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

Peter Zijlstra writes: > On Fri, May 22, 2020 at 08:02:54PM +0200, Peter Zijlstra wrote: >> On Tue, May 19, 2020 at 11:45:32PM +0200, Ahmed S. Darwish wrote: >> > Mark all C code samples inside seqlock.h kernel-doc text with the RST >> > 'code-block: c' directive. Sphinx won't properly format the

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

On Fri, May 22, 2020 at 08:02:54PM +0200, Peter Zijlstra wrote: > On Tue, May 19, 2020 at 11:45:32PM +0200, Ahmed S. Darwish wrote: > > Mark all C code samples inside seqlock.h kernel-doc text with the RST > > 'code-block: c' directive. Sphinx won't properly format the example code > > and will pro

Re: [PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

On Tue, May 19, 2020 at 11:45:32PM +0200, Ahmed S. Darwish wrote: > Mark all C code samples inside seqlock.h kernel-doc text with the RST > 'code-block: c' directive. Sphinx won't properly format the example code > and will produce noisy text indentation warnings otherwise. I so bloody hate RST..

[PATCH v1 10/25] seqlock: Add RST directives to kernel-doc code samples and notes

Mark all C code samples inside seqlock.h kernel-doc text with the RST 'code-block: c' directive. Sphinx won't properly format the example code and will produce noisy text indentation warnings otherwise. Mark all kernel-doc "NOTE" sections with the RST 'attention' directive. Otherwise Sphinx produc