From: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 13/13] Document BR2_PROJECT_DIR in the manual
Date: Sun, 14 Oct 2012 01:14:53 +0200 [thread overview]
Message-ID: <20121013231453.17317.66287.stgit@localhost> (raw)
In-Reply-To: <20121013231344.17317.92930.stgit@localhost>
From: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
---
docs/manual/customize-project.txt | 37 +++++++++++++++++++++++++++++++++++++
docs/manual/customize.txt | 2 ++
2 files changed, 39 insertions(+)
create mode 100644 docs/manual/customize-project.txt
diff --git a/docs/manual/customize-project.txt b/docs/manual/customize-project.txt
new file mode 100644
index 0000000..db6b757
--- /dev/null
+++ b/docs/manual/customize-project.txt
@@ -0,0 +1,37 @@
+Storing the configuration in a project directory
+------------------------------------------------
+[[project-dir]]
+
+When you use buildroot in different projects, it's a good idea to keep
+each project separate from buildroot itself. Buildroot makes this
+possible with the +BR2_PROJECT_DIR+ option. The project directory
+contains all the configuration files and the filesystem overlay for
+your project.
+
+After configuring buildroot, the linux kernel, etc., run the following
+command.
+
+--------------------
+make PROJECT_DIR=/path/to/project/dir projectdir
+--------------------
+
+This will create the directory +/path/to/project/dir+, which contains
+the buildroot configuration, and all other configuration files required
+to rebuild your system.
+
+To further customize your project, you can:
+
+* add a directory called +rootfs-overlay+ and fill it with additional
+ files and directories that should be installed in the root filesystem
+ (see xref:customize-rootfs[+BR2_ROOTFS_OVERLAY+]);
+
+* add a script called +post-build.sh+ to modify the root filesystem
+ (see xref:customize-rootfs[+BR2_ROOTFS_POST_BUILD_SCRIPT+]);
+
+* add a makefile +project.mk+ with additional buildroot targets.
+
+In addition, the project directory contains a Makefile to allow you to
+build directly from there. This Makefile downloads and extracts
+buildroot, then builds everything according to your configuration. To
+avoid downloading buildroot, create a symbolic link to the buildroot
+directory in the project directory.
diff --git a/docs/manual/customize.txt b/docs/manual/customize.txt
index e8235de..86fc1fb 100644
--- a/docs/manual/customize.txt
+++ b/docs/manual/customize.txt
@@ -10,3 +10,5 @@ include::customize-uclibc-config.txt[]
include::customize-kernel-config.txt[]
include::customize-toolchain.txt[]
+
+include::customize-project.txt[]
next prev parent reply other threads:[~2012-10-13 23:14 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-10-13 23:13 [Buildroot] [PATCH 00/13] Add support for a project directory Arnout Vandecappelle
2012-10-13 23:13 ` [Buildroot] [PATCH 01/13] Add BR2_PROJECT_DIR config option Arnout Vandecappelle
2012-10-13 23:13 ` [Buildroot] [PATCH 02/13] Set default BR2_PACKAGE_OVERRIDE_FILE based on BR2_PROJECT_DIR Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 03/13] linux: get default paths from BR2_PROJECT_DIR Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 04/13] busybox: " Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 05/13] target/generic: " Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 06/13] toolchain-crosstool-ng: " Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 07/13] uClibc: " Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 08/13] Store BR2_DEFCONFIG in .config, and use it to update the original input Arnout Vandecappelle
2012-10-14 18:37 ` Thomas De Schampheleire
2012-10-13 23:14 ` [Buildroot] [PATCH 09/13] Skip menuconfig if BR2_DEFCONFIG or BR2_PROJECT_DIR is given Arnout Vandecappelle
2012-10-13 23:14 ` [Buildroot] [PATCH 10/13] Add update-all-config target Arnout Vandecappelle
2012-10-14 18:45 ` Thomas De Schampheleire
2012-10-20 16:47 ` Arnout Vandecappelle
2012-10-20 16:52 ` Arnout Vandecappelle
2012-12-03 14:18 ` Stephan Hoffmann
2012-12-03 16:41 ` Thomas Petazzoni
2012-10-13 23:14 ` [Buildroot] [PATCH 11/13] Add target to create a project directory Arnout Vandecappelle
2012-10-13 23:21 ` [Buildroot] [PATCH v2] " Arnout Vandecappelle
2012-10-13 23:35 ` Valentine Barshak
2012-10-14 12:50 ` Arnout Vandecappelle
2012-10-16 17:36 ` Valentine Barshak
2012-10-13 23:14 ` [Buildroot] [PATCH 12/13] target/generic: add filesystem overlay option Arnout Vandecappelle
2012-10-14 0:39 ` Danomi Manchego
2012-10-14 12:53 ` Arnout Vandecappelle
2012-10-14 16:12 ` Danomi Manchego
2012-10-14 18:50 ` Thomas De Schampheleire
2012-10-20 16:15 ` Arnout Vandecappelle
2012-10-13 23:14 ` Arnout Vandecappelle [this message]
2012-10-14 8:35 ` [Buildroot] [PATCH 00/13] Add support for a project directory Thomas Petazzoni
2012-10-14 8:46 ` Thomas Petazzoni
2012-10-14 10:43 ` Arnout Vandecappelle
2012-10-14 12:55 ` Thomas Petazzoni
2012-10-14 13:57 ` Arnout Vandecappelle
2012-10-16 20:03 ` Arnout Vandecappelle
2012-10-17 17:26 ` Thomas Petazzoni
2012-10-17 18:42 ` Sagaert Johan
2012-10-14 18:56 ` Thomas De Schampheleire
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=20121013231453.17317.66287.stgit@localhost \
--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