diff options
Diffstat (limited to 't/data')
| -rw-r--r-- | t/data/perltidyrc | 3 | ||||
| -rw-r--r-- | t/data/spin/input/.sitemap | 2 | ||||
| -rw-r--r-- | t/data/spin/input/software/docknot/api/app-docknot.rpod | 1 | ||||
| -rw-r--r-- | t/data/spin/output/software/docknot/api/app-docknot.html | 147 |
4 files changed, 153 insertions, 0 deletions
diff --git a/t/data/perltidyrc b/t/data/perltidyrc index c2d0e40..f5a08b5 100644 --- a/t/data/perltidyrc +++ b/t/data/perltidyrc @@ -6,6 +6,7 @@ # which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>. # # Written by Russ Allbery <eagle@eyrie.org> +# Copyright 2021 Russ Allbery <eagle@eyrie.org> # Copyright 2012-2013 # The Board of Trustees of the Leland Stanford Junior University # @@ -17,9 +18,11 @@ # SPDX-License-Identifier: FSFAP -bbao # put line breaks before any operator +-boc # do not re-break lists, since perltidy is awful at this -nbbc # don't force blank lines before comments (bad for else blocks) -ce # cuddle braces around else -l=79 # usually use 78, but don't want 79-long lines reformatted -pt=2 # don't add extra whitespace around parentheses -sbt=2 # ...or square brackets -sfs # no space before semicolon in for (not that I use this form) +-xci # improve indentation of nested structures diff --git a/t/data/spin/input/.sitemap b/t/data/spin/input/.sitemap index 881fc18..595191a 100644 --- a/t/data/spin/input/.sitemap +++ b/t/data/spin/input/.sitemap @@ -2,6 +2,8 @@ /software/: Software /software/cvslog/: cvslog /software/docknot/: DocKnot + /software/docknot/api/app-docknot.html: App::DocKnot + /software/docknot/api/app-docknot-command.html: App::DocKnot::Command /software/rra-c-util/: rra-c-util /faqs/: FAQs and Documentation /photos/: Photos diff --git a/t/data/spin/input/software/docknot/api/app-docknot.rpod b/t/data/spin/input/software/docknot/api/app-docknot.rpod new file mode 100644 index 0000000..5075ec0 --- /dev/null +++ b/t/data/spin/input/software/docknot/api/app-docknot.rpod @@ -0,0 +1 @@ +../../../../../../../lib/App/DocKnot.pm diff --git a/t/data/spin/output/software/docknot/api/app-docknot.html b/t/data/spin/output/software/docknot/api/app-docknot.html new file mode 100644 index 0000000..b3d5244 --- /dev/null +++ b/t/data/spin/output/software/docknot/api/app-docknot.html @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>App::DocKnot</title> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <link rel="stylesheet" href="/~eagle/styles/pod.css" type="text/css" /> + <link rel="next" href="app-docknot-command.html" + title="App::DocKnot::Command" /> + <link rel="up" href="../" title="DocKnot" /> + <link rel="top" href="../../../" /> +</head> + +<!-- Spun by spin %VERSION% on %DATE% --> + +<body> +<table class="navbar"><tr> + <td class="navleft"></td> + <td> + <a href="../../../">Russ Allbery</a> + > <a href="../../">Software</a> + > <a href="../">DocKnot</a> + </td> + <td class="navright"><a href="app-docknot-command.html">App::DocKnot::Command</a> ></td> +</tr></table> + + +<h1>App::DocKnot</h1> + +<p class="subhead">(Documentation and software release management)</p> + +<p class="navbar"> + <a href="#S1">Requirements</a> + | <a href="#S2">Description</a> + | <a href="#S3">Instance Methods</a> + | <a href="#S4">Author</a> +<br /> + <a href="#S5">Copyright and License</a> + | <a href="#S6">See Also</a> +</p> + +<h2 id="S1"><a name="S1">REQUIREMENTS</a></h2> + +<p> +Perl 5.24 or later and the modules File::BaseDir and File::ShareDir, both +of which are available from CPAN. +</p> + +<h2 id="S2"><a name="S2">DESCRIPTION</a></h2> + +<p> +DocKnot is a system for documentation and software release management. +Its functionality is provided by various submodules, often invoked via the +<b>docknot</b> command-line program. For more information, see +docknot(1). +</p> + +<p> +This module only provides helper functions to load configuration and +metadata that are used by its various submodules. +</p> + +<h2 id="S3"><a name="S3">INSTANCE METHODS</a></h2> + +<dl> +<dt>appdata_path(PATH[, ...])</dt> +<dd><p> +Return the path of a file from the application data. The file is +specified as one or more path components. +</p> + +<p> +These data files are installed with App::DocKnot, but each file can be +overridden by the user via files in <i class="file">$HOME/.config/docknot</i> +or <i class="file">/etc/xdg/docknot</i> (or whatever $XDG_CONFIG_HOME and +$XDG_CONFIG_DIRS are set to). Raises a text exception if the desired file +could not be located. +</p></dd> +</dl> + +<h2 id="S4"><a name="S4">AUTHOR</a></h2> + +<p> +Russ Allbery <rra@cpan.org> +</p> + +<h2 id="S5"><a name="S5">COPYRIGHT AND LICENSE</a></h2> + +<p> +Copyright 2013-2021 Russ Allbery <rra@cpan.org> +</p> + +<p> +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: +</p> + +<p> +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +</p> + +<p> +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. +</p> + +<h2 id="S6"><a name="S6">SEE ALSO</a></h2> + +<p> +docknot(1) +</p> + +<p> +This module is part of the App-DocKnot distribution. The current version +of DocKnot is available from CPAN, or directly from its web site at +<<a href="https://www.eyrie.org/~eagle/software/docknot/">https://www.eyrie.org/~eagle/software/docknot/</a>>. +</p> + +<table class="navbar"><tr> + <td class="navleft"></td> + <td> + <a href="../../../">Russ Allbery</a> + > <a href="../../">Software</a> + > <a href="../">DocKnot</a> + </td> + <td class="navright"><a href="app-docknot-command.html">App::DocKnot::Command</a> ></td> +</tr></table> + +<address> + Last <a href="https://www.eyrie.org/~eagle/software/web/">spun</a> + %DATE% from POD modified %DATE% +</address> +</body> +</html> |