source: trunk/base/doc/port-lint.1

Last change on this file was 125368, checked in by cal@…, 5 years ago

base: doc: re-generate roff from asciidoc source

File size: 2.9 KB
Line 
1'\" t
2.TH "PORT\-LINT" "1" "2014\-09\-14" "MacPorts 2\&.3\&.99" "MacPorts Manual"
3.\" -----------------------------------------------------------------
4.\" * Define some portability stuff
5.\" -----------------------------------------------------------------
6.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7.\" http://bugs.debian.org/507673
8.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10.ie \n(.g .ds Aq \(aq
11.el       .ds Aq '
12.\" -----------------------------------------------------------------
13.\" * set default formatting
14.\" -----------------------------------------------------------------
15.\" disable hyphenation
16.nh
17.\" disable justification (adjust text to left margin only)
18.ad l
19.\" -----------------------------------------------------------------
20.\" * MAIN CONTENT STARTS HERE *
21.\" -----------------------------------------------------------------
22.SH "NAME"
23port-lint \- Check a port for common problems
24.SH "SYNOPSIS"
25.sp
26.nf
27\fBport\fR [\fB\-vdq\fR] [\fB\-D\fR \fIportdir\fR] \fBlint\fR
28     [\-\-nitpick]
29     [[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
30.fi
31.SH "DESCRIPTION"
32.sp
33\fBport lint\fR checks the \fIPortfile\fR of a given port for potential errors\&. It is a useful tool for port maintainers to check for possible typos, mistakes and missing definitions\&.
34.sp
35For example, it verifies that
36.sp
37.RS 4
38.ie n \{\
39\h'-04'\(bu\h'+03'\c
40.\}
41.el \{\
42.sp -1
43.IP \(bu 2.3
44.\}
45Portfiles are valid UTF\-8
46.RE
47.sp
48.RS 4
49.ie n \{\
50\h'-04'\(bu\h'+03'\c
51.\}
52.el \{\
53.sp -1
54.IP \(bu 2.3
55.\}
56all mandatory properties are present
57.RE
58.sp
59.RS 4
60.ie n \{\
61\h'-04'\(bu\h'+03'\c
62.\}
63.el \{\
64.sp -1
65.IP \(bu 2.3
66.\}
67all dependencies actually exist, and
68.RE
69.sp
70.RS 4
71.ie n \{\
72\h'-04'\(bu\h'+03'\c
73.\}
74.el \{\
75.sp -1
76.IP \(bu 2.3
77.\}
78no deprecated features are used\&.
79.RE
80.sp
81If problems are found, \fBport lint\fR emits warnings and error messages explaining the problem\&. Please fix all errors and consider fixing any warnings before submitting your \fIPortfile\fR or your changes to MacPorts\&.
82.SH "OPTIONS"
83.PP
84\fB\-\-nitpick\fR
85.RS 4
86Enables additional checks that are mostly whitespace\-related and best practices\&.
87.RE
88.SH "GLOBAL OPTIONS"
89.sp
90Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
91.PP
92\fB\-v\fR
93.RS 4
94Print messages for successful tests\&.
95.RE
96.PP
97\fB\-d\fR
98.RS 4
99Print the
100\fIPortfile\fR, and debugging information parsed from the
101\fIPortfile\fR\&.
102.RE
103.PP
104\fB\-q\fR
105.RS 4
106Suppress the header line, warning and error count; only print warnings and errors, if any\&.
107.RE
108.SH "SEE ALSO"
109.sp
110\fBport\fR(1), \fBportfile\fR(7), \fBport-dev-style\fR(7)
111.SH "AUTHORS"
112.sp
113.if n \{\
114.RS 4
115.\}
116.nf
117(C) 2014 The MacPorts Project
118Clemens Lang <cal@macports\&.org>
119.fi
120.if n \{\
121.RE
122.\}
Note: See TracBrowser for help on using the repository browser.