From b44a02773e069d98bd1b1f3201e3a66df1101e4b Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sat, 14 Mar 2015 19:20:11 +0100 Subject: [PATCH] docs: adjust to new target handling --- docs/features/autoupdater.rst | 2 +- docs/user/getting_started.rst | 23 +++++++++++------------ 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst index acd1adf4..388cc478 100644 --- a/docs/features/autoupdater.rst +++ b/docs/features/autoupdater.rst @@ -28,7 +28,7 @@ A fully automated nightly build could use the following commands: (cd site && git pull) make update make clean - make -j5 GLUON_BRANCH=experimental + make -j5 GLUON_TARGET=ar71xx-generic GLUON_BRANCH=experimental make manifest GLUON_BRANCH=experimental contrib/sign.sh $SECRETKEY images/sysupgrade/experimental.manifest diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst index ba5d5be4..14848af6 100644 --- a/docs/user/getting_started.rst +++ b/docs/user/getting_started.rst @@ -63,16 +63,14 @@ directory and build Gluon: :: cd .. - make update # Get other repositories used by Gluon - make # Build Gluon + make update # Get other repositories used by Gluon + make GLUON_TARGET=ar71xx-generic # Build Gluon -When calling make, the OpenWRT build environment is prepared/updated. +When calling make, the OpenWrt build environment is prepared/updated. In case of errors read the messages carefully and try to fix the stated issues (e.g. install tools not available yet). -To rebuild the images only, just use: -:: - - make images +``ar71xx-generic`` is the most common target and will generated images for most of the supported hardware. +To see a complete list of supported targets, call ``make`` without setting ``GLUON_TARGET``. The built images can be found in the directory `images`. Of these, the factory images are to be used when flashing from the original firmware a device came with, @@ -88,9 +86,9 @@ There are two levels of `make clean`: :: - make clean + make clean GLUON_TARGET=ar71xx-generic -will ensure all packages are rebuilt; this is what you normally want to do after an update. +will ensure all packages are rebuilt for a single target; this is what you normally want to do after an update. :: @@ -115,12 +113,13 @@ GLUON_BUILDDIR Working directory during build. Defaults to ``build/``. -So all in all, to update and rebuild a Gluon build tree, the following commands should be used: +So all in all, to update and rebuild a Gluon build tree, the following commands should be used (repeat the +``make clean`` and ``make`` for all targets you want to build): :: git pull (cd site && git pull) make update - make clean - make + make clean GLUON_TARGET=ar71xx-generic + make GLUON_TARGET=ar71xx-generic