Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCHv3 for-2012.11 5/5] manual: restructure 'Adding packages' chapter
Date: Tue, 27 Nov 2012 22:59:20 +0100	[thread overview]
Message-ID: <1354053560-30352-5-git-send-email-arnout@mind.be> (raw)
In-Reply-To: <1354053560-30352-1-git-send-email-arnout@mind.be>

From: "Arnout Vandecappelle (Essensium/Mind)" <arnout@mind.be>

The depends-on-vs-select part of the manual really deserves its own
section title (especially because it is referred to and the xref gets
a 'sinpara' in PDF if the section doesn't have a title). So restructure
the surrounding sections to reduce the section nesting depth.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Acked-by: Samuel Martin <s.martin49@gmail.com>
---
 docs/manual/adding-packages-directory.txt |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 5903ed1..5d17aac 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -11,11 +11,11 @@ Some packages have been grouped by topic in a sub-directory:
 one of these categories, then create your package directory in these.
 New subdirectories are discouraged, however.
 
 
 +Config.in+ file
-^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~
 
 Then, create a file named +Config.in+. This file will contain the
 option descriptions related to our +libfoo+ software that will be used
 and displayed in the configuration tool. It should basically contain:
 
@@ -49,10 +49,13 @@ supposed to contain anything but the 'bare' name of the package.
 --------------------------
 source "package/libfoo/Config.in"
 --------------------------
 
 [[depends-on-vs-select]]
+Choosing +depends on+ or +select+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 The +Config.in+ file of your package must also ensure that
 dependencies are enabled. Typically, Buildroot uses the following
 rules:
 
 * Use a +select+ type of dependency for dependencies on
@@ -162,11 +165,11 @@ package.
 
 Further formatting details: see xref:writing-rules-config-in[the
 coding style].
 
 The +.mk+ file
-^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~
 
 Finally, here's the hardest part. Create a file named +libfoo.mk+. It
 describes how the package should be downloaded, configured, built,
 installed, etc.
 
-- 
1.7.10.4

  parent reply	other threads:[~2012-11-27 21:59 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-27 21:59 [Buildroot] [PATCHv3 for-2012.11 1/5] manual: trivial fixes Arnout Vandecappelle
2012-11-27 21:59 ` [Buildroot] [PATCHv3 for-2012.11 2/5] manual: various fixes Arnout Vandecappelle
2012-11-27 22:39   ` Samuel Martin
2012-11-27 22:51     ` Samuel Martin
2012-11-27 21:59 ` [Buildroot] [PATCHv3 for-2012.11 3/5] manual: more warnings to not use output/target Arnout Vandecappelle
2012-11-27 21:59 ` [Buildroot] [PATCHv3 for-2012.11 4/5] manual: give example where _INSTALL_TARGET = NO Arnout Vandecappelle
2012-11-27 21:59 ` Arnout Vandecappelle [this message]
2012-11-28  1:10 ` [Buildroot] [PATCHv3 for-2012.11 1/5] manual: trivial fixes Peter Korsgaard

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=1354053560-30352-5-git-send-email-arnout@mind.be \
    --to=arnout@mind.be \
    --cc=buildroot@busybox.net \
    /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