Re: [PATCH v2] docs: Convert the Speakup guide to rst

From: Samuel Thibault <samuel.thibault@ens-lyon.org>
To: Igor Torrente <igormtorrente@gmail.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
	corbet@lwn.net, gregkh@linuxfoundation.org,
	grandmaster@al2klimov.de, rdunlap@infradead.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] docs: Convert the Speakup guide to rst
Date: Tue, 1 Jun 2021 23:57:23 +0200	[thread overview]
Message-ID: <20210601215723.7kwakixrrizba3bu@begin> (raw)
In-Reply-To: <1b1e0e07-d438-0902-a28a-e346cba53518@gmail.com>

Igor Torrente, le mar. 01 juin 2021 12:11:26 -0300, a ecrit:
> > > +| acntsa -- Accent SA
> > > +| acntpc -- Accent PC
> > > +| apollo -- Apollo
> > > +| audptr -- Audapter
> > > +| bns -- Braille 'n Speak
> > > +| dectlk -- DecTalk Express (old and new, db9 serial only)
> > > +| decext -- DecTalk (old) External
> > > +| dtlk -- DoubleTalk PC
> > > +| keypc -- Keynote Gold PC
> > > +| ltlk -- DoubleTalk LT, LiteTalk, or external Tripletalk (db9 serial only)
> > > +| spkout -- Speak Out
> > > +| txprt -- Transport
> > > +| dummy -- Plain text terminal
> > 
> > Looks like a definition list?
> > 
> > https://docutils.sourceforge.io/docs/user/rst/quickref.html#definition-lists
> 
> If the '|' is replaced by definition-list, I'll have to skip a line to each
> item so the sphinx doesn't concatenate them into a single line. Like this:
> 
> keywords
>   acntsa -- Accent SA
> 
>   acntpc -- Accent PC
> 
>   apollo -- Apollo
>   [...]
> 
> 
> There's a way to do that without these blank lines?

The blank line isn't really a problem.

> > > +Document License
> > > +================
> > > +
> > 
> > Using SPDX might be nice.
> 
> I was just trying to respect the original text as much as possible, but I
> don't mind change it if everybody agrees with it.

SPDX should be fine.

Samuel