pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint/files Fix a typo and improve markup.
details: https://anonhg.NetBSD.org/pkgsrc/rev/0b908893f4db
branches: trunk
changeset: 497157:0b908893f4db
user: wiz <wiz%pkgsrc.org@localhost>
date: Thu Jul 21 09:07:38 2005 +0000
description:
Fix a typo and improve markup.
diffstat:
pkgtools/pkglint/files/pkglint.0 | 132 +++++++++++++++++++-------------------
pkgtools/pkglint/files/pkglint.1 | 67 +++++++++----------
2 files changed, 97 insertions(+), 102 deletions(-)
diffs (truncated from 348 to 300 lines):
diff -r d20407e5c7f8 -r 0b908893f4db pkgtools/pkglint/files/pkglint.0
--- a/pkgtools/pkglint/files/pkglint.0 Thu Jul 21 08:33:13 2005 +0000
+++ b/pkgtools/pkglint/files/pkglint.0 Thu Jul 21 09:07:38 2005 +0000
@@ -1,4 +1,4 @@
-PKGLINT(1) NetBSD Reference Manual PKGLINT(1)
+PKGLINT(1) NetBSD General Commands Manual PKGLINT(1)
NNAAMMEE
ppkkgglliinntt - a verifier for pkgsrc directories
@@ -7,7 +7,7 @@
ppkkgglliinntt [--ooppttiioonnss] [_d_i_r]
DDEESSCCRRIIPPTTIIOONN
- ppkkgglliinntt attempts to detect features of the names pkgsrc packages that are
+ ppkkgglliinntt attempts to detect features of the named pkgsrc packages that are
likely to be bugs, or that are simply deprecated. The pkgsrc system is
changing rapidly towards even more portability. The job of ppkkgglliinntt is to
define the rules that make up ``good'' packages and to allow automatic
@@ -16,99 +16,95 @@
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.)
+ --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.
+ --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.
+ --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 .include directives. This flag
- is mainly for debugging.
-
- --qq|----qquuiieett Don't print the errors and warnings summary before terminat-
- ing.
+ --II Show the Makefile that is constructed by
+ including all the files that are slurped in via
+ .include directives. This flag is mainly for
+ debugging.
- --vv|----vveerrbboossee
- Be verbose. Show the progress report for items that are be-
- ing checked.
+ --qq|----qquuiieett Don't print the errors and warnings summary
+ before terminating.
- --WW{{[[nnoo--]]wwaarrnn,,......}}
- Enable or disable specific warnings. For a list of warnings,
- see below.
+ --vv|----vveerrbboossee Be verbose. Show the progress report for items
+ that are being checked.
+
+ --WW{{[[nnoo--]]wwaarrnn,,......}} Enable or disable specific warnings. For a
+ list of warnings, see below.
CChheecckkss
- all Enable all checks.
-
- none Disable all checks.
+ aallll Enable all checks.
- [no-]Makefile
- Check the package Makefile, including all included files.
+ nnoonnee Disable all checks.
- [no-]MESSAGE
- Check MESSAGE files.
+ [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all
+ included files.
- [no-]PLIST Check PLIST files.
+ [[nnoo--]]MMEESSSSAAGGEE Check MESSAGE files.
- [no-]distinfo
- Check the distinfo file.
+ [[nnoo--]]PPLLIISSTT Check PLIST files.
- [no-]extra Check remaining files in the package directory.
+ [[nnoo--]]ddiissttiinnffoo Check the distinfo file.
- [no-]patches
- Check the pkgsrc specific patch files.
+ [[nnoo--]]eexxttrraa Check remaining files in the package directory.
+
+ [[nnoo--]]ppaattcchheess Check the pkgsrc specific patch files.
WWaarrnniinnggss
- all Enable all warnings.
+ aallll Enable all warnings.
- none Disable all warnings.
+ nnoonnee Disable all warnings.
- [no-]absname
- Warn if a file contains an absolute pathname.
+ [[nnoo--]]aabbssnnaammee Warn if a file contains an absolute pathname.
- [no-]directcmd
- Warn if a system command name is used instead of a variable
- (e.g. sed instead of ${SED}).
+ [[nnoo--]]ddiirreeccttccmmdd Warn if a system command name is used instead
+ of a variable (e.g. sed instead of ${SED}).
- [no-]exec Warn if a file in the package directory is executable. Most
- files should not be executable until they are installed.
+ [[nnoo--]]eexxeecc Warn if a file in the package directory is exe-
+ cutable. Most files should not be executable
+ until they are installed.
- [no-]order Warn if Makefile variables are not in the preferred order.
+ [[nnoo--]]oorrddeerr Warn if Makefile variables are not in the pre-
+ ferred order.
- [no-]paren Warn if variables are used like $(VAR) in Makefiles. They
- should always be used like ${VAR}.
+ [[nnoo--]]ppaarreenn Warn if variables are used like $(VAR) in Make-
+ files. They should always be used like ${VAR}.
- [no-]plist-sort
- Warn if items of a PLIST file are not sorted alphabetically.
- This warning is disabled by default.
+ [[nnoo--]]pplliisstt--ssoorrtt Warn if items of a PLIST file are not sorted
+ alphabetically. This warning is disabled by
+ default.
- [no-]types Warn for some Makefile variables if their assigned values do
- not match their type.
+ [[nnoo--]]ttyyppeess Warn for some Makefile variables if their
+ assigned values do not match their type.
- [no-]workdir
- Warn about existing _w_o_r_k_* directories. They might be commit-
- ted to CVS accidentally.
+ [[nnoo--]]wwoorrkkddiirr Warn about existing _w_o_r_k_* directories. They
+ might be committed to CVS accidentally.
- OOtthheerr aarrgguummeennttss
+ OOtthheerr aarrgguummeennttss
- dir ... The pkgsrc directories to be checked. If omitted, the cur-
- rent directory is checked.
+ _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
EEXXAAMMPPLLEESS
- ppkkgglliinntt --CCnnoonnee,,ppaattcchheess .. Checks the patches of the package in the cur-
- rent directory.
+ ppkkgglliinntt --CCnnoonnee,,ppaattcchheess ..
+ Checks the patches of the package in the current directory.
- ppkkgglliinntt --WWaallll //uussrr//ppkkggssrrcc//ddeevveell Checks the category Makefile and reports
- any warnings it can find.
+ ppkkgglliinntt --WWaallll //uussrr//ppkkggssrrcc//ddeevveell
+ Checks the category Makefile and reports any warnings it can
+ find.
DDIIAAGGNNOOSSTTIICCSS
Diagnostics are written to the standard output.
@@ -120,17 +116,19 @@
critical as fatal 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@localhost>, Yoshishige Arai <ryo2%on.rim.or.jp@localhost>,
- Roland Illig <rillig%NetBSD.org@localhost>. Many people have contributed patches
- and comments/suggestions.
+ Jun-ichiro Itoh <itojun%itojun.org@localhost>
+ Yoshishige Arai <ryo2%on.rim.or.jp@localhost>
+ Roland Illig <rillig%NetBSD.org@localhost>
+
+ Many people have contributed patches and comments/suggestions.
BBUUGGSS
Many more checks could be added.
- If you don't understand the messages, feel free to ask on the <tech-
- pkg%NetBSD.org@localhost> mailing list.
+ If you don't understand the messages, feel free to ask on the
+ <tech-pkg%NetBSD.org@localhost> mailing list.
- Jul 21, 2005 3
+NetBSD 2.0 July 21, 2005 NetBSD 2.0
diff -r d20407e5c7f8 -r 0b908893f4db pkgtools/pkglint/files/pkglint.1
--- a/pkgtools/pkglint/files/pkglint.1 Thu Jul 21 08:33:13 2005 +0000
+++ b/pkgtools/pkglint/files/pkglint.1 Thu Jul 21 09:07:38 2005 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: pkglint.1,v 1.15 2005/07/21 02:47:58 rillig Exp $
+.\" $NetBSD: pkglint.1,v 1.16 2005/07/21 09:07:38 wiz 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@localhost>.
@@ -6,7 +6,7 @@
.\"
.\" Roland Illig <roland.illig%gmx.de@localhost>, 2004, 2005.
.\"
-.Dd Jul 21, 2005
+.Dd July 21, 2005
.Dt PKGLINT 1
.Sh NAME
.Nm pkglint
@@ -17,7 +17,7 @@
.Op Ar dir
.Sh DESCRIPTION
.Nm
-attempts to detect features of the names pkgsrc packages that are likely
+attempts to detect features of the named pkgsrc packages that are likely
to be bugs, or that are simply deprecated.
The pkgsrc system is changing rapidly towards even more portability.
The job of
@@ -29,7 +29,7 @@
pkgsrc infrastructure easier.
.Pp
.Sy Options
-.Bl -tag -width Fl
+.Bl -tag -width 18n -offset indent
.It Fl B Ar n
Set the number of contiguous blank lines allowed in
.Pa Makefile
@@ -57,60 +57,60 @@
.El
.Pp
.Sy Checks
-.Bl -tag -width Fl
-.It all
+.Bl -tag -width 18n -offset indent
+.It Cm all
Enable all checks.
-.It none
+.It Cm none
Disable all checks.
-.It [no-]Makefile
+.It Cm [no-]Makefile
Check the package Makefile, including all included files.
-.It [no-]MESSAGE
+.It Cm [no-]MESSAGE
Check MESSAGE files.
-.It [no-]PLIST
+.It Cm [no-]PLIST
Check PLIST files.
-.It [no-]distinfo
+.It Cm [no-]distinfo
Check the distinfo file.
-.It [no-]extra
+.It Cm [no-]extra
Check remaining files in the package directory.
-.It [no-]patches
+.It Cm [no-]patches
Check the pkgsrc specific patch files.
.El
.Pp
.Sy Warnings
-.Bl -tag -width Fl
-.It all
+.Bl -tag -width 18n -offset indent
+.It Cm all
Enable all warnings.
-.It none
+.It Cm none
Disable all warnings.
-.It [no-]absname
+.It Cm [no-]absname
Warn if a file contains an absolute pathname.
-.It [no-]directcmd
+.It Cm [no-]directcmd
Warn if a system command name is used instead of a variable (e.g. sed
instead of ${SED}).
-.It [no-]exec
+.It Cm [no-]exec
Warn if a file in the package directory is executable.
Most files should not be executable until they are installed.
-.It [no-]order
+.It Cm [no-]order
Warn if Makefile variables are not in the preferred order.
-.It [no-]paren
+.It Cm [no-]paren
Warn if variables are used like $(VAR) in Makefiles.
They should always be used like ${VAR}.
-.It [no-]plist-sort
+.It Cm [no-]plist-sort
Warn if items of a PLIST file are not sorted alphabetically.
This warning is disabled by default.
-.It [no-]types
+.It Cm [no-]types
Home |
Main Index |
Thread Index |
Old Index