mirror of
https://git.FreeBSD.org/ports.git
synced 2024-11-23 00:43:28 +00:00
Fix docs
Submitted by: olgeni
This commit is contained in:
Michael Haro
parent
ad35551e9b
commit
1503c58d38
Notes:
svn2git
2021-03-31 03:12:20 +00:00
svn path=/head/; revision=38325
@ -10,7 +10,8 @@
|
||||
.Nd a verifier for port directory
|
||||
.Sh SYNOPSIS
|
||||
.Nm portlint
|
||||
.Op Fl abchvN
|
||||
.Op Fl abchvtN
|
||||
.Op Fl M Ar ENV
|
||||
.Op Fl B Ar n
|
||||
.Op Ar dir
|
||||
.Sh DESCRIPTION
|
||||
@ -20,14 +21,14 @@ The purpose of
|
||||
.Nm
|
||||
can be separated into two parts:
|
||||
.Pq 1
|
||||
to let the submitters easily polish her/his own port directory, and
|
||||
to let the submitters easily polish their own port directory, and
|
||||
.Pq 2
|
||||
to decrease the labor of the committers.
|
||||
.Pp
|
||||
.Nm
|
||||
uses very simple regular-expression matching for verifying
|
||||
files that make up a port directory.
|
||||
Note that it does NOT implement complete parser for those files.
|
||||
Note that it does NOT implement a complete parser for those files.
|
||||
Because of this the user may see some extra warnings,
|
||||
especially when checking complex
|
||||
.Pa Makefile Ns No s .
|
||||
@ -50,18 +51,24 @@ even though they are semantically same.
|
||||
.It Fl c
|
||||
Committer flag.
|
||||
It will add several checks useful only for committers.
|
||||
If you are a committer and performing check just before commiting a port,
|
||||
If you are a committer and performing check just before committing a port,
|
||||
use this option.
|
||||
.It Fl h
|
||||
Show the summary of command line options, then exit.
|
||||
.It Fl v
|
||||
Be verbose.
|
||||
Show the progress report for items that are being checked.
|
||||
.It Fl t
|
||||
Nit pick about use of spaces.
|
||||
.It Fl N
|
||||
New port flag.
|
||||
Adds several checks specific to newly submitted port.
|
||||
If you are willing to submit the directory to be checked as a new port,
|
||||
use this option.
|
||||
.It Fl M Ar ENV
|
||||
Set make variables to
|
||||
.Pa ENV
|
||||
(ex. PORTSDIR=/usr/ports.work).
|
||||
.It Fl B Ar n
|
||||
Set the number of contiguous blank lines allowed in
|
||||
.Pa Makefile
|
||||
@ -83,8 +90,8 @@ in the port directory.
|
||||
For example, if some files need a rewrite, or if
|
||||
some inevitable files are missing, this message will show up.
|
||||
This kind of errors should be avoided BEFORE submitting
|
||||
a port via send-pr to the comitters.
|
||||
.\"If a submitter submit it without update, committers will need to rewrite
|
||||
a port via send-pr to the committers.
|
||||
.\"If a submitter submits it without update, committers will need to rewrite
|
||||
.\"on behalf of the submitters, which may result in delay of
|
||||
.\"the development of operating system itself.
|
||||
.It WARN: ...
|
||||
@ -110,19 +117,26 @@ This type of messages are used in verbose mode
|
||||
master Makefile for ports
|
||||
.Po
|
||||
.Pa bsd.pkg.mk
|
||||
on NetBSD/OpenBSD
|
||||
on
|
||||
.Nx
|
||||
/
|
||||
.Ox
|
||||
.Pc
|
||||
.It Pa /usr/ports/*
|
||||
port collection
|
||||
.Po
|
||||
.Pa /usr/pkgsrc/*
|
||||
on NetBSD/OpenBSD
|
||||
on
|
||||
.Nx
|
||||
/
|
||||
.Ox
|
||||
.Pc
|
||||
.Sh AUTHORS
|
||||
.An Michael Haro Aq mharo@FreeBSD.org
|
||||
.An Jun-ichiro Hagino Aq itojun@itojun.org
|
||||
and
|
||||
.An Yoshishige Arai Aq ryo2@on.rim.or.jp .
|
||||
.Pp
|
||||
Many people has contributed patches and comments/suggestions.
|
||||
.Sh BUGS
|
||||
.Nm
|
||||
|
||||
@ -78,14 +78,15 @@ my $re_lang_pref = '(' . join('|', @lang_pref) . ')-';
|
||||
my ($prog) = ($0 =~ /([^\/]+)$/);
|
||||
sub usage {
|
||||
print STDERR <<EOF;
|
||||
usage: $prog [-abctvN] [-B#] [port_directory]
|
||||
usage: $prog [-abchvtN] [-M ENV] [-B#] [port_directory]
|
||||
-a additional check for scripts/* and pkg-*
|
||||
-b warn \$(VARIABLE)
|
||||
-c committer mode
|
||||
-h show summary of command line options
|
||||
-v verbose mode
|
||||
-t nit pick about use of spaces
|
||||
-M set make variables (ex. PORTSDIR=/usr/ports.work)
|
||||
-N writing a new port
|
||||
-M ENV set make variables to ENV (ex. PORTSDIR=/usr/ports.work)
|
||||
-B# allow # contiguous blank lines (default: $contblank line)
|
||||
EOF
|
||||
exit 0;
|
||||
|
||||
@ -10,7 +10,8 @@
|
||||
.Nd a verifier for port directory
|
||||
.Sh SYNOPSIS
|
||||
.Nm portlint
|
||||
.Op Fl abchvN
|
||||
.Op Fl abchvtN
|
||||
.Op Fl M Ar ENV
|
||||
.Op Fl B Ar n
|
||||
.Op Ar dir
|
||||
.Sh DESCRIPTION
|
||||
@ -20,14 +21,14 @@ The purpose of
|
||||
.Nm
|
||||
can be separated into two parts:
|
||||
.Pq 1
|
||||
to let the submitters easily polish her/his own port directory, and
|
||||
to let the submitters easily polish their own port directory, and
|
||||
.Pq 2
|
||||
to decrease the labor of the committers.
|
||||
.Pp
|
||||
.Nm
|
||||
uses very simple regular-expression matching for verifying
|
||||
files that make up a port directory.
|
||||
Note that it does NOT implement complete parser for those files.
|
||||
Note that it does NOT implement a complete parser for those files.
|
||||
Because of this the user may see some extra warnings,
|
||||
especially when checking complex
|
||||
.Pa Makefile Ns No s .
|
||||
@ -50,18 +51,24 @@ even though they are semantically same.
|
||||
.It Fl c
|
||||
Committer flag.
|
||||
It will add several checks useful only for committers.
|
||||
If you are a committer and performing check just before commiting a port,
|
||||
If you are a committer and performing check just before committing a port,
|
||||
use this option.
|
||||
.It Fl h
|
||||
Show the summary of command line options, then exit.
|
||||
.It Fl v
|
||||
Be verbose.
|
||||
Show the progress report for items that are being checked.
|
||||
.It Fl t
|
||||
Nit pick about use of spaces.
|
||||
.It Fl N
|
||||
New port flag.
|
||||
Adds several checks specific to newly submitted port.
|
||||
If you are willing to submit the directory to be checked as a new port,
|
||||
use this option.
|
||||
.It Fl M Ar ENV
|
||||
Set make variables to
|
||||
.Pa ENV
|
||||
(ex. PORTSDIR=/usr/ports.work).
|
||||
.It Fl B Ar n
|
||||
Set the number of contiguous blank lines allowed in
|
||||
.Pa Makefile
|
||||
@ -83,8 +90,8 @@ in the port directory.
|
||||
For example, if some files need a rewrite, or if
|
||||
some inevitable files are missing, this message will show up.
|
||||
This kind of errors should be avoided BEFORE submitting
|
||||
a port via send-pr to the comitters.
|
||||
.\"If a submitter submit it without update, committers will need to rewrite
|
||||
a port via send-pr to the committers.
|
||||
.\"If a submitter submits it without update, committers will need to rewrite
|
||||
.\"on behalf of the submitters, which may result in delay of
|
||||
.\"the development of operating system itself.
|
||||
.It WARN: ...
|
||||
@ -110,19 +117,26 @@ This type of messages are used in verbose mode
|
||||
master Makefile for ports
|
||||
.Po
|
||||
.Pa bsd.pkg.mk
|
||||
on NetBSD/OpenBSD
|
||||
on
|
||||
.Nx
|
||||
/
|
||||
.Ox
|
||||
.Pc
|
||||
.It Pa /usr/ports/*
|
||||
port collection
|
||||
.Po
|
||||
.Pa /usr/pkgsrc/*
|
||||
on NetBSD/OpenBSD
|
||||
on
|
||||
.Nx
|
||||
/
|
||||
.Ox
|
||||
.Pc
|
||||
.Sh AUTHORS
|
||||
.An Michael Haro Aq mharo@FreeBSD.org
|
||||
.An Jun-ichiro Hagino Aq itojun@itojun.org
|
||||
and
|
||||
.An Yoshishige Arai Aq ryo2@on.rim.or.jp .
|
||||
.Pp
|
||||
Many people has contributed patches and comments/suggestions.
|
||||
.Sh BUGS
|
||||
.Nm
|
||||
|
||||
@ -78,14 +78,15 @@ my $re_lang_pref = '(' . join('|', @lang_pref) . ')-';
|
||||
my ($prog) = ($0 =~ /([^\/]+)$/);
|
||||
sub usage {
|
||||
print STDERR <<EOF;
|
||||
usage: $prog [-abctvN] [-B#] [port_directory]
|
||||
usage: $prog [-abchvtN] [-M ENV] [-B#] [port_directory]
|
||||
-a additional check for scripts/* and pkg-*
|
||||
-b warn \$(VARIABLE)
|
||||
-c committer mode
|
||||
-h show summary of command line options
|
||||
-v verbose mode
|
||||
-t nit pick about use of spaces
|
||||
-M set make variables (ex. PORTSDIR=/usr/ports.work)
|
||||
-N writing a new port
|
||||
-M ENV set make variables to ENV (ex. PORTSDIR=/usr/ports.work)
|
||||
-B# allow # contiguous blank lines (default: $contblank line)
|
||||
EOF
|
||||
exit 0;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user