From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gentoo-commits+bounces-1174161-garchives=archives.gentoo.org@lists.gentoo.org>
Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by finch.gentoo.org (Postfix) with ESMTPS id 014DB1382C5
	for <garchives@archives.gentoo.org>; Mon, 25 May 2020 15:43:32 +0000 (UTC)
Received: from pigeon.gentoo.org (localhost [127.0.0.1])
	by pigeon.gentoo.org (Postfix) with SMTP id C3D88E083E;
	Mon, 25 May 2020 15:43:30 +0000 (UTC)
Received: from smtp.gentoo.org (dev.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4])
	(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
	(No client certificate requested)
	by pigeon.gentoo.org (Postfix) with ESMTPS id 9F2A5E083E
	for <gentoo-commits@lists.gentoo.org>; Mon, 25 May 2020 15:43:30 +0000 (UTC)
Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52])
	(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
	(No client certificate requested)
	by smtp.gentoo.org (Postfix) with ESMTPS id 5D4F334EE13
	for <gentoo-commits@lists.gentoo.org>; Mon, 25 May 2020 15:43:29 +0000 (UTC)
Received: from localhost.localdomain (localhost [IPv6:::1])
	by oystercatcher.gentoo.org (Postfix) with ESMTP id 929FD267
	for <gentoo-commits@lists.gentoo.org>; Mon, 25 May 2020 15:43:27 +0000 (UTC)
From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Content-Transfer-Encoding: 8bit
Content-type: text/plain; charset=UTF-8
Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" <ulm@gentoo.org>
Message-ID: <1589022379.3dc3be9929eaa97576882ab23ac02d9f51368f2d.ulm@gentoo>
Subject: [gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
X-VCS-Repository: proj/devmanual
X-VCS-Files: general-concepts/dependencies/text.xml
X-VCS-Directories: general-concepts/dependencies/
X-VCS-Committer: ulm
X-VCS-Committer-Name: Ulrich Müller
X-VCS-Revision: 3dc3be9929eaa97576882ab23ac02d9f51368f2d
X-VCS-Branch: master
Date: Mon, 25 May 2020 15:43:27 +0000 (UTC)
Precedence: bulk
List-Post: <mailto:gentoo-commits@lists.gentoo.org>
List-Help: <mailto:gentoo-commits+help@lists.gentoo.org>
List-Unsubscribe: <mailto:gentoo-commits+unsubscribe@lists.gentoo.org>
List-Subscribe: <mailto:gentoo-commits+subscribe@lists.gentoo.org>
List-Id: Gentoo Linux mail <gentoo-commits.gentoo.org>
X-BeenThere: gentoo-commits@lists.gentoo.org
X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply
X-Archives-Salt: 1c905dbd-30fe-4d27-ae36-d2f3dcfed02b
X-Archives-Hash: aed7885bfe770842d503f86d7bbd866f

commit:     3dc3be9929eaa97576882ab23ac02d9f51368f2d
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 15 18:25:07 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat May  9 11:06:19 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3dc3be99

general-concepts/dependencies: Tips for checking dependencies.

This is taken from the Gentoo Developer Handbook, chapter
"Ebuild HOWTO" (proj/en/devrel/handbook/hb-guide-ebuild.xml),
section "Package Dependencies", subsection "Important Notes",
which in turn had been copied from chapter "Common ebuild Mistakes"
(proj/en/devrel/handbook/hb-guide-common-mistakes.xml), section
"Common Ebuild Writing Mistakes", subsection "DEPEND is incomplete".

Permission to reuse the CC-BY-SA-1.0 work under CC BY-SA version 2.0
or any later version of that license obtained from author plasmaroo
per e-mail on 2015-04-16, Message-ID
<CAGV+WHCJ61hvw7kh+Wz=uO2esihwc1dXsCWJJWeFAA7UOyyayw <AT> mail.gmail.com>.

Closes: https://bugs.gentoo.org/465764
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 general-concepts/dependencies/text.xml | 51 ++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml
index 52d053e..319137f 100644
--- a/general-concepts/dependencies/text.xml
+++ b/general-concepts/dependencies/text.xml
@@ -573,6 +573,57 @@ DEPEND="
 </subsection>
 </section>
 
+<section>
+<title>Tips for Checking Dependencies</title>
+<body>
+
+<p>
+It is important to ensure that all the dependencies are complete for your
+package:
+</p>
+
+<dl>
+  <dt>Look at installed binaries/libraries</dt>
+  <dd>
+    Use a tool like <c>scanelf -n</c> (from app-misc/pax-utils) or
+    <c>objdump -p</c> (from sys-devel/binutils) to list <c>DT_NEEDED</c>
+    entries
+  </dd>
+  <dt>Look in <c>configure.ac</c></dt>
+  <dd>
+    Look for checks for packages in here. Things to look out for are pkg-config
+    checks or <c>AM_*</c> functions that check for a specific version.
+  </dd>
+  <dt>Look at included <c>.spec</c> files</dt>
+  <dd>
+    A good indication of dependencies is to look at the included <c>.spec</c>
+    files for relevant deps. However, do not trust them to be the definitive
+    complete list of dependencies.
+  </dd>
+  <dt>Look at the application/library website</dt>
+  <dd>
+    Check the application website for possible dependencies that they suggest
+    are needed
+  </dd>
+  <dt>Read the <c>README</c> and <c>INSTALL</c> for the package</dt>
+  <dd>
+    They usually also contain useful information about building and installing
+    packages
+  </dd>
+  <dt>
+    Remember non-binary dependencies such as pkg-config, doc generation
+    programs, etc.
+  </dt>
+  <dd>
+    Usually the build process requires some dependencies such as intltool,
+    libtool, pkg-config, doxygen, scrollkeeper, gtk-doc, etc. Make sure those
+    are clearly stated.
+  </dd>
+</dl>
+
+</body>
+</section>
+
 <section>
 <title>Implicit System Dependency</title>
 <body>