Changeset 2370

Timestamp:

04/17/07 17:12:25 (2 years ago)

Author:

n0-1

Message:

Ok, this is the drawback of integrating new functionalities:
in the end it is always a lot more work than one expected. :)

So as requested, here comes the big documentation. To prevent
screen flooding, I split everything up into three parts:
* general make targets
* package specific targets (though generic in some way)
* package maintainers target(s)

The only maintainer target is 'update-patches', but as the most
complicated part of using it is to know how, this should fit
into a separate target. (And will hopefully grow in the future.)

Files:

• trunk/freewrt/Makefile (modified) (2 diffs)

trunk/freewrt/Makefile

@@ -31 +31 @@
-        @echo '  allnoconfig  - New config where all options are answered with no'
-        @echo ''
+        @echo 'Help targets:'
+        @echo '  help         - Print this help text'
+        @echo '  pkg-help     - Print help about selectively compiling single packages'
+        @echo '  dev-help     - Print help for developers / package maintainers'
+        @echo ''
-        @echo 'Other generic targets:'
-        @echo '  all          - Build everything as specified in .config'
-        @echo '                 (default if .config exists)'
-        @echo '  v            - Same as "all" but with logging to make.log enabled'
-
+
+
-        @echo 'Package specific targets (use with "package=<pkg-name>" parameter):'
-        @echo '  fetch        - Download the necessary distfile'
@@ -43 +49 @@
-        @echo '  fake         - Same as "build", but also install the binaries'
-        @echo '  package      - Same as "fake", but also create the ipkg package'
+        @echo ''
+        @echo 'Short package rebuilding guide:'
+        @echo '  run "make package=<pkgname> clean" to remove all generated binaries'
+        @echo '  run "make package=<pkgname> package" to build everything and create the ipkg'
+        @echo ''
+        @echo 'BEWARE: as for now, this does not resolve package dependencies!'
+
+dev-help:
+        @echo 'Fast way of updating package patches:'
+        @echo '  run "make package=<pkgname> clean" to start with a good base'
+        @echo '  run "make package=<pkgname> patch" to fetch, unpack and patch the source'
+        @echo '  edit the package sources at build_dir/<pkgname>/<pkgname>-<version>'
+        @echo '  run "make package=<pkgname> update-patches to update the existing patches (if any)'
+        @echo ''
+        @echo 'Each changed patches will be opened with your $$EDITOR,'
+        @echo 'so you can add a description and verify the changes.'
+
-
-clean: .prereq_done