Page MenuHome GnuPG
Create Task
Maniphest T6810

gpgv: missing entry in "FILES" section in gpgv.texi
Testing, NormalPublic
Actions

Description

The texinfo file doc/gpgv.texi describes how, with default options, the keybox "trustedkeys.kbx" is used or "trustedkeys.gpg" of the former is not found.
See paragraph in lines 62 to 69 in file doc/gpgv.texi.

However, the subsection "FILES" towards the end of this texinto file
a) does only list "trustedkeys.gpg" and not "trustedkeys.kbx";
b) does not list the preferred choice of file, but only the fall-back file.

I would suggest, that the FILES section does

  1. list both filenames.
  2. makes use of "${GNUPGHOME}" instead of "~/.gnupg" in order to be precise. However, this might be detrimental for readability and retained as "~/.gnupg".

A previous bug/improvement in the same area was: https://dev.gnupg.org/T4386

Revisions and Commits

rG GnuPG
rG42ee84197695 doc: Update for gpgv.

Related Objects

Event Timeline

qyanu created this task.Nov 11 2023, 5:24 PM
qyanu added a project: gnupg24 (gnupg-2.4.3).Nov 11 2023, 5:28 PM
qyanu removed a project: gnupg24 (gnupg-2.4.3).
qyanu added a comment.EditedNov 11 2023, 6:17 PM

I have prepared a first patch:

0001-gpgv-Update-used-keyrings-in-doc-FILES-section.patch1 KBDownload

It should be apply-able with git apply to the origin/master branch. (I think i have no possibility to create some pull-request directly here)

As i am not accustomed to submitting patches to gpg/gpgv, please let me know of any problems with the patch or the issue an i'll do what i can to alleviate them.

• werner triaged this task as Normal priority.Nov 12 2023, 1:21 PM
• werner edited projects, added Documentation, gnupg; removed Bug Report.
• gniibe added a subscriber: • gniibe.Nov 16 2023, 5:26 AM

Thank you. Applied and pushed in: rG260004747016: gpgv: Update used keyrings in doc FILES section

• gniibe claimed this task.Nov 16 2023, 5:29 AM

To align the documentation of GnuPG, we should not use GNUPGHOME in FILES section.
It may be controlled by --homedir as well as GNUPGHOME.
GNUPGHOME is addressed in the ENVIRONMENT section, so, I don't think it makes sense using $GNUPGHOME}/trustedkeys.kbx.

And our yat2man does not support your style change of @itemize @bullet. I'll fix this, too.

• gniibe changed the task status from Open to Testing.Nov 16 2023, 5:32 AM
• gniibe added a commit: rG42ee84197695: doc: Update for gpgv..Nov 16 2023, 5:32 AM