summaryrefslogtreecommitdiff
path: root/t
diff options
context:
space:
mode:
authorRuss Allbery <rra@cpan.org>2021-03-27 22:10:48 -0700
committerRuss Allbery <rra@cpan.org>2021-03-27 22:10:48 -0700
commitb0f301ad29f43370c885e9c968152936c8d2d6e3 (patch)
treeca62f26804d31388f41008ee6dd2c14738fa4c01 /t
parent43855e0c9ec9c2d45b7706782dc87a562f646011 (diff)
Support setting debian.package with debian.personal
Support setting distribution.packaging.debian.package along with distribution.packaging.debian.personal to specify the package name. Do not generate links to Debian in that case.
Diffstat (limited to 't')
-rw-r--r--t/data/generate/pod-thread/docknot.yaml89
-rw-r--r--t/data/generate/pod-thread/output/readme161
-rw-r--r--t/data/generate/pod-thread/output/readme-md160
-rw-r--r--t/data/generate/pod-thread/output/thread172
4 files changed, 582 insertions, 0 deletions
diff --git a/t/data/generate/pod-thread/docknot.yaml b/t/data/generate/pod-thread/docknot.yaml
new file mode 100644
index 0000000..f6e0dc0
--- /dev/null
+++ b/t/data/generate/pod-thread/docknot.yaml
@@ -0,0 +1,89 @@
+format: v1
+
+name: Pod::Thread
+maintainer: Russ Allbery <rra@cpan.org>
+version: '2.00'
+synopsis: Format POD source into thread, an HTML macro language
+
+license:
+ name: Expat
+copyrights:
+ - holder: Russ Allbery <rra@cpan.org>
+ years: 2002, 2008-2009, 2013, 2021
+
+build:
+ type: Module::Build
+distribution:
+ cpan: Pod-Thread
+ packaging:
+ debian:
+ package: libpod-thread-perl
+ personal: true
+ section: web
+ tarname: Pod-Thread
+ version: pod-thread
+support:
+ email: rra@cpan.org
+ github: rra/pod-thread
+ web: https://www.eyrie.org/~eagle/software/pod-thread/
+vcs:
+ browse: https://git.eyrie.org/?p=web/pod-thread.git
+ github: rra/pod-thread
+ status:
+ workflow: build
+ type: Git
+ url: https://git.eyrie.org/web/pod-thread.git
+
+docs:
+ api:
+ - name: pod-thread
+ title: Pod::Thread
+ user:
+ - name: pod2thread
+ title: pod2thread manual page
+
+blurb: |
+ Pod::Thread translates POD source into thread, a macro language processed by
+ spin. It supports optionally adding a table of contents and a navigation
+ bar to the genenerated file. This package also includes the pod2thread
+ driver script, invoked automatically by spin for POD files and pointers to
+ POD files.
+
+description: |
+ This package contains a module to translate POD into thread, an HTML macro
+ language. As such, it's not very useful without
+ [spin](https://www.eyrie.org/~eagle/software/web/), a separate program to
+ convert thread into HTML. I wrote this module for my personal needs and it
+ may not be (and in fact probably isn't) suitable for more general use as
+ yet.
+
+ The eventual intention is to incorporate spin into
+ [DocKnot](https://www.eyrie.org/~eagle/software/docknot/), at which point
+ this module will provide the POD support for DocKnot as a static site
+ generator. I have no estimate for when that work will be done.
+
+ The conversion done by this module is mostly straightforward. The only
+ notable parts are the optional generation of a table of contents or a
+ navigation bar at the top of the generated file.
+
+requirements: |
+ Perl 5.24 or later and Pod::Parser 3.06 or later. As mentioned above, it's
+ also not particularly useful without spin.
+
+test:
+ lancaster: true
+ suffix: |
+ Perl6::Slurp is required by the test suite. The following additional Perl
+ modules will be used by the test suite if present:
+
+ * Devel::Cover
+ * Perl::Critic::Freenode
+ * Test::MinimumVersion
+ * Test::Perl::Critic
+ * Test::Pod
+ * Test::Spelling
+ * Test::Strict
+ * Test::Synopsis
+
+ All are available on CPAN. Those tests will be skipped if the modules
+ are not available.
diff --git a/t/data/generate/pod-thread/output/readme b/t/data/generate/pod-thread/output/readme
new file mode 100644
index 0000000..a87fe46
--- /dev/null
+++ b/t/data/generate/pod-thread/output/readme
@@ -0,0 +1,161 @@
+ Pod::Thread 2.00
+ (Format POD source into thread, an HTML macro language)
+ Maintained by Russ Allbery <rra@cpan.org>
+
+ Copyright 2002, 2008-2009, 2013, 2021 Russ Allbery <rra@cpan.org>. This
+ software is distributed under a BSD-style license. Please see the
+ section LICENSE below for more information.
+
+BLURB
+
+ Pod::Thread translates POD source into thread, a macro language
+ processed by spin. It supports optionally adding a table of contents
+ and a navigation bar to the genenerated file. This package also
+ includes the pod2thread driver script, invoked automatically by spin for
+ POD files and pointers to POD files.
+
+DESCRIPTION
+
+ This package contains a module to translate POD into thread, an HTML
+ macro language. As such, it's not very useful without spin [1], a
+ separate program to convert thread into HTML. I wrote this module for
+ my personal needs and it may not be (and in fact probably isn't)
+ suitable for more general use as yet.
+
+ [1] https://www.eyrie.org/~eagle/software/web/
+
+ The eventual intention is to incorporate spin into DocKnot [2], at which
+ point this module will provide the POD support for DocKnot as a static
+ site generator. I have no estimate for when that work will be done.
+
+ [2] https://www.eyrie.org/~eagle/software/docknot/
+
+ The conversion done by this module is mostly straightforward. The only
+ notable parts are the optional generation of a table of contents or a
+ navigation bar at the top of the generated file.
+
+REQUIREMENTS
+
+ Perl 5.24 or later and Pod::Parser 3.06 or later. As mentioned above,
+ it's also not particularly useful without spin.
+
+BUILDING AND INSTALLATION
+
+ Pod::Thread uses Module::Build and can be installed using the same
+ process as any other Module::Build module:
+
+ perl Build.PL
+ ./Build
+ ./Build install
+
+ You will have to run the last command as root unless you're installing
+ into a local Perl module tree in your home directory.
+
+TESTING
+
+ Pod::Thread comes with a test suite, which you can run after building
+ with:
+
+ ./Build test
+
+ If a test fails, you can run a single test with verbose output via:
+
+ ./Build test --test_files <path-to-test>
+
+ Perl6::Slurp is required by the test suite. The following additional
+ Perl modules will be used by the test suite if present:
+
+ * Devel::Cover
+ * Perl::Critic::Freenode
+ * Test::MinimumVersion
+ * Test::Perl::Critic
+ * Test::Pod
+ * Test::Spelling
+ * Test::Strict
+ * Test::Synopsis
+
+ All are available on CPAN. Those tests will be skipped if the modules
+ are not available.
+
+ To enable tests that don't detect functionality problems but are used to
+ sanity-check the release, set the environment variable RELEASE_TESTING
+ to a true value. To enable tests that may be sensitive to the local
+ environment or that produce a lot of false positives without uncovering
+ many problems, set the environment variable AUTHOR_TESTING to a true
+ value.
+
+SUPPORT
+
+ The Pod::Thread web page at:
+
+ https://www.eyrie.org/~eagle/software/pod-thread/
+
+ will always have the current version of this package, the current
+ documentation, and pointers to any additional resources.
+
+ For bug tracking, use the issue tracker on GitHub:
+
+ https://github.com/rra/pod-thread/issues
+
+ However, please be aware that I tend to be extremely busy and work
+ projects often take priority. I'll save your report and get to it as
+ soon as I can, but it may take me a couple of months.
+
+SOURCE REPOSITORY
+
+ Pod::Thread is maintained using Git. You can access the current source
+ on GitHub at:
+
+ https://github.com/rra/pod-thread
+
+ or by cloning the repository at:
+
+ https://git.eyrie.org/web/pod-thread.git
+
+ or view the repository via the web at:
+
+ https://git.eyrie.org/?p=web/pod-thread.git
+
+ The eyrie.org repository is the canonical one, maintained by the author,
+ but using GitHub is probably more convenient for most purposes. Pull
+ requests are gratefully reviewed and normally accepted.
+
+LICENSE
+
+ The Pod::Thread package as a whole is covered by the following copyright
+ statement and license:
+
+ Copyright 2002, 2008-2009, 2013, 2021 Russ Allbery <rra@cpan.org>
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ "Software"), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ Some files in this distribution are individually released under
+ different licenses, all of which are compatible with the above general
+ package license but which may require preservation of additional
+ notices. All required notices, and detailed information about the
+ licensing of each file, are recorded in the LICENSE file.
+
+ Files covered by a license with an assigned SPDX License Identifier
+ include SPDX-License-Identifier tags to enable automated processing of
+ license information. See https://spdx.org/licenses/ for more
+ information.
+
+ For any copyright range specified by files in this package as YYYY-ZZZZ,
+ the range specifies every single year in that closed interval.
diff --git a/t/data/generate/pod-thread/output/readme-md b/t/data/generate/pod-thread/output/readme-md
new file mode 100644
index 0000000..911117b
--- /dev/null
+++ b/t/data/generate/pod-thread/output/readme-md
@@ -0,0 +1,160 @@
+# Pod::Thread
+
+[![Build
+status](https://github.com/rra/pod-thread/workflows/build/badge.svg)](https://github.com/rra/pod-thread/actions)
+[![CPAN
+version](https://img.shields.io/cpan/v/Pod-Thread)](https://metacpan.org/release/Pod-Thread)
+[![License](https://img.shields.io/cpan/l/Pod-Thread)](https://github.com/rra/pod-thread/blob/master/LICENSE)
+
+Copyright 2002, 2008-2009, 2013, 2021 Russ Allbery <rra@cpan.org>. This
+software is distributed under a BSD-style license. Please see the section
+[License](#license) below for more information.
+
+## Blurb
+
+Pod::Thread translates POD source into thread, a macro language processed
+by spin. It supports optionally adding a table of contents and a
+navigation bar to the genenerated file. This package also includes the
+pod2thread driver script, invoked automatically by spin for POD files and
+pointers to POD files.
+
+## Description
+
+This package contains a module to translate POD into thread, an HTML macro
+language. As such, it's not very useful without
+[spin](https://www.eyrie.org/~eagle/software/web/), a separate program to
+convert thread into HTML. I wrote this module for my personal needs and
+it may not be (and in fact probably isn't) suitable for more general use
+as yet.
+
+The eventual intention is to incorporate spin into
+[DocKnot](https://www.eyrie.org/~eagle/software/docknot/), at which point
+this module will provide the POD support for DocKnot as a static site
+generator. I have no estimate for when that work will be done.
+
+The conversion done by this module is mostly straightforward. The only
+notable parts are the optional generation of a table of contents or a
+navigation bar at the top of the generated file.
+
+## Requirements
+
+Perl 5.24 or later and Pod::Parser 3.06 or later. As mentioned above,
+it's also not particularly useful without spin.
+
+## Building and Installation
+
+Pod::Thread uses Module::Build and can be installed using the same process
+as any other Module::Build module:
+
+```
+ perl Build.PL
+ ./Build
+ ./Build install
+```
+
+You will have to run the last command as root unless you're installing
+into a local Perl module tree in your home directory.
+
+## Testing
+
+Pod::Thread comes with a test suite, which you can run after building
+with:
+
+```
+ ./Build test
+```
+
+If a test fails, you can run a single test with verbose output via:
+
+```
+ ./Build test --test_files <path-to-test>
+```
+
+Perl6::Slurp is required by the test suite. The following additional Perl
+modules will be used by the test suite if present:
+
+* Devel::Cover
+* Perl::Critic::Freenode
+* Test::MinimumVersion
+* Test::Perl::Critic
+* Test::Pod
+* Test::Spelling
+* Test::Strict
+* Test::Synopsis
+
+All are available on CPAN. Those tests will be skipped if the modules are
+not available.
+
+To enable tests that don't detect functionality problems but are used to
+sanity-check the release, set the environment variable `RELEASE_TESTING`
+to a true value. To enable tests that may be sensitive to the local
+environment or that produce a lot of false positives without uncovering
+many problems, set the environment variable `AUTHOR_TESTING` to a true
+value.
+
+## Support
+
+The [Pod::Thread web
+page](https://www.eyrie.org/~eagle/software/pod-thread/) will always have
+the current version of this package, the current documentation, and
+pointers to any additional resources.
+
+For bug tracking, use the [issue tracker on
+GitHub](https://github.com/rra/pod-thread/issues). However, please be
+aware that I tend to be extremely busy and work projects often take
+priority. I'll save your report and get to it as soon as I can, but it
+may take me a couple of months.
+
+## Source Repository
+
+Pod::Thread is maintained using Git. You can access the current source on
+[GitHub](https://github.com/rra/pod-thread) or by cloning the repository
+at:
+
+https://git.eyrie.org/web/pod-thread.git
+
+or [view the repository on the
+web](https://git.eyrie.org/?p=web/pod-thread.git).
+
+The eyrie.org repository is the canonical one, maintained by the author,
+but using GitHub is probably more convenient for most purposes. Pull
+requests are gratefully reviewed and normally accepted.
+
+## License
+
+The Pod::Thread package as a whole is covered by the following copyright
+statement and license:
+
+> Copyright 2002, 2008-2009, 2013, 2021
+> Russ Allbery <rra@cpan.org>
+>
+> Permission is hereby granted, free of charge, to any person obtaining a
+> copy of this software and associated documentation files (the "Software"),
+> to deal in the Software without restriction, including without limitation
+> the rights to use, copy, modify, merge, publish, distribute, sublicense,
+> and/or sell copies of the Software, and to permit persons to whom the
+> Software is furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+> THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+> DEALINGS IN THE SOFTWARE.
+
+Some files in this distribution are individually released under different
+licenses, all of which are compatible with the above general package
+license but which may require preservation of additional notices. All
+required notices, and detailed information about the licensing of each
+file, are recorded in the LICENSE file.
+
+Files covered by a license with an assigned SPDX License Identifier
+include SPDX-License-Identifier tags to enable automated processing of
+license information. See https://spdx.org/licenses/ for more information.
+
+For any copyright range specified by files in this package as YYYY-ZZZZ,
+the range specifies every single year in that closed interval.
diff --git a/t/data/generate/pod-thread/output/thread b/t/data/generate/pod-thread/output/thread
new file mode 100644
index 0000000..c5567b9
--- /dev/null
+++ b/t/data/generate/pod-thread/output/thread
@@ -0,0 +1,172 @@
+\==[doc] [2] [\bullet(packed)[\link[\1][\2]]]
+\==[program] [3]
+ [\tablerow[\1 \version[\2]] [\release[\2]]
+ [\link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
+ (\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
+ [PGP signature])]
+ [\link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
+ (\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
+ [PGP signature])]]
+\==[download] [3]
+ [\1 \version[\2]\break
+ \link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
+ (\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
+ [signature])\break
+ \link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
+ (\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
+ [signature])\break
+ Released \release[\2]]
+
+\heading[Pod::Thread][software]
+
+\h1[Pod::Thread]
+
+\div(sidebar)[
+ \h2[Download]
+
+ \download[Pod::Thread][pod-thread]
+ [web/Pod-Thread-\version[pod-thread]]
+
+ \link[https://archives.eyrie.org/software/ARCHIVE/Pod-Thread/]
+ [Archive]
+
+ \h2[Documentation]
+
+ \link[readme.html][General overview] \break
+ \link[news.html][Change summary] \break
+ \link[pod2thread.html][pod2thread manual page]
+
+ \h2[Development]
+
+ \link[todo.html][To-do list] \break
+ \link[https://github.com/rra/pod-thread]
+ [GitHub] \break
+ \link[https://github.com/rra/pod-thread/issues]
+ [Bug tracker] \break
+ \link[https://git.eyrie.org/?p=web/pod-thread.git]
+ [Git repository] \break
+ \link[https://metacpan.org/release/Pod-Thread]
+ [MetaCPAN]
+]
+
+\h2[Blurb]
+
+Pod::Thread translates POD source into thread, a macro language processed
+by spin. It supports optionally adding a table of contents and a
+navigation bar to the genenerated file. This package also includes the
+pod2thread driver script, invoked automatically by spin for POD files and
+pointers to POD files.
+
+\h2[Description]
+
+This package contains a module to translate POD into thread, an HTML macro
+language. As such, it's not very useful without
+\link[https://www.eyrie.org/~eagle/software/web/][spin], a separate
+program to convert thread into HTML. I wrote this module for my personal
+needs and it may not be (and in fact probably isn't) suitable for more
+general use as yet.
+
+The eventual intention is to incorporate spin into
+\link[https://www.eyrie.org/~eagle/software/docknot/][DocKnot], at which
+point this module will provide the POD support for DocKnot as a static
+site generator. I have no estimate for when that work will be done.
+
+The conversion done by this module is mostly straightforward. The only
+notable parts are the optional generation of a table of contents or a
+navigation bar at the top of the generated file.
+
+\h2[Requirements]
+
+Perl 5.24 or later and Pod::Parser 3.06 or later. As mentioned above,
+it's also not particularly useful without spin.
+
+\h2[Download]
+
+The distribution:
+
+\table[][
+ \program[Pod::Thread][pod-thread]
+ [web/Pod-Thread-\version[pod-thread]]
+]
+
+An \link[https://archives.eyrie.org/software/ARCHIVE/Pod-Thread/] [archive
+of older releases] is also available.
+
+A Debian package (libpod-thread-perl) is available from my
+\link[../debian.html][personal repository].
+
+Pod::Thread is available from CPAN as the
+\link[https://metacpan.org/release/Pod-Thread] [Pod-Thread distribution].
+
+Pod::Thread is maintained using the Git version control system. To check
+out the current development tree, see
+\link[https://github.com/rra/pod-thread][GitHub] or clone:
+
+\pre[ https://git.eyrie.org/web/pod-thread.git]
+
+Pull requests on GitHub are welcome. You can also
+\link[https://git.eyrie.org/?p=web/pod-thread.git][browse the current
+development source].
+
+\h2[Documentation]
+
+\div(left)[
+ \class(first)[User documentation:]
+
+ \doc[readme.html][README]
+ \doc[news.html][Change summary]
+ \doc[pod2thread.html][pod2thread manual page]
+ \doc[license.html][License and copyright]
+
+ Developer documentation:
+
+ \doc[todo.html][To-do list]
+ \doc[https://github.com/rra/pod-thread]
+ [GitHub]
+ \doc[https://github.com/rra/pod-thread/issues]
+ [Bug tracker]
+
+]
+
+\div(right)[
+ \class(first)[API documentation:]
+
+ \doc[pod-thread.html][Pod::Thread]
+]
+
+\h2(after)[License]
+
+The Pod::Thread package as a whole is covered by the following copyright
+and license:
+
+\block[
+
+ Copyright 2002, 2008-2009, 2013, 2021
+ Russ Allbery <rra@cpan.org>
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ "Software"), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+]
+
+Some individual source files are covered by other, compatible licenses.
+For complete copyright and license information, see the file
+\link[license.html][LICENSE] in the Pod::Thread source distribution.
+
+\signature