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

From: Igor Torrente
Date: Tue Jun 01 2021 - 19:43:27 EST


Hi Samuel,

On 6/1/21 6:57 PM, Samuel Thibault wrote:
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.

I have two questions about it.

1 - Should I only make this change when we have the 'acks' from all the previous contributors? Or can I change it to the v3?

2 - Is '.. SPDX-License-Identifier: GPL-2.0' at the beginning is enough?


Samuel


Thanks,
---
Igor M. A. Torrente