public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
Date: Mon, 25 May 2020 15:43:27 +0000 (UTC)	[thread overview]
Message-ID: <1589022379.3dc3be9929eaa97576882ab23ac02d9f51368f2d.ulm@gentoo> (raw)

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>


             reply	other threads:[~2020-05-25 15:43 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-25 15:43 Ulrich Müller [this message]
  -- strict thread matches above, loose matches on Subject: below --
2025-06-21 16:35 [gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/ Ulrich Müller
2024-09-28 19:36 Ulrich Müller
2023-09-27  8:30 Ulrich Müller
2022-06-24  9:14 Ulrich Müller
2022-05-27  9:00 Ulrich Müller
2022-05-22  6:37 Joonas Niilola
2022-05-22  6:37 Joonas Niilola
2022-02-21  5:22 Sam James
2022-02-21  5:22 Sam James
2021-10-19  9:27 Mike Frysinger
2021-10-13 13:42 Ulrich Müller
2021-03-29 20:44 Ulrich Müller
2021-03-29 20:44 Ulrich Müller
2021-03-29 20:44 Ulrich Müller
2021-03-11 12:44 Ulrich Müller
2021-03-11 12:44 Ulrich Müller
2021-03-11 12:44 Ulrich Müller
2020-05-25 15:43 Ulrich Müller
2020-01-29  7:59 Ulrich Müller
2020-01-29  7:59 Ulrich Müller
2020-01-29  7:59 Ulrich Müller
2020-01-23  7:47 Ulrich Müller
2019-12-21  5:19 Ulrich Müller
2019-10-16 18:49 Göktürk Yüksek
2018-09-10 15:20 Mike Gilbert
2017-09-25  4:31 Göktürk Yüksek
2017-09-25  4:31 Göktürk Yüksek
2017-09-25  4:31 Göktürk Yüksek
2014-10-18 17:40 Markos Chandras
2013-07-29 21:53 Julian Ospald
2013-07-29 21:53 Julian Ospald
2011-02-17 21:08 Jeremy Olexa

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1589022379.3dc3be9929eaa97576882ab23ac02d9f51368f2d.ulm@gentoo \
    --to=ulm@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox