]> git.ipfire.org Git - thirdparty/openvpn.git/commit
Use bob.example.com and alice.example.com to improve clarity of documentation
authorPhillip Smith <fukawi2@gmail.com>
Tue, 22 Dec 2015 00:12:26 +0000 (11:12 +1100)
committerGert Doering <gert@greenie.muc.de>
Fri, 25 Dec 2015 14:14:51 +0000 (15:14 +0100)
commit0f7319906a9dff58226821b1686fd80f4e4e3b35
tree5c4b907f26cc82f4cc95a352e92e615e7644b4eb
parent0385cd4804c133d48857e4b3fbfe93a75ecc68a5
Use bob.example.com and alice.example.com to improve clarity of documentation

This patch uses generic "bob.example.com" and "alice.example.com"
hostnames to replace the current "may" and "june" examples. Generic
names chosen rather than other names like "server"/"client" or
"head-office"/"remote-office" etc which may create other unintended
or implicit meanings to the reader.

The example.com domain is set aside defined by IANA for use as
documentation examples. Refer to: http://www.iana.org/domains/reserved
Using this well-known domain makes comprehension of documentation easier.
This patch incorporates feedback from Gert Doering and Selva Nair.

Signed-off-by: Phillip Smith <fukawi2@gmail.com>
Acked-by: Steffan Karger <steffan.karger@fox-it.com>
Message-Id: <1450743146-9050-1-git-send-email-fukawi2@gmail.com>
URL: http://article.gmane.org/gmane.network.openvpn.devel/10875
Signed-off-by: Gert Doering <gert@greenie.muc.de>
doc/openvpn.8