[123944] trunk/base/doc/port-lint.1.txt

[cal at macports.org]

Revision: 123944
          https://trac.macports.org/changeset/123944
Author:   cal at macports.org
Date:     2014-08-16 06:30:02 -0700 (Sat, 16 Aug 2014)
Log Message:
-----------
base: document port lint, #44530

Added Paths:
-----------
    trunk/base/doc/port-lint.1.txt

Copied: trunk/base/doc/port-lint.1.txt (from rev 123943, trunk/base/doc/port-install.1.txt)
===================================================================
--- trunk/base/doc/port-lint.1.txt	                        (rev 0)
+++ trunk/base/doc/port-lint.1.txt	2014-08-16 13:30:02 UTC (rev 123944)
@@ -0,0 +1,59 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-lint(1)
+============
+$Id$
+
+NAME
+----
+port-lint - Check a port for common problems
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-vdq*] [*-D* 'portdir'] *lint*
+     [--nitpick]
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port lint* checks the Portfile of a given port for potential errors. It is
+a useful tool for port maintainers to check for possible typos, mistakes and
+missing definitions.
+
+For example, it verifies that
+ - Portfiles are valid UTF-8
+ - all mandatory properties are present
+ - all dependencies actually exist, and
+ - no deprecated features are used.
+
+If problems are found, *port lint* emits warnings and error messages explaining
+the problem. Please fix all errors and consider fixing any warnings before
+submitting your Portfile or your changes to MacPorts.
+
+OPTIONS
+-------
+*--nitpick*::
+    Enables additional checks that are mostly whitespace-related and best
+    practices.
+
+include::global-flags.txt[]
+
+*-v*::
+    Print messages for successful tests.
+
+*-d*::
+    Print the Portfile, and debugging information parsed from the Portfile.
+
+*-q*::
+    Supress the header line, warning and error count; only print warnings and
+    errors, if any.
+
+
+SEE ALSO
+--------
+man:port[1], man:portfile[7], man:port-dev-style[7]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140816/cdf558de/attachment.html>