From: Russ Allbery Date: Sat, 16 May 2020 23:43:16 +0000 (-0700) Subject: Update documentation metadata and regenerate X-Git-Tag: release/3.2~12 X-Git-Url: https://git.eyrie.org/?a=commitdiff_plain;h=53c91911f50dd3b1548d9ba0776945f55d013da4;hp=007d8644741b6ecbef2f3deadbb59c5e99ba8930;p=kerberos%2Fkrb5-strength.git Update documentation metadata and regenerate Pick up template changes from DocKnot 3.04. Adds badges for GitHub workflows and for the Debian package. --- diff --git a/README b/README index 8832acd..221eb86 100644 --- a/README +++ b/README @@ -2,11 +2,11 @@ (Kerberos password strength checking plugin) Maintained by Russ Allbery - Copyright 2016 Russ Allbery . Copyright 2006-2007, - 2009-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior - University. Copyright 1993 Alec Muffett. This software is distributed - under a BSD-style license. Please see the section LICENSE below for - more information. + Copyright 2016, 2020 Russ Allbery . Copyright + 2006-2007, 2009-2010, 2012-2014 The Board of Trustees of the Leland + Stanford Junior University. Copyright 1993 Alec Muffett. This software + is distributed under a BSD-style license. Please see the section + LICENSE below for more information. BLURB @@ -149,13 +149,6 @@ REQUIREMENTS All are available on CPAN. Some 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. - To bootstrap from a Git checkout, or if you change the Automake files and need to regenerate Makefile.in, you will need Automake 1.11 or later. For bootstrap or if you change configure.ac or any of the m4 @@ -235,7 +228,8 @@ BUILDING AND INSTALLATION Pass --enable-silent-rules to configure for a quieter build (similar to the Linux kernel). Use make warnings instead of make to build with full - GCC compiler warnings (requires a relatively current version of GCC). + compiler warnings (requires either GCC or Clang and may require a + relatively current version of the compiler). You can pass the --enable-reduced-depends flag to configure to try to minimize the shared library dependencies encoded in the binaries. This @@ -266,6 +260,13 @@ TESTING Do this instead of running the test program directly since it will ensure that necessary environment variables are set up. + 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 krb5-strength web page at: @@ -307,7 +308,7 @@ LICENSE The krb5-strength package as a whole is covered by the following copyright statement and license: - Copyright 2016 Russ Allbery + Copyright 2016, 2020 Russ Allbery Copyright 2006-2007, 2009-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior University Copyright 1993 Alec Muffett @@ -347,5 +348,10 @@ LICENSE 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/README.md b/README.md index 1e1de91..580908f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # krb5-strength 3.1 -Copyright 2016 Russ Allbery . Copyright 2006-2007, +[![Build +status](https://github.com/rra/krb5-strength/workflows/build/badge.svg)](https://github.com/rra/krb5-strength/actions) +[![Debian +package](https://img.shields.io/debian/v/krb5-strength)](https://tracker.debian.org/pkg/krb5-strength) + +Copyright 2016, 2020 Russ Allbery . Copyright 2006-2007, 2009-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior University. Copyright 1993 Alec Muffett. This software is distributed under a BSD-style license. Please see the section [License](#license) @@ -147,13 +152,6 @@ Perl modules will also be used by the test suite if present: All are available on CPAN. Some 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. - To bootstrap from a Git checkout, or if you change the Automake files and need to regenerate Makefile.in, you will need Automake 1.11 or later. For bootstrap or if you change configure.ac or any of the m4 files it includes @@ -241,7 +239,8 @@ path: Pass `--enable-silent-rules` to configure for a quieter build (similar to the Linux kernel). Use `make warnings` instead of `make` to build with -full GCC compiler warnings (requires a relatively current version of GCC). +full GCC compiler warnings (requires either GCC or Clang and may require a +relatively current version of the compiler). You can pass the `--enable-reduced-depends` flag to configure to try to minimize the shared library dependencies encoded in the binaries. This @@ -276,6 +275,13 @@ If a test fails, you can run a single test with verbose output via: Do this instead of running the test program directly since it will ensure that necessary environment variables are set up. +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 [krb5-strength web @@ -309,7 +315,7 @@ requests are gratefully reviewed and normally accepted. The krb5-strength package as a whole is covered by the following copyright statement and license: -> Copyright 2016 +> Copyright 2016, 2020 > Russ Allbery > > Copyright 2006-2007, 2009-2010, 2012-2014 @@ -352,5 +358,9 @@ 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/docs/metadata/metadata.json b/docs/metadata/metadata.json index 25e2832..a6dc787 100644 --- a/docs/metadata/metadata.json +++ b/docs/metadata/metadata.json @@ -6,7 +6,7 @@ "copyrights": [ { "holder": "Russ Allbery ", - "years": "2016", + "years": "2016, 2020", }, { "holder": "The Board of Trustees of the Leland Stanford Junior University", @@ -19,13 +19,14 @@ ], "license": "Expat", "build": { - "lancaster": true, - "autotools": true, - "automake": "1.11", "autoconf": "2.64", - "type": "Autoconf", - "reduced_depends": true, + "automake": "1.11", + "autotools": true, "kerberos": true, + "lancaster": true, + "reduced_depends": true, + "type": "Autoconf", + "valgrind": true, }, "support": { "email": "eagle@eyrie.org", @@ -38,6 +39,9 @@ "browse": "https://git.eyrie.org/?p=kerberos/krb5-strength.git", "github": "rra/krb5-strength", "openhub": "https://www.openhub.net/p/krb5-strength", + "status": { + "workflow": "build", + }, }, "distribution": { "section": "kerberos",