App-DocKnot

 view release on metacpan or  search on metacpan

t/data/generate/c-tap-harness/docknot.yaml  view on Meta::CPAN

        and add it to `EXTRA_DIST`.  Shell programs should start with:

        ```sh
            . "${C_TAP_SOURCE}/tap/libtap.sh"
        ```

        and can then use the functions defined in the library.

      * Optionally copy `docs/writing-tests` into your package somewhere,
        such as `tests/README`, as instructions to contributors on how to
        write tests for this framework.

      If you have configuration files that the user must create to enable
      some of the tests, conventionally they go into `tests/config`.

      If you have data files that your test cases use, conventionally they
      go into `tests/data`.  You can then find the data directory relative
      to the `C_TAP_SOURCE` environment variable (set by `runtests`) in
      your test program.  If you have data that's compiled or generated by
      Autoconf, it will be relative to the `BUILD` environment variable.
      Don't forget to add test data to `EXTRA_DIST` as necessary.

t/data/generate/c-tap-harness/output/readme  view on Meta::CPAN

  * If you have test programs written in shell, copy tests/tap/libtap.sh
    the tap subdirectory of your tests directory and add it to EXTRA_DIST.
    Shell programs should start with:

        . "${C_TAP_SOURCE}/tap/libtap.sh"

    and can then use the functions defined in the library.

  * Optionally copy docs/writing-tests into your package somewhere, such
    as tests/README, as instructions to contributors on how to write tests
    for this framework.

  If you have configuration files that the user must create to enable some
  of the tests, conventionally they go into tests/config.

  If you have data files that your test cases use, conventionally they go
  into tests/data.  You can then find the data directory relative to the
  C_TAP_SOURCE environment variable (set by runtests) in your test
  program.  If you have data that's compiled or generated by Autoconf, it
  will be relative to the BUILD environment variable.  Don't forget to add
  test data to EXTRA_DIST as necessary.

t/data/generate/c-tap-harness/output/readme-md  view on Meta::CPAN

  Shell programs should start with:

  ```sh
      . "${C_TAP_SOURCE}/tap/libtap.sh"
  ```

  and can then use the functions defined in the library.

* Optionally copy `docs/writing-tests` into your package somewhere, such
  as `tests/README`, as instructions to contributors on how to write tests
  for this framework.

If you have configuration files that the user must create to enable some
of the tests, conventionally they go into `tests/config`.

If you have data files that your test cases use, conventionally they go
into `tests/data`.  You can then find the data directory relative to the
`C_TAP_SOURCE` environment variable (set by `runtests`) in your test
program.  If you have data that's compiled or generated by Autoconf, it
will be relative to the `BUILD` environment variable.  Don't forget to add
test data to `EXTRA_DIST` as necessary.

t/data/generate/rra-c-util/docknot.yaml  view on Meta::CPAN

  missing functions, and Autoconf macros.

  The goal of this package is to merge all the various versions of any
  portability or utility code that's used in more than one of my packages in
  one place.  Then, each package can update to the latest rra-c-util version
  before each release and gain from the improvements made for all other
  packages.  You can think of it as my version of
  [Gnulib](https://www.gnu.org/software/gnulib/), with everything released
  under a permissive license (no GPL).

  As well as C portability frameworks, Autoconf macros, and a general C
  utility library, this package has also accumulated a considerable
  collection of standard tests (for C and Perl packages) and a large library
  of test utilities and support functions.  It also includes extensive
  support for writing and testing PAM modules, and a portable implementation
  of AFS PAGs.

  This package uses the infrastructure of C TAP Harness for testing, but is
  not the canonical version of `tests/runtests.c`, `tests/tap/basic.[ch]`,
  `tests/tap/macros.h`, or `tests/tap/libtap.sh`.  Those files should be
  pulled from [C TAP

t/data/generate/rra-c-util/output/readme  view on Meta::CPAN

  The goal of this package is to merge all the various versions of any
  portability or utility code that's used in more than one of my packages
  in one place.  Then, each package can update to the latest rra-c-util
  version before each release and gain from the improvements made for all
  other packages.  You can think of it as my version of Gnulib [1], with
  everything released under a permissive license (no GPL).

  [1] https://www.gnu.org/software/gnulib/

  As well as C portability frameworks, Autoconf macros, and a general C
  utility library, this package has also accumulated a considerable
  collection of standard tests (for C and Perl packages) and a large
  library of test utilities and support functions.  It also includes
  extensive support for writing and testing PAM modules, and a portable
  implementation of AFS PAGs.

  This package uses the infrastructure of C TAP Harness for testing, but
  is not the canonical version of tests/runtests.c, tests/tap/basic.[ch],
  tests/tap/macros.h, or tests/tap/libtap.sh.  Those files should be
  pulled from C TAP Harness [2] instead.

t/data/generate/rra-c-util/output/readme-md  view on Meta::CPAN

missing functions, and Autoconf macros.

The goal of this package is to merge all the various versions of any
portability or utility code that's used in more than one of my packages in
one place.  Then, each package can update to the latest rra-c-util version
before each release and gain from the improvements made for all other
packages.  You can think of it as my version of
[Gnulib](https://www.gnu.org/software/gnulib/), with everything released
under a permissive license (no GPL).

As well as C portability frameworks, Autoconf macros, and a general C
utility library, this package has also accumulated a considerable
collection of standard tests (for C and Perl packages) and a large library
of test utilities and support functions.  It also includes extensive
support for writing and testing PAM modules, and a portable implementation
of AFS PAGs.

This package uses the infrastructure of C TAP Harness for testing, but is
not the canonical version of `tests/runtests.c`, `tests/tap/basic.[ch]`,
`tests/tap/macros.h`, or `tests/tap/libtap.sh`.  Those files should be
pulled from [C TAP

t/data/generate/rra-c-util/output/thread  view on Meta::CPAN

missing functions, and Autoconf macros.

The goal of this package is to merge all the various versions of any
portability or utility code that's used in more than one of my packages in
one place.  Then, each package can update to the latest rra-c-util version
before each release and gain from the improvements made for all other
packages.  You can think of it as my version of
\link[https://www.gnu.org/software/gnulib/][Gnulib], with everything
released under a permissive license (no GPL).

As well as C portability frameworks, Autoconf macros, and a general C
utility library, this package has also accumulated a considerable
collection of standard tests (for C and Perl packages) and a large library
of test utilities and support functions.  It also includes extensive
support for writing and testing PAM modules, and a portable implementation
of AFS PAGs.

This package uses the infrastructure of C TAP Harness for testing, but is
not the canonical version of \code[tests/runtests.c],
\code[tests/tap/basic.[ch]], \code[tests/tap/macros.h], or
\code[tests/tap/libtap.sh].  Those files should be pulled from

t/data/spin/input/software/docknot/index.th  view on Meta::CPAN

rather specific to my preferences about how to write package
documentation, and the web page output is in my personal thread language
as opposed to HTML.  I'm not sure if I'll have the time to make it a more
general tool.  But you're certainly welcome to use it if you find it
useful, send pull requests to make it more general, or take ideas from it
for your own purposes.

Currently included in this package are just the App::DocKnot module and
its submodules, a small docknot driver program, and the templates I use
for my own software.  Over time, it may include more of my web publishing
framework, time permitting.

\h2[Requirements]

Perl 5.24 or later and Module::Build are required to build this module.
The following additional Perl modules are required to use it:

\bullet(packed)[File::BaseDir]
\bullet(packed)[File::ShareDir]
\bullet(packed)[IO::Compress::Xz (part of IO-Compress-Lzma)]
\bullet(packed)[IO::Uncompress::Gunzip (part of IO-Compress)]

t/data/spin/output/software/docknot/index.html  view on Meta::CPAN

as opposed to HTML.  I'm not sure if I'll have the time to make it a more
general tool.  But you're certainly welcome to use it if you find it
useful, send pull requests to make it more general, or take ideas from it
for your own purposes.
</p>

<p>
Currently included in this package are just the App::DocKnot module and
its submodules, a small docknot driver program, and the templates I use
for my own software.  Over time, it may include more of my web publishing
framework, time permitting.
</p>

<h2>Requirements</h2>

<p>
Perl 5.24 or later and Module::Build are required to build this module.
The following additional Perl modules are required to use it:
</p>

<ul>

t/data/update/c-tap-harness/docknot.yaml  view on Meta::CPAN

      Shell programs should start with:

      ```sh
          . "${C_TAP_SOURCE}/tap/libtap.sh"
      ```

      and can then use the functions defined in the library.

    * Optionally copy `docs/writing-tests` into your package somewhere, such
      as `tests/README`, as instructions to contributors on how to write tests
      for this framework.

    If you have configuration files that the user must create to enable some
    of the tests, conventionally they go into `tests/config`.

    If you have data files that your test cases use, conventionally they go
    into `tests/data`.  You can then find the data directory relative to the
    `C_TAP_SOURCE` environment variable (set by `runtests`) in your test
    program.  If you have data that's compiled or generated by Autoconf, it
    will be relative to the `BUILD` environment variable.  Don't forget to add
    test data to `EXTRA_DIST` as necessary.

t/data/update/c-tap-harness/old/sections/using-the-harness  view on Meta::CPAN

  Shell programs should start with:

  ```sh
      . "${C_TAP_SOURCE}/tap/libtap.sh"
  ```

  and can then use the functions defined in the library.

* Optionally copy `docs/writing-tests` into your package somewhere, such
  as `tests/README`, as instructions to contributors on how to write tests
  for this framework.

If you have configuration files that the user must create to enable some
of the tests, conventionally they go into `tests/config`.

If you have data files that your test cases use, conventionally they go
into `tests/data`.  You can then find the data directory relative to the
`C_TAP_SOURCE` environment variable (set by `runtests`) in your test
program.  If you have data that's compiled or generated by Autoconf, it
will be relative to the `BUILD` environment variable.  Don't forget to add
test data to `EXTRA_DIST` as necessary.

t/data/update/rra-c-util/docknot.yaml  view on Meta::CPAN

  missing functions, and Autoconf macros.

  The goal of this package is to merge all the various versions of any
  portability or utility code that's used in more than one of my packages in
  one place.  Then, each package can update to the latest rra-c-util version
  before each release and gain from the improvements made for all other
  packages.  You can think of it as my version of
  [Gnulib](https://www.gnu.org/software/gnulib/), with everything released
  under a permissive license (no GPL).

  As well as C portability frameworks, Autoconf macros, and a general C
  utility library, this package has also accumulated a considerable
  collection of standard tests (for C and Perl packages) and a large library
  of test utilities and support functions.  It also includes extensive
  support for writing and testing PAM modules, and a portable implementation
  of AFS PAGs.

  This package uses the infrastructure of C TAP Harness for testing, but is
  not the canonical version of `tests/runtests.c`, `tests/tap/basic.[ch]`,
  `tests/tap/macros.h`, or `tests/tap/libtap.sh`.  Those files should be
  pulled from [C TAP

t/data/update/rra-c-util/old/description  view on Meta::CPAN

missing functions, and Autoconf macros.

The goal of this package is to merge all the various versions of any
portability or utility code that's used in more than one of my packages in
one place.  Then, each package can update to the latest rra-c-util version
before each release and gain from the improvements made for all other
packages.  You can think of it as my version of
[Gnulib](https://www.gnu.org/software/gnulib/), with everything released
under a permissive license (no GPL).

As well as C portability frameworks, Autoconf macros, and a general C
utility library, this package has also accumulated a considerable
collection of standard tests (for C and Perl packages) and a large library
of test utilities and support functions.  It also includes extensive
support for writing and testing PAM modules, and a portable implementation
of AFS PAGs.

This package uses the infrastructure of C TAP Harness for testing, but is
not the canonical version of `tests/runtests.c`, `tests/tap/basic.[ch]`,
`tests/tap/macros.h`, or `tests/tap/libtap.sh`.  Those files should be
pulled from [C TAP