texlive[71079] Master: json doc
commits+karl at tug.org
commits+karl at tug.org
Fri Apr 26 00:15:30 CEST 2024
Revision: 71079
https://tug.org/svn/texlive?view=revision&revision=71079
Author: karl
Date: 2024-04-26 00:15:30 +0200 (Fri, 26 Apr 2024)
Log Message:
-----------
json doc
Modified Paths:
--------------
trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
trunk/Master/tlpkg/doc/json-formats.txt
Modified: trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2024-04-25 20:14:25 UTC (rev 71078)
+++ trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2024-04-25 22:15:30 UTC (rev 71079)
@@ -1713,7 +1713,7 @@
my @datafields;
my $fmt = "list";
if ($opts{'data'} && $opts{'json'}) {
- tlwarn("Preferring json output over data output!\n");
+ tlwarn("Preferring JSON output over data output!\n");
delete($opts{'data'});
}
if ($opts{'json'}) {
@@ -8626,7 +8626,7 @@
=item B<--json>
Instead of dumping the actual content, the database is dumped as
-JSON. For the format of JSON output see C<tlpkg/doc/JSON-formats.txt>,
+JSON. For the format of JSON output see C<tlpkg/doc/json-formats.txt>,
format definition C<TLPDB>.
=back
@@ -8850,11 +8850,11 @@
=item B<--json>
-In case C<--json> is specified, the output is a JSON encoded array where
-each array element is the JSON representation of a single C<TLPOBJ> but
-with additional information. For details see
-C<tlpkg/doc/JSON-formats.txt>, format definition: C<TLPOBJINFO>. If both
-C<--json> and C<--data> are given, C<--json> takes precedence.
+If C<--json> is specified, the output is a JSON encoded array where each
+array element is the JSON representation of a single C<TLPOBJ> but with
+additional information. For details see C<tlpkg/doc/json-formats.txt>,
+format definition: C<TLPOBJINFO>. If both C<--json> and C<--data> are
+given, C<--json> takes precedence.
=back
@@ -8989,7 +8989,7 @@
Both C<show...> forms take an option C<--json>, which dumps the option
information in JSON format. In this case, both forms dump the same
data. For the format of the JSON output see
-C<tlpkg/doc/JSON-formats.txt>, format definition C<TLOPTION>.
+C<tlpkg/doc/json-formats.txt>, format definition C<TLOPTION>.
In the third form, with I<key>, if I<value> is not given, the setting
for I<key> is displayed. If I<value> is present, I<key> is set to
@@ -9105,7 +9105,7 @@
If C<--json> is specified without other options, the paper setup is
dumped in JSON format. For the format of JSON output see
-C<tlpkg/doc/JSON-formats.txt>, format definition C<TLPAPER>.
+C<tlpkg/doc/json-formats.txt>, format definition C<TLPAPER>.
Incidentally, this syntax of having a specific program name before the
C<paper> keyword is unusual. It is inherited from the longstanding
@@ -9443,10 +9443,11 @@
=item B<--json>
-When listing backups, the option C<--json> turn on JSON output.
-The format is an array of JSON objects (C<name>, C<rev>, C<date>).
-For details see C<tlpkg/doc/JSON-formats.txt>, format definition: C<TLBACKUPS>.
-If both C<--json> and C<--data> are given, C<--json> takes precedence.
+When listing backups, the option C<--json> writes JSON output. The
+format is an array of JSON objects (C<name>, C<rev>, C<date>). For
+details see C<tlpkg/doc/json-formats.txt>, format definition:
+C<TLBACKUPS>. If both C<--json> and C<--data> are given, C<--json> takes
+precedence.
=back
@@ -9492,9 +9493,10 @@
=item B<--json>
-Output search results as json hash with two keys: B<files> and B<packages>.
+Output search results as a JSON hash with two keys: B<files> and
+B<packages>. For the format of the JSON output see
+C<tlpkg/doc/json-formats.txt>, format definition C<TLSEARCH>.
-
=back
=back
Modified: trunk/Master/tlpkg/doc/json-formats.txt
===================================================================
--- trunk/Master/tlpkg/doc/json-formats.txt 2024-04-25 20:14:25 UTC (rev 71078)
+++ trunk/Master/tlpkg/doc/json-formats.txt 2024-04-25 22:15:30 UTC (rev 71079)
@@ -4,7 +4,7 @@
JSON formats for the various outputs of tlmgr
=============================================
-Fields guaranteed to be present are marked with a *
+Fields guaranteed to be present are marked with a *.
TLPOBJ
------
@@ -40,7 +40,6 @@
- cataloguedata: keys are topics, version, license, ctan, date, related (all strings)
Example: { "topics": "graphic", "version": "1.23" }
-
Note: A minimal TLPOBJ might look like
{
"name": "minimal",
@@ -49,7 +48,6 @@
}
-
TLPOBJINFO
----------
This JSON format is dumped on tlmgr info --data json and is slightly different
@@ -78,8 +76,8 @@
TLPDB
-----
This format is used when dumping tlpdb, local or remote
-JSON object with the following fields:
-keys are tags, values are tlpdb in TLPDBSINGLE format
+JSON object with the following fields.
+Keys are tags, values are tlpdb in TLPDBSINGLE format.
Example:
{
"main": {
@@ -92,6 +90,7 @@
}
}
+
TLBACKUP
--------
This format is used when dumping available backups via the
@@ -115,7 +114,7 @@
TLPAPER
-------
-array of objects, each one having three keys: program, file, options.
+An array of objects, each one having three keys: program, file, options.
`program' gives the program name, `file' the place where the configuration
has been found, and `options' is an array of strings with the first
one being the currently selected paper.
@@ -132,8 +131,8 @@
TLOPTION / TLSETTING
--------------------
-each option/setting is an object with the following keys, values
-are all strings(!)
+Each option/setting is an object with the following keys, values
+are all strings(!).
for TLOPTIONS:
name, tlmgrname, description, format, default, value (optional)
for TLSETTING:
@@ -147,7 +146,7 @@
"default" : "1",
"name" : "install_srcfiles"
},
-Example TLSETTING
+Example TLSETTING:
{
"type" : "b",
"description" : "This tree acts as user tree",
@@ -155,4 +154,5 @@
},
-
+TLSEARCH
+--------
More information about the tex-live-commits
mailing list.