]> eyrie.org Git - kerberos/pam-krb5.git/commitdiff
Regenerate documentation files
authorRuss Allbery <eagle@eyrie.org>
Mon, 20 Jan 2020 04:41:01 +0000 (20:41 -0800)
committerRuss Allbery <eagle@eyrie.org>
Mon, 20 Jan 2020 04:41:01 +0000 (20:41 -0800)
Update for some documentation changes and add badges for Travis-CI
status and the Debian package version.

README
README.md
docs/metadata/metadata.json

diff --git a/README b/README
index eb6ef1a3dde0a750b5aca0120df484d1d991ff9f..701c8a57ae722bbd9480307501d1b9b821c82db9 100644 (file)
--- a/README
+++ b/README
@@ -42,12 +42,12 @@ DESCRIPTION
   support Kerberos v4 or AFS.  For an AFS session module that works with
   this module (or any other Kerberos PAM module), see pam-afs-session [1].
 
+  [1] https://www.eyrie.org/~eagle/software/pam-afs-session/
+
   If there are other options besides AFS and Kerberos v4 support from the
   Sourceforge PAM module that you're missing in this module, please let me
   know.
 
-  [1] https://www.eyrie.org/~eagle/software/pam-afs-session/
-
 REQUIREMENTS
 
   Either MIT Kerberos (or Kerberos implementations based on it) or Heimdal
@@ -149,7 +149,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
@@ -196,6 +197,15 @@ TESTING
   library-mediated password change of an expired password.  This is fixed
   in later releases of Heimdal.
 
+  To run the full test suite, Perl 5.8 or later is required.  The
+  following additional Perl modules will be used if present:
+
+  * Test::Pod
+  * Test::Spelling
+
+  All are available on CPAN.  Those tests will be skipped if the modules
+  are not available.
+
 CONFIGURING
 
   Just installing the module does not enable it or change anything about
@@ -610,5 +620,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.
index 44335bb92cb7c95795d5cac45bb7e252daccabdd..ef53c98d8d7562b23c318ef3bc9147d1e7330c06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
 # pam-krb5 4.8
 
+[![Build
+status](https://travis-ci.org/rra/pam-krb5.svg?branch=master)](https://travis-ci.org/rra/pam-krb5)
+[![Debian
+package](https://img.shields.io/debian/v/libpam-krb5)](https://tracker.debian.org/pkg/libpam-krb5)
+
 Copyright 2005-2010, 2014-2015, 2017 Russ Allbery <eagle@eyrie.org>.
 Copyright 2009-2011 The Board of Trustees of the Leland Stanford Junior
 University.  Copyright 2005 Andres Salomon <dilinger@debian.org>.
@@ -153,7 +158,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
@@ -204,6 +210,15 @@ to a bug in Heimdal with reauthenticating immediately after a
 library-mediated password change of an expired password.  This is fixed in
 later releases of Heimdal.
 
+To run the full test suite, Perl 5.8 or later is required.  The following
+additional Perl modules will be used if present:
+
+* Test::Pod
+* Test::Spelling
+
+All are available on CPAN.  Those tests will be skipped if the modules are
+not available.
+
 ## Configuring
 
 Just installing the module does not enable it or change anything about
@@ -632,5 +647,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.
index 7d424a3d0e23f4869a151f61d71151be51ee7d1c..f4c0b16a7d65d34420603335fb29674fa7032ddb 100644 (file)
@@ -42,6 +42,7 @@
         "browse": "https://git.eyrie.org/?p=kerberos/pam-krb5.git",
         "github": "rra/pam-krb5",
         "openhub": "https://www.openhub.net/p/pamkrb5",
+        "travis": "rra/pam-krb5",
     },
     "readme": {
         "sections": [