Skip to content

Commit

Permalink
Update to v1.1.3
Browse files Browse the repository at this point in the history
Thanks to Emanuel Haupt (https://github.com/ehaupt)
  • Loading branch information
HubTou authored Mar 4, 2024
1 parent 40334c0 commit 81d0500
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 11 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pip install 'PNU[freebsd]' # if you use a platform other than FreeBSD
pip install pytnix
```

# PORTSTREELINT(8)
# PortsTreeLint(8)

## NAME
portstreelint - FreeBSD ports tree lint
Expand Down Expand Up @@ -37,7 +37,7 @@ portstreelint - FreeBSD ports tree lint

## DESCRIPTION
The **portstreelint** utility checks the FreeBSD ports tree Index
and some parts of the port's Makefiles for errors and warnings.
and some parts of the ports' Makefiles for errors and warnings.

By default it will scan the whole port tree, but you can select
a subset of the ports with the options *--cat|-c* for categories,
Expand All @@ -47,6 +47,9 @@ or a comma-separated list of items.
If you combine several of these operators they will perform as
a logical AND.

The *--mnt|-m* option defaults to @FreeBSD.org for unspecified
domains.

In order to know which categories or maintainers are available
for selection, you can use the *--show-cat|-C* and *--show-mnt|-M*
options to view all the categories and maintainers with their
Expand Down Expand Up @@ -123,7 +126,7 @@ Options | Use
--|Options processing terminator

## ENVIRONMENT
The *PORTSTREELINT_DEBUG* environment variable can be set to any value to enable debug mode.
The *PTLINT_DEBUG* environment variable can be set to any value to enable debug mode.

## FILES
The whole port tree under /usr/ports
Expand Down
7 changes: 4 additions & 3 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
* Next version: checking distfiles availability

## Probable evolutions

## Possible evolutions
* Having a configuration file
* Limits setting
* Checks disabling
* Checks enabling or disabling
* Exclusion of ports, maintainers, categories
* Correction of false positives

## Possible evolutions
* Better Makefiles exploitation by expanding embedded variables when possible locally
* Checking the existence of domains in maintainer's email addresses
* Checking the depends fields (extract/patch/fetch/build/run):
* between the Index and the Makefiles
Expand Down
10 changes: 7 additions & 3 deletions man/portstreelint.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.Dd March 3, 2024
.Dd March 4, 2024
.Dt portstreelint 8
.Os
.Sh NAME
Expand Down Expand Up @@ -28,7 +28,7 @@
The
.Nm
utility checks the FreeBSD ports tree Index
and some parts of the port's Makefiles for errors and warnings.
and some parts of the ports' Makefiles for errors and warnings.
.Pp
By default it will scan the whole port tree, but you can select
a subset of the ports with the options
Expand All @@ -43,6 +43,10 @@ or a comma\-separated list of items.
If you combine several of these operators they will perform as
a logical AND.
.Pp
The
.Op Fl \-mnt|\-m
option defaults to @FreeBSD.org for unspecified domains.
.Pp
In order to know which categories or maintainers are available
for selection, you can use the
.Op Fl \-show\-cat|\-C
Expand Down Expand Up @@ -193,7 +197,7 @@ Print usage and this help message and exit
Options processing terminator
.Sh ENVIRONMENT
The
.Ev PORTSTREELINT_DEBUG
.Ev PTLINT_DEBUG
environment variable can be set to any value to enable debug mode.
.Sh FILES
The whole port tree under
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = pnu-portstreelint
description = FreeBSD ports tree lint
long_description = file: README.md
long_description_content_type = text/markdown
version = 1.1.2
version = 1.1.3
license = BSD 3-Clause License
license_files = License
author = Hubert Tournier
Expand Down
4 changes: 3 additions & 1 deletion src/portstreelint/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
""" portstreelint - FreeBSD ports tree lint
License: 3-clause BSD (see https://opensource.org/licenses/BSD-3-Clause)
Author: Hubert Tournier
Contributor: Emanuel Haupt
"""

import getopt
Expand Down Expand Up @@ -30,7 +31,7 @@


# Version string used by the what(1) and ident(1) commands:
ID = "@(#) $Id: portstreelint - FreeBSD ports tree lint v1.1.2 (March 4, 2024) by Hubert Tournier $"
ID = "@(#) $Id: portstreelint - FreeBSD ports tree lint v1.1.3 (March 4, 2024) by Hubert Tournier $"

# Default parameters. Can be overcome by command line options:
parameters = {
Expand Down Expand Up @@ -205,6 +206,7 @@ def _process_command_line():
maintainers = argument.lower().split(",")
parameters["Maintainers"] = [m if '@' in m else f"{m}@freebsd.org" for m in maintainers]


elif option in ("--output", "-o"):
parameters["Output filename"] = argument

Expand Down

0 comments on commit 81d0500

Please sign in to comment.