summaryrefslogtreecommitdiff
path: root/pkgtools
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2005-09-04 00:04:15 +0000
committerrillig <rillig@pkgsrc.org>2005-09-04 00:04:15 +0000
commit188a8676f43f284bca0bc72619a0f884e07809c3 (patch)
treeeca193a34d0324e59a99d6a793e63857c1c69b8f /pkgtools
parent64edcd53d3057799deae66f406ae04b9d61155d9 (diff)
downloadpkgsrc-188a8676f43f284bca0bc72619a0f884e07809c3.tar.gz
Updated the man pages.
Diffstat (limited to 'pkgtools')
-rw-r--r--pkgtools/pkglint/files/pkglint.043
-rw-r--r--pkgtools/pkglint/files/pkglint.123
2 files changed, 30 insertions, 36 deletions
diff --git a/pkgtools/pkglint/files/pkglint.0 b/pkgtools/pkglint/files/pkglint.0
index 956766f05de..e99906ca174 100644
--- a/pkgtools/pkglint/files/pkglint.0
+++ b/pkgtools/pkglint/files/pkglint.0
@@ -1,10 +1,10 @@
-PKGLINT(1) NetBSD General Commands Manual PKGLINT(1)
+PKGLINT(1) NetBSD Reference Manual PKGLINT(1)
NNAAMMEE
ppkkgglliinntt - a verifier for pkgsrc directories
SSYYNNOOPPSSIISS
- ppkkgglliinntt [--ooppttiioonnss] [_d_i_r]
+ ppkkgglliinntt [--ooppttiioonnss] [_d_i_r _._._.]
DDEESSCCRRIIPPTTIIOONN
ppkkgglliinntt attempts to detect features of the named pkgsrc packages that are
@@ -16,22 +16,19 @@ DDEESSCCRRIIPPTTIIOONN
OOppttiioonnss
- --BB _n Set the number of contiguous blank lines
- allowed in _M_a_k_e_f_i_l_e to _n (by default, _n is 1.)
-
--CC{{[[nnoo--]]cchheecckk,,......}} Enable or disable specific checks. For a list
of checks, see below.
--hh|----hheellpp Show the summary of command line options, then
exit.
- --II Show the Makefile that is constructed by
- including all the files that are slurped in via
+ --II Show the Makefile that is constructed by in-
+ cluding all the files that are slurped in via
.include directives. This flag is mainly for
debugging.
- --qq|----qquuiieett Don't print the errors and warnings summary
- before terminating.
+ --qq|----qquuiieett Don't print the errors and warnings summary be-
+ fore terminating.
--vv|----vveerrbboossee Be verbose. Show the progress report for items
that are being checked.
@@ -45,8 +42,8 @@ DDEESSCCRRIIPPTTIIOONN
nnoonnee Disable all checks.
- [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all
- included files.
+ [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all in-
+ cluded files.
[[nnoo--]]MMEESSSSAAGGEE Check MESSAGE files.
@@ -83,20 +80,20 @@ DDEESSCCRRIIPPTTIIOONN
alphabetically. This warning is disabled by
default.
- [[nnoo--]]ttyyppeess Warn for some Makefile variables if their
- assigned values do not match their type.
+ [[nnoo--]]ttyyppeess Warn for some Makefile variables if their as-
+ signed values do not match their type.
[[nnoo--]]wwoorrkkddiirr Warn about existing _w_o_r_k_* directories. They
might be committed to CVS accidentally.
- OOtthheerr aarrgguummeennttss
+ OOtthheerr aarrgguummeennttss
_d_i_r _._._. The pkgsrc directories to be checked. If omit-
ted, the current directory is checked.
FFIILLEESS
- /usr/pkgsrc/mk/bsd.pkg.mk The pkgsrc master Makefile
- /usr/pkgsrc/* The files of the NetBSD packages collection
+ @PKGSRCDIR@/mk/bsd.pkg.mk The pkgsrc master Makefile.
+ @PKGSRCDIR@/* Other pkgsrc files.
EEXXAAMMPPLLEESS
ppkkgglliinntt --CCnnoonnee,,ppaattcchheess ..
@@ -109,14 +106,14 @@ EEXXAAMMPPLLEESS
DDIIAAGGNNOOSSTTIICCSS
Diagnostics are written to the standard output.
- FATAL: ... Fatal errors are those that must be fixed before a package
- may be committed to pkgsrc.
+ ERROR: ... Errors should be fixed before a package is committed to
+ pkgsrc.
WARN: ... Warnings generally should be fixed, but they are not as
- critical as fatal errors.
+ critical as errors.
OK: ... Informational messages are only written in verbose mode
- (--vv). Their main use is to aid debugging.
+ (--vv). Their main use is to aid debugging.
AAUUTTHHOORRSS
Jun-ichiro Itoh <itojun@itojun.org>
@@ -128,7 +125,7 @@ AAUUTTHHOORRSS
BBUUGGSS
Many more checks could be added.
- If you don't understand the messages, feel free to ask on the
- <tech-pkg@NetBSD.org> mailing list.
+ If you don't understand the messages, feel free to ask on the <tech-
+ pkg@NetBSD.org> mailing list.
-NetBSD 2.0 July 21, 2005 NetBSD 2.0
+ September 04, 2005 2
diff --git a/pkgtools/pkglint/files/pkglint.1 b/pkgtools/pkglint/files/pkglint.1
index 54636e40bb3..110c1614a0c 100644
--- a/pkgtools/pkglint/files/pkglint.1
+++ b/pkgtools/pkglint/files/pkglint.1
@@ -1,4 +1,4 @@
-.\" $NetBSD: pkglint.1,v 1.17 2005/08/25 07:24:00 rillig Exp $
+.\" $NetBSD: pkglint.1,v 1.18 2005/09/04 00:04:15 rillig Exp $
.\" From FreeBSD: portlint.1,v 1.8 1997/11/25 14:53:14 itojun Exp
.\"
.\" Copyright (c) 1997 by Jun-ichiro Itoh <itojun@itojun.org>.
@@ -7,7 +7,7 @@
.\" Roland Illig <roland.illig@gmx.de>, 2004, 2005.
.\" Roland Illig <rillig@NetBSD.org>, 2005.
.\"
-.Dd August 24, 2005
+.Dd September 04, 2005
.Dt PKGLINT 1
.Sh NAME
.Nm pkglint
@@ -15,7 +15,7 @@
.Sh SYNOPSIS
.Nm pkglint
.Op Fl options
-.Op Ar dir
+.Op Ar dir ...
.Sh DESCRIPTION
.Nm
attempts to detect features of the named pkgsrc packages that are likely
@@ -109,12 +109,10 @@ If omitted, the current directory is checked.
.El
.Sh FILES
.Bl -tag -width /usr/pkgsrc/mk/bsd.pkg.mk -compact
-.It Pa /usr/pkgsrc/mk/bsd.pkg.mk
-The pkgsrc master Makefile
-.It Pa /usr/pkgsrc/*
-The files of the
-.Nx
-packages collection
+.It Pa @PKGSRCDIR@/mk/bsd.pkg.mk
+The pkgsrc master Makefile.
+.It Pa @PKGSRCDIR@/*
+Other pkgsrc files.
.El
.Sh EXAMPLES
.Bl -tag -width Fl
@@ -126,12 +124,11 @@ Checks the category Makefile and reports any warnings it can find.
.Sh DIAGNOSTICS
Diagnostics are written to the standard output.
.Bl -tag -width "WARN: foobaa"
-.It FATAL: ...
-Fatal errors are those that must be fixed before a package may be
-committed to pkgsrc.
+.It ERROR: ...
+Errors should be fixed before a package is committed to pkgsrc.
.It WARN: ...
Warnings generally should be fixed, but they are not as critical as
-fatal errors.
+errors.
.It OK: ...
Informational messages are only written in verbose mode
.Pq Fl v .