Thread (42 messages) 42 messages, 6 authors, 2020-07-21

Re: [PATCH v3 01/20] Documentation: locking: Describe seqlock design and usage

From: Ahmed S. Darwish <hidden>
Date: 2020-07-07 10:12:05
Also in: lkml

On Mon, Jul 06, 2020 at 11:04:39PM +0200, Peter Zijlstra wrote:
On Tue, Jun 30, 2020 at 07:44:33AM +0200, Ahmed S. Darwish wrote:
quoted
+Sequence counters (:c:type:`seqcount_t`)
+========================================
quoted
+.. code-block:: c
I so hate RST, of course it's C. Also, ISTR Jon saying you can leave
that all out without issue.
There you go again.

  linux$ git grep 'code-block:: c' | wc -l
  ==>  470

  linux$ git grep ':ref:' | wc -l
  ==>  3171

  linux$ git grep ':c:type:' | wc -l
  ==>  1533

In writing this, Documentation/doc-guide/ was followed, and literally
the thousands of examples above.

But honestly, I don't want to block merging documentation because of
this, and the point of making the docs as readable as possible from text
editors also has merit.

So... I'll just make that file as "RST-lite" as possible.

Thanks,

--
Ahmed S. Darwish
Linutronix GmbH
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help