summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMarc Kleine-Budde <mkl@pengutronix.de>2003-10-23 15:01:19 +0000
committerMarc Kleine-Budde <mkl@pengutronix.de>2003-10-23 15:01:19 +0000
commita8ad8f5b6429e82b659f2f11548f68bcb353b00a (patch)
tree2dbd95fd14619c038a721d6414ada33a256caeb9 /Documentation
parent091ef762efcd334a15a7785fbf82e2c393d665ec (diff)
downloadptxdist-a8ad8f5b6429e82b659f2f11548f68bcb353b00a.tar.gz
ptxdist-a8ad8f5b6429e82b659f2f11548f68bcb353b00a.tar.xz
* merge with testing-branch
git-svn-id: https://svn.pengutronix.de/svn/ptxdist/trunk@608 33e552b5-05e3-0310-8538-816dae2090ed
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/NEWPACKETHOWTO90
-rw-r--r--Documentation/README9
2 files changed, 99 insertions, 0 deletions
diff --git a/Documentation/NEWPACKETHOWTO b/Documentation/NEWPACKETHOWTO
new file mode 100644
index 000000000..4c1c33cb0
--- /dev/null
+++ b/Documentation/NEWPACKETHOWTO
@@ -0,0 +1,90 @@
+PTXdist
+How to add a new packet to the building tree
+============================================
+
+General notes
+-------------
+
+The script rules/NEWPACKET; it asks you some basic questions and
+spits out a makefile for your packet which has the major stuff in place
+and can easily be adapted to your needs afterwards.
+
+The basic idea is that Makefile, rules/Rules.make and rules/*.make are
+all one big makefile (included by Makefile). So you can make some target
+being dependend on every other target of the system. Just find out what
+you need in order to build something and add it to the list of
+dependencies.
+
+Then you have the configuration system: it all starts with
+config/Config.in, which will be split up in the future. For some packets
+it follows the "new" scheme to include rules/foobar.in files for the
+packets.
+
+NEWPACKET just takes rules/template.make and fills in the stuff you
+enter. You have to add config options for your packets, either in
+config/Config.in or - better - just add a source entry there and add
+your options in rules/foobar.in.
+
+
+Steps
+-----
+
+A. use script rules/NEWPACKET to add a new packet (example NewToolName)
+B. rules/NewToolName.in
+C. config/Config.in
+
+
+
+Example
+-------
+
+In this example we are going to add a new packet into the
+menu "Graphics Libraries "
+
+1.---------
+Edit rules/NewToolName.in and modify the entries you want to see
+when configuring
+
+menu "NewToolName-2.1.0 "
+config NEWTOOLNAME
+ bool
+ prompt "Compile NewToolName"
+endmenu
+
+2.---------
+Edit config/Config.in
+
+menu "Graphics Libraries "
+
+source rules/xfree430.in
+source rules/clementine.in
+source rules/NewToolName.in
+
+endmenu
+
+
+Caution
+-------
+If you perform a manual compilation (like me)
+
+$ make xconfig
+$ make extract
+$ make prepare
+$ make compile
+$ make install
+
+bear in mind that each make step is conditioned by the existence of the
+correspondent touched file in the directory state.
+So you get these three files after these steps
+state/NewToolName.extract
+state/NewToolName.prepare
+state/NewToolName.compile
+
+If you need a modulr rebuild you need simply to delete the file corresponding
+to the desired step.
+
+
+
+03-10-2003
+Marco Cavallini <m.cavallini@koansoftware.com>
+
diff --git a/Documentation/README b/Documentation/README
index 154f2fcc7..8f8ea03de 100644
--- a/Documentation/README
+++ b/Documentation/README
@@ -20,4 +20,13 @@ the kernel is started. PTXdist takes care of changes in the kernels
.config files, it is copied from and to the specified config file.
+Developement - new Packets
+--------------------------
+When adding a new packet to ptxdist which requires a patch, you'd like
+to use $(call get_patches) and $(call patchin), but you can't, because
+the patch isn't in the public repository yet.
+
+So, here's a patch against 'ptxdist-testing-20031001-1.tar.bz2' that
+adds a local repository called patches-local; patches in there are
+applied after those from the public repository.