summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBernhard Reutner-Fischer <rep.dot.nop@gmail.com>2007-01-19 09:47:29 +0000
committerBernhard Reutner-Fischer <rep.dot.nop@gmail.com>2007-01-19 09:47:29 +0000
commit8bcbd3d86c7b2587eb1f9ebdf0b703da86af8517 (patch)
treedb9aac988ca5851b3bcdc4c23cbbfb4223b2f0b3 /docs
parent5fada5248a8db94ddd7594f5fc6c7ea5b4303253 (diff)
- Correct some typos
- Add some more explanation to the -clean and -dirclean targets
Diffstat (limited to 'docs')
-rw-r--r--docs/buildroot.html31
1 files changed, 19 insertions, 12 deletions
diff --git a/docs/buildroot.html b/docs/buildroot.html
index c2e3eeabf..317fb3383 100644
--- a/docs/buildroot.html
+++ b/docs/buildroot.html
@@ -36,7 +36,7 @@
<li><a href="#downloaded_packages">Location of downloaded packages</a></li>
<li><a href="#add_software">Extending Buildroot with more
Software</a></li>
- <li><a href="#links">Ressources</a></li>
+ <li><a href="#links">Resources</a></li>
</ul>
<h2><a name="about" id="about"></a>About Buildroot</h2>
@@ -455,9 +455,9 @@ config BR2_PACKAGE_FOO
4 #
5 #############################################################
6 FOO_VERSION:=1.0
- 7 FOO_SOURCE:=less-$(FOO_VERSION).tar.gz
+ 7 FOO_SOURCE:=foo-$(FOO_VERSION).tar.gz
8 FOO_SITE:=http://www.foosoftware.org/downloads
- 9 FOO_DIR:=$(BUILD_DIR)/less-$(FOO_VERSION)
+ 9 FOO_DIR:=$(BUILD_DIR)/foo-$(FOO_VERSION)
10 FOO_BINARY:=foo
11 FOO_TARGET_BINARY:=usr/bin/foo
12
@@ -466,10 +466,10 @@ config BR2_PACKAGE_FOO
15
16 $(FOO_DIR)/.source: $(DL_DIR)/$(FOO_SOURCE)
17 $(ZCAT) $(DL_DIR)/$(FOO_SOURCE) | tar -C $(BUILD_DIR) $(TAR_OPTIONS) -
- 18 touch $(FOO_DIR)/.source
+ 18 touch $@
19
20 $(FOO_DIR)/.configured: $(FOO_DIR)/.source
- 21 (cd $(FOO_DIR); \
+ 21 (cd $(FOO_DIR); rm -rf config.cache ; \
22 $(TARGET_CONFIGURE_OPTS) \
23 CFLAGS="$(TARGET_CFLAGS)" \
24 ./configure \
@@ -479,7 +479,7 @@ config BR2_PACKAGE_FOO
28 --prefix=/usr \
29 --sysconfdir=/etc \
30 );
- 31 touch $(FOO_DIR)/.configured;
+ 31 touch $@
32
33 $(FOO_DIR)/$(FOO_BINARY): $(FOO_DIR)/.configured
34 $(MAKE) CC=$(TARGET_CC) -C $(FOO_DIR)
@@ -600,14 +600,21 @@ config BR2_PACKAGE_FOO
<p>Line 42 defines a simple target that only downloads the code
source. This is not used during normal operation of Buildroot, but
- might be useful.</p>
-
- <p>Lignes 44-46 define a simple target to clean the software build
- by calling the <i>Makefiles</i> with the appropriate option.</p>
+ is needed if you intend to download all required sources at once
+ for later offline build. Note that if you add a new package providing
+ a <code>foo-source</code> target is <i>mandatory</i> to support
+ users that wish to do offline-builds. Furthermore it eases checking
+ if all package-sources are downloadable.</p>
+
+ <p>Lines 44-46 define a simple target to clean the software build
+ by calling the <i>Makefiles</i> with the appropriate option.<br>
+ The <code>clean</code> target should run <code>make clean</code>
+ on $(BUILD_DIR)/package-version and MUST uninstall all files of the
+ package from $(STAGING_DIR) and from $(TARGET_DIR).</p>
<p>Lines 48-49 define a simple target to completely remove the
directory in which the software was uncompressed, configured and
- compiled.</p>
+ compiled. This target MUST completely rm $(BUILD_DIR)/package-version.</p>
<p>Lines 51-58 adds the target <code>foo</code> to the list
of targets to be compiled by Buildroot by first checking if
@@ -630,7 +637,7 @@ config BR2_PACKAGE_FOO
<p>If you package software that might be useful for other persons,
don't forget to send a patch to Buildroot developers !</p>
- <h2><a name="links" id="links"></a>Ressources</h2>
+ <h2><a name="links" id="links"></a>Resources</h2>
<p>To learn more about Buildroot you can visit these
websites:</p>