Home GnuPG
Diffusion GnuPG 82e309ad0688

tools: Add comments explaining the functions parameters.
82e309ad0688Unpublished

Unpublished Commit ยท Learn More

Not On Permanent Ref: This commit is not an ancestor of any permanent ref.

Description

tools: Add comments explaining the functions parameters.

* tools/gpgconf-comp.c (change_options_file): Add comments explaining
the functions parameters.
(change_options_program): Likewise.

From reading those two functions it is not clear why we write the new
configuration to the source file, and read the current configuration
from the destination file. The identifiers are named for the benefit
of the callee.

Note that identifiers that require that much explanation are poorly
chosen.

  • Signed-off-by: Justus Winter <justus@g10code.com>

Details

Provenance
justusAuthored on Jan 24 2017, 12:57 PM
Parents
rGb0348fdb2663: tools: Improve error handling.
Branches
Unknown
Tags
Unknown

Event Timeline

Justus Winter <justus@g10code.com> committed rG82e309ad0688: tools: Add comments explaining the functions parameters. (authored by Justus Winter <justus@g10code.com>).Jan 24 2017, 3:44 PM