Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Em Mon, 28 Nov 2016 14:46:45 +0100 Daniel Vetter escreveu: > On Mon, Nov 28, 2016 at 12:54:13PM +0100, Peter Zijlstra wrote: > > On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote: > > > - use *foo* (for italics) or **foo** (for bold) instead of _foo_; > >

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, 28 Nov 2016 15:13:14 +0100 Daniel Vetter wrote: > Jon, should we document that we want a very light-handed approach to rst > markup in kernel docs? This has come up a few times now, and irrespective > of what exactly we're going to do with atomic_ops.txt I think it would

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Hi Peter, On Mon, Nov 28, 2016 at 11:20:09AM +0100, Peter Zijlstra wrote: > On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote: > > > Why change them? What was wrong with txt to begin with? > > > > In my opinion good docs matter, and one of the key things is to be able to > > cross

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 12:54:13PM +0100, Peter Zijlstra wrote: > On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote: > > - use *foo* (for italics) or **foo** (for bold) instead of _foo_; > > That's daft, and also you're wrong. The normal convention is: > > /italic/ >

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, 28 Nov 2016, Peter Zijlstra wrote: > On Mon, Nov 28, 2016 at 01:16:45PM +0200, Jani Nikula wrote: >> Using rst we can produce decent HTML pages, and make them available at >> [1], in context. You don't have to read that, but it will be a lot more >> discoverable for

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 01:16:45PM +0200, Jani Nikula wrote: > Using rst we can produce decent HTML pages, and make them available at > [1], in context. You don't have to read that, but it will be a lot more > discoverable for other people, another important quality of good > documentation. And

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote: > - use *foo* (for italics) or **foo** (for bold) instead of _foo_; That's daft, and also you're wrong. The normal convention is: /italic/ *bold* _underlined_ >

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, 28 Nov 2016, Peter Zijlstra wrote: > On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote: > >> > >> > Why change them? What was wrong with txt to begin with? >> >> In my opinion good docs matter, and one of the key things is to be able to >> cross

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Em Mon, 28 Nov 2016 11:20:09 +0100 Peter Zijlstra escreveu: > On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote: > > > > > > > Why change them? What was wrong with txt to begin with? > > > > In my opinion good docs matter, and one of the key things is to be

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote: > > > > Why change them? What was wrong with txt to begin with? > > In my opinion good docs matter, and one of the key things is to be able to > cross reference stuff. Well, good docs begin with useful content; and many docs lack

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Sun, Nov 27, 2016 at 04:59:14PM -0700, Jonathan Corbet wrote: > On Fri, 25 Nov 2016 22:58:14 +0100 > Peter Zijlstra wrote: > > > Not a fan of this. The atomic_ops.txt file needs a lot of love, and I > > wouldn't want to edit a .rst file. > > > > Then again, I probably

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Fri, 25 Nov 2016 22:58:14 +0100 Peter Zijlstra wrote: > Not a fan of this. The atomic_ops.txt file needs a lot of love, and I > wouldn't want to edit a .rst file. > > Then again, I probably won't actually get around to fixing this document > any time soon either. > >

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Sun, 27 Nov 2016, "S. Fricke" wrote: > Hi Peter, > >> On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote: >> > ... and move to core-api folder. >> > >> > Signed-off-by: Silvio Fricke >> > --- >> > Documentation/atomic_ops.txt =>

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Hi Peter, > On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote: > > ... and move to core-api folder. > > > > Signed-off-by: Silvio Fricke > > --- > > Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | > > 777

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote: > ... and move to core-api folder. > > Signed-off-by: Silvio Fricke > --- > Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 >

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Em Fri, 25 Nov 2016 15:59:45 +0100 Silvio Fricke escreveu: > ... and move to core-api folder. > > Signed-off-by: Silvio Fricke > --- > Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 >

[PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

... and move to core-api folder. Signed-off-by: Silvio Fricke --- Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 +--- Documentation/core-api/index.rst