diff options
author | Jon Turney <jon.turney@dronecode.org.uk> | 2019-06-11 12:21:13 +0300 |
---|---|---|
committer | Jon Turney <jon.turney@dronecode.org.uk> | 2019-06-11 19:59:08 +0300 |
commit | dd2acec3d8d881e9560f3f07455f138a140248b8 (patch) | |
tree | 151fa536be09e4c3f2e97152ce638dfed4fd3ca6 | |
parent | 05fd42a2837950e66d744caf10e076311db6dd49 (diff) |
Use summary/description rather than sdesc/ldesc in package summary page
Also HTML escape those texts
23 files changed, 46 insertions, 46 deletions
diff --git a/calm/pkg2html.py b/calm/pkg2html.py index 9409e8e..54edca4 100755 --- a/calm/pkg2html.py +++ b/calm/pkg2html.py @@ -176,8 +176,8 @@ def update_package_listings(args, packages): <!--#include virtual="/top.html" --> <h1>Package: %s</h1>''' % (title, p)), file=f) - print('<span class="detail">sdesc</span>: %s<br><br>' % sdesc(arch_packages, p, bv), file=f) - print('<span class="detail">ldesc</span>: %s<br><br>' % ldesc(arch_packages, p, bv), file=f) + print('<span class="detail">summary</span>: %s<br><br>' % html.escape(sdesc(arch_packages, p, bv), quote=False), file=f) + print('<span class="detail">description</span>: %s<br><br>' % html.escape(ldesc(arch_packages, p, bv), quote=False), file=f) print('<span class="detail">categories</span>: %s<br><br>' % arch_packages[p].version_hints[bv].get('category', ''), file=f) for key in ['depends', 'obsoletes', 'provides', 'conflicts', 'build-depends']: diff --git a/test/testdata/htdocs.expected/summary/arc.html b/test/testdata/htdocs.expected/summary/arc.html index a848293..2d988b8 100644 --- a/test/testdata/htdocs.expected/summary/arc.html +++ b/test/testdata/htdocs.expected/summary/arc.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: arc</h1> -<span class="detail">sdesc</span>: The ARC archive utility<br><br> -<span class="detail">ldesc</span>: This program is based on the MSDOS ARC program, version 5.21, plus a +<span class="detail">summary</span>: The ARC archive utility<br><br> +<span class="detail">description</span>: This program is based on the MSDOS ARC program, version 5.21, plus a few enhancements. ARC performs Huffman Squeezing on data. The Huffman Squeeze algorithm was removed from MSDOS ARC after version 5.12. It turns out to be more efficient than Lempel-Ziv style compression when diff --git a/test/testdata/htdocs.expected/summary/base-cygwin.html b/test/testdata/htdocs.expected/summary/base-cygwin.html index 24b3742..a0d814d 100644 --- a/test/testdata/htdocs.expected/summary/base-cygwin.html +++ b/test/testdata/htdocs.expected/summary/base-cygwin.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: base-cygwin</h1> -<span class="detail">sdesc</span>: Initial base installation helper script<br><br> -<span class="detail">ldesc</span>: Initial base installation helper script.<br><br> +<span class="detail">summary</span>: Initial base installation helper script<br><br> +<span class="detail">description</span>: Initial base installation helper script.<br><br> <span class="detail">categories</span>: Base<br><br> <span class="detail">binaries</span>: <br><br> <span class="detail">maintainer(s)</span>: Corinna Vinschen diff --git a/test/testdata/htdocs.expected/summary/corrupt.html b/test/testdata/htdocs.expected/summary/corrupt.html index 4c311c2..0b91c3a 100644 --- a/test/testdata/htdocs.expected/summary/corrupt.html +++ b/test/testdata/htdocs.expected/summary/corrupt.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: corrupt</h1> -<span class="detail">sdesc</span>: A corrupt package<br><br> -<span class="detail">ldesc</span>: A package containing corrupt archives<br><br> +<span class="detail">summary</span>: A corrupt package<br><br> +<span class="detail">description</span>: A package containing corrupt archives<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">binaries</span>: <a href="corrupt.html">corrupt</a><br><br> <span class="detail">maintainer(s)</span>: Blooey McFooey diff --git a/test/testdata/htdocs.expected/summary/cygwin-debuginfo.html b/test/testdata/htdocs.expected/summary/cygwin-debuginfo.html index af5d1e3..bf4d895 100644 --- a/test/testdata/htdocs.expected/summary/cygwin-debuginfo.html +++ b/test/testdata/htdocs.expected/summary/cygwin-debuginfo.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: cygwin-debuginfo</h1> -<span class="detail">sdesc</span>: Debug info for cygwin<br><br> -<span class="detail">ldesc</span>: This package contains files necessary for debugging the +<span class="detail">summary</span>: Debug info for cygwin<br><br> +<span class="detail">description</span>: This package contains files necessary for debugging the cygwin package with gdb.<br><br> <span class="detail">categories</span>: Debug<br><br> <span class="detail">depends</span>: <a href="cygwin-debuginfo.html">cygwin-debuginfo</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/cygwin-devel.html b/test/testdata/htdocs.expected/summary/cygwin-devel.html index d951336..1a443b8 100644 --- a/test/testdata/htdocs.expected/summary/cygwin-devel.html +++ b/test/testdata/htdocs.expected/summary/cygwin-devel.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: cygwin-devel</h1> -<span class="detail">sdesc</span>: Core development files<br><br> -<span class="detail">ldesc</span>: Core development files required to build Cygwin packages<br><br> +<span class="detail">summary</span>: Core development files<br><br> +<span class="detail">description</span>: Core development files required to build Cygwin packages<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">source</span>: <a href="cygwin.html">cygwin</a><br><br> <span class="detail">maintainer(s)</span>: Corinna Vinschen, Yaakov Selkowitz diff --git a/test/testdata/htdocs.expected/summary/cygwin.html b/test/testdata/htdocs.expected/summary/cygwin.html index cdd427e..b77856b 100644 --- a/test/testdata/htdocs.expected/summary/cygwin.html +++ b/test/testdata/htdocs.expected/summary/cygwin.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: cygwin</h1> -<span class="detail">sdesc</span>: The UNIX emulation engine<br><br> -<span class="detail">ldesc</span>: The UNIX emulation engine<br><br> +<span class="detail">summary</span>: The UNIX emulation engine<br><br> +<span class="detail">description</span>: The UNIX emulation engine<br><br> <span class="detail">categories</span>: Base<br><br> <span class="detail">depends</span>: <a href="base-cygwin.html">base-cygwin</a><br><br> <span class="detail">binaries</span>: <a href="cygwin.html">cygwin</a>, <a href="cygwin-debuginfo.html">cygwin-debuginfo</a>, <a href="cygwin-devel.html">cygwin-devel</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/keychain.html b/test/testdata/htdocs.expected/summary/keychain.html index a15fad4..392083b 100644 --- a/test/testdata/htdocs.expected/summary/keychain.html +++ b/test/testdata/htdocs.expected/summary/keychain.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: keychain</h1> -<span class="detail">sdesc</span>: Key manager for OpenSSH<br><br> -<span class="detail">ldesc</span>: Keychain is an OpenSSH key manager, typically run from +<span class="detail">summary</span>: Key manager for OpenSSH<br><br> +<span class="detail">description</span>: Keychain is an OpenSSH key manager, typically run from ~/.bash_profile. When keychain is run, it checks for a running ssh-agent, otherwise it starts one. It saves the ssh-agent environment variables to ~/.keychain/$HOSTNAME-sh, so that subsequent logins diff --git a/test/testdata/htdocs.expected/summary/libdns_sd-devel.html b/test/testdata/htdocs.expected/summary/libdns_sd-devel.html index 1a309c9..efa7fef 100644 --- a/test/testdata/htdocs.expected/summary/libdns_sd-devel.html +++ b/test/testdata/htdocs.expected/summary/libdns_sd-devel.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: libdns_sd-devel</h1> -<span class="detail">sdesc</span>: Bonjour Zeroconf implementation<br><br> -<span class="detail">ldesc</span>: Bonjour, also known as zero-configuration networking, enables +<span class="detail">summary</span>: Bonjour Zeroconf implementation<br><br> +<span class="detail">description</span>: Bonjour, also known as zero-configuration networking, enables automatic discovery of computers, devices, and services on IP networks using industry standard IP protocols.<br><br> <span class="detail">categories</span>: Net<br><br> diff --git a/test/testdata/htdocs.expected/summary/libdns_sd1.html b/test/testdata/htdocs.expected/summary/libdns_sd1.html index 40c926f..1b1e201 100644 --- a/test/testdata/htdocs.expected/summary/libdns_sd1.html +++ b/test/testdata/htdocs.expected/summary/libdns_sd1.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: libdns_sd1</h1> -<span class="detail">sdesc</span>: Bonjour Zeroconf implementation<br><br> -<span class="detail">ldesc</span>: Bonjour, also known as zero-configuration networking, enables +<span class="detail">summary</span>: Bonjour Zeroconf implementation<br><br> +<span class="detail">description</span>: Bonjour, also known as zero-configuration networking, enables automatic discovery of computers, devices, and services on IP networks using industry standard IP protocols.<br><br> <span class="detail">categories</span>: Net<br><br> diff --git a/test/testdata/htdocs.expected/summary/mDNSResponder.html b/test/testdata/htdocs.expected/summary/mDNSResponder.html index 49c3740..94788d1 100644 --- a/test/testdata/htdocs.expected/summary/mDNSResponder.html +++ b/test/testdata/htdocs.expected/summary/mDNSResponder.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: mDNSResponder</h1> -<span class="detail">sdesc</span>: Bonjour Zeroconf implementation<br><br> -<span class="detail">ldesc</span>: Bonjour, also known as zero-configuration networking, enables +<span class="detail">summary</span>: Bonjour Zeroconf implementation<br><br> +<span class="detail">description</span>: Bonjour, also known as zero-configuration networking, enables automatic discovery of computers, devices, and services on IP networks using industry standard IP protocols.<br><br> <span class="detail">categories</span>: Net<br><br> diff --git a/test/testdata/htdocs.expected/summary/obs-a.html b/test/testdata/htdocs.expected/summary/obs-a.html index e069b83..0d32039 100644 --- a/test/testdata/htdocs.expected/summary/obs-a.html +++ b/test/testdata/htdocs.expected/summary/obs-a.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: obs-a</h1> -<span class="detail">sdesc</span>: obsolete package A<br><br> -<span class="detail">ldesc</span>: obs-a<br><br> +<span class="detail">summary</span>: obsolete package A<br><br> +<span class="detail">description</span>: obs-a<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">binaries</span>: <a href="obs-a.html">obs-a</a><br><br> <span class="detail">maintainer(s)</span>: ORPHANED diff --git a/test/testdata/htdocs.expected/summary/obs-b.html b/test/testdata/htdocs.expected/summary/obs-b.html index 0e9f2ae..3062af6 100644 --- a/test/testdata/htdocs.expected/summary/obs-b.html +++ b/test/testdata/htdocs.expected/summary/obs-b.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: obs-b</h1> -<span class="detail">sdesc</span>: obsolete package B<br><br> -<span class="detail">ldesc</span>: obs-b<br><br> +<span class="detail">summary</span>: obsolete package B<br><br> +<span class="detail">description</span>: obs-b<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">binaries</span>: <a href="obs-b.html">obs-b</a><br><br> <span class="detail">maintainer(s)</span>: ORPHANED diff --git a/test/testdata/htdocs.expected/summary/openssh.html b/test/testdata/htdocs.expected/summary/openssh.html index 67bc7e4..a8a92be 100644 --- a/test/testdata/htdocs.expected/summary/openssh.html +++ b/test/testdata/htdocs.expected/summary/openssh.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: openssh</h1> -<span class="detail">sdesc</span>: The OpenSSH server and client programs<br><br> -<span class="detail">ldesc</span>: OpenSSH is a program for logging into a remote machine and for +<span class="detail">summary</span>: The OpenSSH server and client programs<br><br> +<span class="detail">description</span>: OpenSSH is a program for logging into a remote machine and for executing commands on a remote machine. It can replace rlogin and rsh, providing encrypted communication between two machines.<br><br> <span class="detail">categories</span>: Net<br><br> diff --git a/test/testdata/htdocs.expected/summary/per-version-replacement-hint-only.html b/test/testdata/htdocs.expected/summary/per-version-replacement-hint-only.html index 679f572..277fd3b 100644 --- a/test/testdata/htdocs.expected/summary/per-version-replacement-hint-only.html +++ b/test/testdata/htdocs.expected/summary/per-version-replacement-hint-only.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: per-version-replacement-hint-only</h1> -<span class="detail">sdesc</span>: Per-version hint test package<br><br> -<span class="detail">ldesc</span>: Per-version hint test package<br><br> +<span class="detail">summary</span>: Per-version hint test package<br><br> +<span class="detail">description</span>: Per-version hint test package<br><br> <span class="detail">categories</span>: Base<br><br> <span class="detail">depends</span>: <a href="cygwin.html">cygwin</a><br><br> <span class="detail">binaries</span>: <a href="per-version-replacement-hint-only.html">per-version-replacement-hint-only</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/per-version.html b/test/testdata/htdocs.expected/summary/per-version.html index 286f867..fe82cee 100644 --- a/test/testdata/htdocs.expected/summary/per-version.html +++ b/test/testdata/htdocs.expected/summary/per-version.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: per-version</h1> -<span class="detail">sdesc</span>: Per-version hint test package<br><br> -<span class="detail">ldesc</span>: Per-version hint test package<br><br> +<span class="detail">summary</span>: Per-version hint test package<br><br> +<span class="detail">description</span>: Per-version hint test package<br><br> <span class="detail">categories</span>: Base<br><br> <span class="detail">depends</span>: <a href="base-cygwin.html">base-cygwin</a><br><br> <span class="detail">binaries</span>: <a href="per-version.html">per-version</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/perl-Net-SMTP-SSL.html b/test/testdata/htdocs.expected/summary/perl-Net-SMTP-SSL.html index 8270b36..700037e 100644 --- a/test/testdata/htdocs.expected/summary/perl-Net-SMTP-SSL.html +++ b/test/testdata/htdocs.expected/summary/perl-Net-SMTP-SSL.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: perl-Net-SMTP-SSL</h1> -<span class="detail">sdesc</span>: Perl distribution Net-SMTP-SSL<br><br> -<span class="detail">ldesc</span>: Implements the same API as Net::SMTP, but uses IO::Socket::SSL for +<span class="detail">summary</span>: Perl distribution Net-SMTP-SSL<br><br> +<span class="detail">description</span>: Implements the same API as Net::SMTP, but uses IO::Socket::SSL for its network operations in order to support encrypted connections.<br><br> <span class="detail">categories</span>: Perl<br><br> <span class="detail">binaries</span>: <a href="perl-Net-SMTP-SSL.html">perl-Net-SMTP-SSL</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/rpm-doc.html b/test/testdata/htdocs.expected/summary/rpm-doc.html index a20b3d0..d7c844f 100644 --- a/test/testdata/htdocs.expected/summary/rpm-doc.html +++ b/test/testdata/htdocs.expected/summary/rpm-doc.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: rpm-doc</h1> -<span class="detail">sdesc</span>: Obsolete package for RPM package management system manual pages (extra text to so repr is not one line)<br><br> -<span class="detail">ldesc</span>: rpm-doc<br><br> +<span class="detail">summary</span>: Obsolete package for RPM package management system manual pages (extra text to so repr is not one line)<br><br> +<span class="detail">description</span>: rpm-doc<br><br> <span class="detail">categories</span>: _obsolete<br><br> <span class="detail">binaries</span>: <a href="rpm-doc.html">rpm-doc</a><br><br> <span class="detail">maintainer(s)</span>: diff --git a/test/testdata/htdocs.expected/summary/staleversion.html b/test/testdata/htdocs.expected/summary/staleversion.html index 5f336ff..a283f53 100644 --- a/test/testdata/htdocs.expected/summary/staleversion.html +++ b/test/testdata/htdocs.expected/summary/staleversion.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: staleversion</h1> -<span class="detail">sdesc</span>: Test package for stale version removal<br><br> -<span class="detail">ldesc</span>: Test package for stale version removal<br><br> +<span class="detail">summary</span>: Test package for stale version removal<br><br> +<span class="detail">description</span>: Test package for stale version removal<br><br> <span class="detail">categories</span>: Shells Base<br><br> <span class="detail">binaries</span>: <a href="staleversion.html">staleversion</a><br><br> <span class="detail">maintainer(s)</span>: Blooey McFooey diff --git a/test/testdata/htdocs.expected/summary/test-c.html b/test/testdata/htdocs.expected/summary/test-c.html index 18fe254..c506b97 100644 --- a/test/testdata/htdocs.expected/summary/test-c.html +++ b/test/testdata/htdocs.expected/summary/test-c.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: test-c</h1> -<span class="detail">sdesc</span>: test package C<br><br> -<span class="detail">ldesc</span>: test-c<br><br> +<span class="detail">summary</span>: test package C<br><br> +<span class="detail">description</span>: test-c<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">depends</span>: test-d (>= 1.0), <a href="test-e.html">test-e</a><br><br> <span class="detail">obsoletes</span>: <a href="obs-a.html">obs-a</a>, <a href="obs-b.html">obs-b</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/test-d.html b/test/testdata/htdocs.expected/summary/test-d.html index 0c6a0e0..fc139bf 100644 --- a/test/testdata/htdocs.expected/summary/test-d.html +++ b/test/testdata/htdocs.expected/summary/test-d.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: test-d</h1> -<span class="detail">sdesc</span>: test package D<br><br> -<span class="detail">ldesc</span>: test-d<br><br> +<span class="detail">summary</span>: test package D<br><br> +<span class="detail">description</span>: test-d<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">binaries</span>: <a href="test-d.html">test-d</a><br><br> <span class="detail">maintainer(s)</span>: ORPHANED diff --git a/test/testdata/htdocs.expected/summary/test-e.html b/test/testdata/htdocs.expected/summary/test-e.html index e7a30fc..b97a9ba 100644 --- a/test/testdata/htdocs.expected/summary/test-e.html +++ b/test/testdata/htdocs.expected/summary/test-e.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: test-e</h1> -<span class="detail">sdesc</span>: test package E<br><br> -<span class="detail">ldesc</span>: test-e<br><br> +<span class="detail">summary</span>: test package E<br><br> +<span class="detail">description</span>: test-e<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">build-depends</span>: libtextcat-devel<br><br> <span class="detail">binaries</span>: <a href="test-e.html">test-e</a><br><br> diff --git a/test/testdata/htdocs.expected/summary/testpackage.html b/test/testdata/htdocs.expected/summary/testpackage.html index acc6098..ca5706e 100644 --- a/test/testdata/htdocs.expected/summary/testpackage.html +++ b/test/testdata/htdocs.expected/summary/testpackage.html @@ -10,8 +10,8 @@ <div id="main"> <!--#include virtual="/top.html" --> <h1>Package: testpackage</h1> -<span class="detail">sdesc</span>: A test package (stuff & other stuff)<br><br> -<span class="detail">ldesc</span>: A test package (stuff & other stuff)<br><br> +<span class="detail">summary</span>: A test package (stuff & other stuff)<br><br> +<span class="detail">description</span>: A test package (stuff & other stuff)<br><br> <span class="detail">categories</span>: Devel<br><br> <span class="detail">binaries</span>: <a href="testpackage.html">testpackage</a><br><br> <span class="detail">maintainer(s)</span>: Blooey McFooey |