On Tue, Dec 15, 2015 at 8:46 PM, David Sommerseth <open...@sf.lists.topphemmelig.net> wrote: > On 30/11/15 04:03, Phillip Smith wrote: >> This patch uses the generic "host1.example.com" and "host2.example.com" to >> replace the current "may" and "june" hostname 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. >> >> Signed-off-by: Phillip Smith <fuka...@gmail.com> >> --- >> doc/openvpn.8 | 84 >> +++++++++++++++++++++++++++++------------------------------ >> 1 file changed, 42 insertions(+), 42 deletions(-) > > [...snip...] > >> -.B may.kg >> +.B host1.example.com >> and >> -.B june.kg. >> +.B host2.example.com. > > Any reason changing from {may, june} to {host1, host2}? I find > documentation to be easier to read when there are more than just one or > two letters changing. Especially when it is related to two different > systems you want to configure to talk to each other. For people > struggling with dyslexia, more diversity also helps a lot too. > > It doesn't need to be may or june. Could even be > "alice-laptop.example.org", "bob-workstaion.example.org" or something > more even more unique. Just have a broader variety.
Ooh, I like using alice and bob! Typical crypto example names, and easy to differentiate. But I would prefer to ditch the -laptop and -workstation, to prevent unintended or implicit meanings as Philip suggested. -Steffan