[123678] trunk/base/doc

[cal at macports.org]

Revision: 123678
          https://trac.macports.org/changeset/123678
Author:   cal at macports.org
Date:     2014-08-12 04:46:51 -0700 (Tue, 12 Aug 2014)
Log Message:
-----------
base: document port-dependents.1, #44530

Modified Paths:
--------------
    trunk/base/doc/Makefile.in

Added Paths:
-----------
    trunk/base/doc/dependents-vs-dependencies.txt
    trunk/base/doc/port-dependents.1.txt

Modified: trunk/base/doc/Makefile.in
===================================================================
--- trunk/base/doc/Makefile.in	2014-08-12 11:46:12 UTC (rev 123677)
+++ trunk/base/doc/Makefile.in	2014-08-12 11:46:51 UTC (rev 123678)
@@ -27,6 +27,7 @@
 		port-configure.1 \
 		port-contents.1 \
 		port-deactivate.1 \
+		port-dependents.1 \
 		port-destroot.1 \
 		port-edit.1 \
 		port-extract.1 \

Added: trunk/base/doc/dependents-vs-dependencies.txt
===================================================================
--- trunk/base/doc/dependents-vs-dependencies.txt	                        (rev 0)
+++ trunk/base/doc/dependents-vs-dependencies.txt	2014-08-12 11:46:51 UTC (rev 123678)
@@ -0,0 +1,17 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+
+DEPENDENCY RELATIONS
+--------------------
+
+Do not confuse 'dependents' and 'dependencies' (or, shortened, 'deps').
+Refer to the following example to understand the difference:
+
+----
+portA --> portB
+----
+
+*portA* depends on *portB*, i.e., *portA* needs *portB* to run. Because of
+that, *portB* is a 'dependency' (or 'dep') of *portA*. After installing
+*portA*, *portB* has been automatically installed. At this point, *portA* has
+become a 'dependent' of *portB*. You can only uninstall *portB* once all of its
+dependents (i.e., including *portA*) have been uninstalled.


Property changes on: trunk/base/doc/dependents-vs-dependencies.txt
___________________________________________________________________
Added: svn:keywords
   + Author Date Id Rev URL
Added: svn:eol-style
   + native

Copied: trunk/base/doc/port-dependents.1.txt (from rev 123672, trunk/base/doc/port-cat.1.txt)
===================================================================
--- trunk/base/doc/port-dependents.1.txt	                        (rev 0)
+++ trunk/base/doc/port-dependents.1.txt	2014-08-12 11:46:51 UTC (rev 123678)
@@ -0,0 +1,51 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-dependents(1)
+==================
+$Id$
+
+NAME
+----
+port-dependents - List ports that depend on a given (installed) port
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *dependents*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port dependents* reports which ports depend upon a given (installed) port, if
+any. Note that *dependents* does not work for ports that are not installed on
+your system. It uses the database of installed ports that MacPorts keeps
+internally, which records the dependency relations at installation time. *port
+dependents* prints this information.
+
+For this reason, *port dependents* does not work for ports that are not
+installed on your system. If you want to find out which ports depend on a port
+you haven't installed, you can use the *depends:* pseudo-portname selector:
+
+----
+port echo depends:<portname>
+----
+
+This command will, however, not cover dependencies that are only present in
+non-default variants. For more information about pseudo-portname selectors, see
+man:port[1].
+
+The dependency relations printed by *port dependents* are the same that are used
+to determine if a port can be safely uninstalled. Ports that still have
+dependents installed cannot be uninstalled without either the
+*--follow-dependents* or the *-f* flag. See man:port-uninstall[1] for more
+details.
+
+include::dependents-vs-dependencies.txt[]
+
+SEE ALSO
+--------
+man:port[1], man:port-echo[1], man:port-deps[1], man:port-uninstall[1]
+
+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/20140812/357e8029/attachment-0001.html>