Annotation of pkgsrc/pkgtools/python-versions-check/files/python-versions-check.1, revision 1.1

1.1     ! wiz         1: .\"    $NetBSD$
        !             2: .\"
        !             3: .\" Copyright (c) 2023 The NetBSD Foundation, Inc.
        !             4: .\" All rights reserved.
        !             5: .\"
        !             6: .\" This code is derived from software contributed to The NetBSD Foundation
        !             7: .\" by Thomas Klausner.
        !             8: .\"
        !             9: .\" Redistribution and use in source and binary forms, with or without
        !            10: .\" modification, are permitted provided that the following conditions
        !            11: .\" are met:
        !            12: .\" 1. Redistributions of source code must retain the above copyright
        !            13: .\"    notice, this list of conditions and the following disclaimer.
        !            14: .\" 2. Redistributions in binary form must reproduce the above copyright
        !            15: .\"    notice, this list of conditions and the following disclaimer in the
        !            16: .\"    documentation and/or other materials provided with the distribution.
        !            17: .\"
        !            18: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
        !            19: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
        !            20: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
        !            21: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
        !            22: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        !            23: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        !            24: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        !            25: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        !            26: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        !            27: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        !            28: .\" POSSIBILITY OF SUCH DAMAGE.
        !            29: .\"
        !            30: .Dd June 10, 2023
        !            31: .Dt PYTHON-VERSIONS-CHECK.PY 1
        !            32: .Os
        !            33: .Sh NAME
        !            34: .Nm python-versions-check.py
        !            35: .Nd check Python versions for a package and its dependencies and users
        !            36: .Sh SYNOPSIS
        !            37: .Nm
        !            38: .Op Fl hw
        !            39: .Op Fl p Ar pkgsrcdir
        !            40: .Op Ar category/package
        !            41: .Sh DESCRIPTION
        !            42: .Nm
        !            43: is a script for pkgsrc developers that compares the Python versions
        !            44: supported by a package to the ones supported by its dependencies and
        !            45: the packages depending on it.
        !            46: .Pp
        !            47: .Nm
        !            48: checks
        !            49: .Ar category/package
        !            50: or the package in its current working directory, if no argument is
        !            51: provided.
        !            52: .Pp
        !            53: .Nm
        !            54: supports the following options:
        !            55: .Bl -tag -width 12n -offset indent
        !            56: .It Fl h
        !            57: Show the usage.
        !            58: .It Fl p Ar pkgsrcdir
        !            59: Use
        !            60: .Ar pkgsrcdir
        !            61: as root of the pkgsrc tree.
        !            62: Defaults to
        !            63: .Pa /usr/pkgsrc .
        !            64: .It Fl w
        !            65: Also bump packages in the
        !            66: .Pa wip/
        !            67: subtree.
        !            68: .El
        !            69: .Sh EXAMPLES
        !            70: Example for the output if there is a problem:
        !            71: .Bd -literal
        !            72: # python-versions-check.py math/py-numpy
        !            73: Supported Python versions for math/py-numpy: [39, 310, 311]
        !            74: Checking packages used by math/py-numpy:
        !            75: Checking packages using math/py-numpy:
        !            76: math/py-scipy: supports [38, 39, 310, 311], missing: [38]
        !            77: .Ed
        !            78: This means that while
        !            79: .Pa math/py-numpy
        !            80: only supports Python version 3.9, 3.10, and 3.11,
        !            81: .Pa math/py-scipy
        !            82: also supports Python version 3.8.
        !            83: This will break e.g. bulk builds because the required
        !            84: .Pa py38-numpy
        !            85: package will not exist.

CVSweb <webmaster@jp.NetBSD.org>