linux-kernel - Re: docs: Convert the Speakup guide to rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 1 Jun 2021 02:31:06 +0300
From:   Alexander Epaneshnikov <aarnaarn2@...il.com>
To:     Samuel Thibault <samuel.thibault@...-lyon.org>,
        Igor Matheus Andrade Torrente <igormtorrente@...il.com>,
        speakup@...ux-speakup.org, corbet@....net,
        gregkh@...uxfoundation.org, grandmaster@...klimov.de,
        rdunlap@...radead.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: docs: Convert the Speakup guide to rst


01.06.2021 01:07, Samuel Thibault пишет:
> Hello,
>
> Adding the speakup list in the loop.
>
> Igor Matheus Andrade Torrente wrote:
>> Modify some parts of the text and add the necessary formatting to leverage
>> the rst features. Including links, code-blocks, bullet lists, etc.
>>
>> Also, adds a table of contents at the beginning and a section to the
>> license.
>>
>> This change helps integrate this documentation to the rest of the rst
>> documentation.
> Mmm, I'm unsure how the result is readable with the speakup screen
> reader itself. I have attached the result, could people on the speakup
> mailing list check how well it goes? If it significantly degrades
> readability, we'll have to reject the move to rst formatting, since in
> the end it's people who use the speakup screen reader who need to be
> able to read this document.
>
I think this is a great change. to be honest - I myself thought to do it 
a few months ago.

As for readability, rst is a rather minimalistic format, so it is 
convenient to perceive it even in a raw format, and the advantages of 
using it, in my opinion, outweigh all the non-conveniences that I do not 
observe.


> Samuel


Alexander