commit 0c54ff92fbff638e193cf6fe971867948f307e20
from: Stefan Sperling <stsp@stsp.name>
via: Thomas Adam <thomas.adam22@gmail.com>
date: Sun May 05 09:50:52 2024 UTC

in gotd.conf(5) use .Sq instead of .Dv when referring to JSON field names

Reads better because .Dv has no discernable effect in terminal or HTML.

discussed with op@

commit - 708a729b1a69fe9c7aed6019dfe1ccbe8e3dd05b
commit + 0c54ff92fbff638e193cf6fe971867948f307e20
blob - 9cc8fda2a61965f77b897eaa852ed8812f2ed7e6
blob + 80848550d9f189c5f02f34fea14379857dbd78a1
--- gotd/gotd.conf.5
+++ gotd/gotd.conf.5
@@ -406,7 +406,7 @@ This is the only field guaranteed to be set.
 .It Dv author
 An object with the author information.
 Has the same fields as the
-.Dv committer
+.Sq committer
 but may be unset.
 .It Dv date
 Number, representing the number of seconds since the Epoch in UTC.
@@ -418,9 +418,9 @@ The complete commit message, may be unset.
 .It Dv diffstat
 An object with the summarized changes, may be unset.
 Contains a
-.Dv files
+.Sq files
 field with an array of objects describing the changes per-file and a
-.Dv total
+.Sq total
 field with the cumulative changes.
 The changes per-file contains the following fields:
 .Pp
@@ -442,11 +442,11 @@ The number of lines removed.
 .El
 .Pp
 The
-.Dv total
+.Sq total
 object contains two fields:
-.Dv added
+.Sq added
 and
-.Dv removed
+.Sq removed
 which are the number of added and removed lines respectively.
 .El
 .It Dv branch-deleted
@@ -465,18 +465,18 @@ The tag notification has the following fields, all gua
 The tag reference.
 .It tagger
 The user information, with the same format of the
-.Dv committer
+.Sq committer
 field for the
-.Dv commit
+.Sq commit
 notification but with all the field guaranteed to be set.
 .It Dv date
 Number, representing the number of seconds since the Epoch in UTC.
 .It Dv object
 The object being tagged.
 It contains the fields
-.Dv type
+.Sq type
 with the object type and
-.Dv id
+.Sq id
 with the object id being tagged.
 .It Dv message
 The tag message.