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]

Message-ID: <20210531231515.GB8130@gregn.net>
Date:   Mon, 31 May 2021 16:15:15 -0700
From:   Gregory Nowak <greg@...gn.net>
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

On Tue, Jun 01, 2021 at 12:07:54AM +0200, Samuel Thibault wrote:
> 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.

It sounds OK to me with punctuation level set to 1, and using software
synthesis through espeakup. The formatting could be a problem if
someone is using a higher punctuation level, or a braille
display. Could a txtdocs option be implemented as a documentation
target for kernel builds, which would produce plain text files? That I
think would provide the best of both worlds where the guide could be
maintained as RST, but could be output in plain text like the format
the guide exists in now.

Another concern is that if the speakup guide is maintained in RST,
that could dissuade others from keeping it updated who don't already
know RST.

Greg

-- 
web site: http://www.gregn.net
gpg public key: http://www.gregn.net/pubkey.asc
skype: gregn1
(authorization required, add me to your contacts list first)
If we haven't been in touch before, e-mail me before adding me to your contacts.

--
Free domains: http://www.eu.org/ or mail dns-manager@...org