summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Petazzoni <thomas.petazzoni@free-electrons.com>2011-11-13 08:54:44 (GMT)
committer Peter Korsgaard <jacmet@sunsite.dk>2011-11-13 20:28:11 (GMT)
commitd031a031bdfbccec41a5d7c4c566765b4bb4b6a5 (patch)
tree04816a38c88ca1f219a22c12c6e17a0e894ebf61
parent939d0ab264bea00f18cb6085547580df43c50653 (diff)
downloadbuildroot-d031a031bdfbccec41a5d7c4c566765b4bb4b6a5.tar.gz
buildroot-d031a031bdfbccec41a5d7c4c566765b4bb4b6a5.tar.bz2
doc: mention how to format the Config.in file
[Peter: s/but/should as suggested by Michael S. Zick] Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
-rw-r--r--docs/manual/adding-packages-directory.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index a262a8c..2e8786a 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -24,6 +24,11 @@ config BR2_PACKAGE_LIBFOO
http://foosoftware.org/libfoo/
---------------------------
+The +bool+ line, +help+ line and other meta-informations about the
+configuration option must be indented with one tab. The help text
+itself should be indented with one tab and two spaces, and it must
+mention the upstream URL of the project.
+
Of course, you can add other sub-options into a +if
BR2_PACKAGE_LIBFOO...endif+ statement to configure particular things
in your software. You can look at examples in other packages. The