Discussion:
[BUG] Generated man page includes personal information (hostname)
SanskritFritz
2014-04-04 14:36:27 UTC
Permalink
The generated man page "--client-name" section contains the hostname
the build was run on.

For example http://liw.fi/obnam/obnam.1.txt
The following line:

--client-name=CLIENT-NAME
name of client (havelock)

contains "havelock" which is the host name of the machine the manpage
was generated on. It doesn't seem to be a big problem on source -based
distros, but when obnam gets distributed in binary form with
precompiled man pages, it will include the developers hostname.

Cheers
SanskritFritz
SanskritFritz
2014-04-04 22:09:43 UTC
Permalink
Post by SanskritFritz
The generated man page "--client-name" section contains the hostname
the build was run on.
For example http://liw.fi/obnam/obnam.1.txt
--client-name=CLIENT-NAME
name of client (havelock)
Also the home dir is listed here:

--ssh-known-hosts=FILENAME
filename of the user's known hosts file (default:
/home/liw/.ssh/known_hosts)
Lars Wirzenius
2014-04-07 08:37:01 UTC
Permalink
Post by SanskritFritz
The generated man page "--client-name" section contains the hostname
the build was run on.
For example http://liw.fi/obnam/obnam.1.txt
--client-name=CLIENT-NAME
name of client (havelock)
contains "havelock" which is the host name of the machine the manpage
was generated on. It doesn't seem to be a big problem on source -based
distros, but when obnam gets distributed in binary form with
precompiled man pages, it will include the developers hostname.
Aye, this is true.

The whole habit of including the default in the --help output is
something I'm a bit undecided on. On the one hand, it is nice for a
user to immediately see what the default value is. On the other hand,
it results in the problem you report, and needs to be added for each
option manually, and some options would have very long default values
(making it inappropriate to show them).

I've thus now decided to not include the default value in --help
output, and thus also not in the generated manpage. The proper way to
see the current value of a setting is with --dump-config.

Fix in git master now.
http://git.liw.fi/cgi-bin/cgit/cgit.cgi/obnam/commit/?id=76e1ed0c672562987a24c57633a85218a2742e1a
--
http://www.cafepress.com/trunktees -- geeky funny T-shirts
http://gtdfh.branchable.com/ -- GTD for hackers
Loading...