diff options
author | wiz <wiz> | 2005-07-21 09:07:38 +0000 |
---|---|---|
committer | wiz <wiz> | 2005-07-21 09:07:38 +0000 |
commit | c0f3de89a9229ccc42db3b8d5909513f380a385c (patch) | |
tree | 77492c249a3c499e5ee6552094f5f002c952ea56 /pkgtools | |
parent | d44b444a6eaa9729398881ea2ba52ac3c7cf0c2a (diff) | |
download | pkgsrc-c0f3de89a9229ccc42db3b8d5909513f380a385c.tar.gz |
Fix a typo and improve markup.
Diffstat (limited to 'pkgtools')
-rw-r--r-- | pkgtools/pkglint/files/pkglint.0 | 128 | ||||
-rw-r--r-- | pkgtools/pkglint/files/pkglint.1 | 67 |
2 files changed, 95 insertions, 100 deletions
diff --git a/pkgtools/pkglint/files/pkglint.0 b/pkgtools/pkglint/files/pkglint.0 index bd9685aed0f..956766f05de 100644 --- a/pkgtools/pkglint/files/pkglint.0 +++ b/pkgtools/pkglint/files/pkglint.0 @@ -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 @@ SSYYNNOOPPSSIISS 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 @@ 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.) + --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. + --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. + --qq|----qquuiieett Don't print the errors and warnings summary + before terminating. - --vv|----vveerrbboossee - Be verbose. Show the progress report for items that are be- - ing checked. + --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. + --WW{{[[nnoo--]]wwaarrnn,,......}} Enable or disable specific warnings. For a + list of warnings, see below. CChheecckkss - all Enable all checks. + aallll Enable all checks. - none Disable all checks. + nnoonnee Disable all checks. - [no-]Makefile - Check the package Makefile, including all included files. + [[nnoo--]]MMaakkeeffiillee Check the package Makefile, including all + included files. - [no-]MESSAGE - Check MESSAGE files. + [[nnoo--]]MMEESSSSAAGGEE Check MESSAGE files. - [no-]PLIST Check PLIST files. + [[nnoo--]]PPLLIISSTT Check PLIST files. - [no-]distinfo - Check the distinfo file. + [[nnoo--]]ddiissttiinnffoo Check the distinfo file. - [no-]extra Check remaining files in the package directory. + [[nnoo--]]eexxttrraa Check remaining files in the package directory. - [no-]patches - Check the pkgsrc specific patch files. + [[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 @@ DDIIAAGGNNOOSSTTIICCSS 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>, Yoshishige Arai <ryo2@on.rim.or.jp>, - Roland Illig <rillig@NetBSD.org>. Many people have contributed patches - and comments/suggestions. + Jun-ichiro Itoh <itojun@itojun.org> + Yoshishige Arai <ryo2@on.rim.or.jp> + Roland Illig <rillig@NetBSD.org> + + 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> mailing list. + If you don't understand the messages, feel free to ask on the + <tech-pkg@NetBSD.org> mailing list. - Jul 21, 2005 3 +NetBSD 2.0 July 21, 2005 NetBSD 2.0 diff --git a/pkgtools/pkglint/files/pkglint.1 b/pkgtools/pkglint/files/pkglint.1 index 2ce4c0f7550..b166996a6a5 100644 --- a/pkgtools/pkglint/files/pkglint.1 +++ b/pkgtools/pkglint/files/pkglint.1 @@ -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>. @@ -6,7 +6,7 @@ .\" .\" Roland Illig <roland.illig@gmx.de>, 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 @@ Packages following these rules are assumed to make future changes to the 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 @@ For a list of warnings, see below. .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 Warn for some Makefile variables if their assigned values do not match their type. -.It [no-]workdir +.It Cm [no-]workdir Warn about existing .Pa work* directories. They might be committed to CVS accidentally. .El .Pp -.Bl -tag -width Fl +.Bl -tag -width 18n -offset indent .Sy Other arguments -.It dir ... +.It Ar dir ... The pkgsrc directories to be checked. If omitted, the current directory is checked. .El @@ -125,10 +125,9 @@ packages collection .El .Sh EXAMPLES .Bl -tag -width Fl -.Ic pkglint \-Cnone,patches \ . +.It Ic pkglint \-Cnone,patches \&. Checks the patches of the package in the current directory. -.Pp -.Ic pkglint \-Wall /usr/pkgsrc/devel +.It Ic pkglint \-Wall /usr/pkgsrc/devel Checks the category Makefile and reports any warnings it can find. .El .Sh DIAGNOSTICS @@ -146,12 +145,10 @@ Informational messages are only written in verbose mode Their main use is to aid debugging. .El .Sh AUTHORS -Jun-ichiro Itoh -.Aq itojun@itojun.org , -Yoshishige Arai -.Aq ryo2@on.rim.or.jp , -Roland Illig -.Aq rillig@NetBSD.org . +.An Jun-ichiro Itoh Aq itojun@itojun.org +.An Yoshishige Arai Aq ryo2@on.rim.or.jp +.An Roland Illig Aq rillig@NetBSD.org +.Pp Many people have contributed patches and comments/suggestions. .Sh BUGS Many more checks could be added. |