mbox series

[Openvpn-devel,0/2] Fix mistyped option names

Message ID 20200815120522.1404-1-mkroken@gmail.com
Headers show
Series Fix mistyped option names | expand

Message

Magnus Kroken Aug. 15, 2020, 2:05 a.m. UTC 
While preparing a 2.5_beta1 package, I had to look
back and forth betwenn various sources to get option
names right. It seems that in some places names are
altered to make grammatical sense, which I find
confusing.

"Data cipher" and "compression" are simply words, and
it makes sense to use the grammatically correct form 
whenever they are used. However I interpret --data-cipher, 
``--data-cipher`` and --compression as literal, as the dashes
and code highlighting hints that this is exactly how these
are used in configuration and commands. There is no option
--data-cipher in OpenVPN, so I would not expect the literal
--data-cipher to appear anywhere, even when a sentence refers
to one singular cipher in the list of --data-ciphers.

Magnus Kroken (2):
  Changes.rst: fix mistyped option names
  doc: fix typos in cipher-negotiation.rst

 Changes.rst                             | 10 +++++-----
 doc/man-sections/cipher-negotiation.rst |  4 ++--
 2 files changed, 7 insertions(+), 7 deletions(-)

Comments

Gert Doering Aug. 15, 2020, 9:03 a.m. UTC | #1 
Hi,

On Sat, Aug 15, 2020 at 02:05:20PM +0200, Magnus Kroken wrote:
> While preparing a 2.5_beta1 package, I had to look
> back and forth betwenn various sources to get option
> names right. It seems that in some places names are
> altered to make grammatical sense, which I find
> confusing.

Thanks for pointing that out, and of course you are right
that this needs fixing.  Thanks for your patches, will apply
ASAP (tomorrow-ish).

gert