From f16061e021a43a0e0c4a6772f0887c0a212dd724 Mon Sep 17 00:00:00 2001 From: David Bauer Date: Sat, 26 Jun 2021 02:20:04 +0200 Subject: [PATCH] docs: replace ar71xx occurences with ath79 Replace occurences of ar71xx with ath79. Remove references of ar71xx targets which are not relevant anymore. --- docs/dev/hardware.rst | 11 ++++------- docs/features/autoupdater.rst | 4 ++-- docs/user/getting_started.rst | 6 +++--- docs/user/site.rst | 2 +- 4 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/dev/hardware.rst b/docs/dev/hardware.rst index c5200eb6..3be55703 100644 --- a/docs/dev/hardware.rst +++ b/docs/dev/hardware.rst @@ -34,8 +34,8 @@ The ``tiny`` device-class contains devices with the following limitations: Adding profiles --------------- -The vast majority of devices with ath9k WLAN is based on the ar71xx target of OpenWrt. -If the hardware you want to add support for is ar71xx, adding a new profile +The vast majority of devices with ath9k WLAN is based on the ath79 target of OpenWrt. +If the hardware you want to add support for is ath79, adding a new profile is sufficient. Profiles are defined in ``targets/*`` in a shell-based DSL (so common shell @@ -155,10 +155,7 @@ Build system support '''''''''''''''''''' A definition for the new target must be created under ``targets``, and it must be added -to ``targets/targets.mk``. The ``GluonTarget`` macro takes one to three arguments: -the target name, the Gluon subtarget name (if the target has subtargets), and the -OpenWrt subtarget name (if it differs from the Gluon subtarget). The third argument -can be used to define multiple Gluon targets with different configuration for the -same OpenWrt target, like it is done for the ``ar71xx-tiny`` target. +to ``targets/targets.mk``. The ``GluonTarget`` macro takes one to two arguments: +the target name and the OpenWrt subtarget name. After this, is should be sufficient to call ``make GLUON_TARGET=`` to build the images for the new target. diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst index 1d4c65bb..6e011245 100644 --- a/docs/features/autoupdater.rst +++ b/docs/features/autoupdater.rst @@ -61,9 +61,9 @@ A fully automated nightly build could use the following commands: git pull # git -C site pull make update - make clean GLUON_TARGET=ar71xx-generic + make clean GLUON_TARGET=ath79-generic NUM_CORES_PLUS_ONE=$(expr $(nproc) + 1) - make -j$NUM_CORES_PLUS_ONE GLUON_TARGET=ar71xx-generic GLUON_RELEASE=$GLUON_RELEASE \ + make -j$NUM_CORES_PLUS_ONE GLUON_TARGET=ath79-generic GLUON_RELEASE=$GLUON_RELEASE \ GLUON_AUTOUPDATER_BRANCH=experimental GLUON_AUTOUPDATER_ENABLED=1 make manifest GLUON_RELEASE=$GLUON_RELEASE GLUON_AUTOUPDATER_BRANCH=experimental contrib/sign.sh $SECRETKEY output/images/sysupgrade/experimental.manifest diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst index 3cca4267..e22a11a5 100644 --- a/docs/user/getting_started.rst +++ b/docs/user/getting_started.rst @@ -84,14 +84,14 @@ Next go back to the top-level Gluon directory and build Gluon:: cd .. make update # Get other repositories used by Gluon - make GLUON_TARGET=ar71xx-generic # Build Gluon + make GLUON_TARGET=ath79-generic # Build Gluon In case of errors read the messages carefully and try to fix the stated issues (e.g. install missing tools not available or look for Troubleshooting_ in the wiki. .. _Troubleshooting: https://github.com/freifunk-gluon/gluon/wiki/Troubleshooting -``ar71xx-generic`` is the most common target and will generate images for most of the supported hardware. +``ath79-generic`` is the most common target and will generate images for most of the supported hardware. To see a complete list of supported targets, call ``make`` without setting ``GLUON_TARGET``. To build all targets use a loop like this:: @@ -124,7 +124,7 @@ Cleaning the build tree There are two levels of `make clean`:: - make clean GLUON_TARGET=ar71xx-generic + make clean GLUON_TARGET=ath79-generic will ensure all packages are rebuilt for a single target. This is usually not necessary, but may fix certain kinds of build failures. diff --git a/docs/user/site.rst b/docs/user/site.rst index 408cf455..a3d221c4 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -102,7 +102,7 @@ opkg \: optional - ``%d`` is replaced by the OpenWrt distribution name ("openwrt") - ``%v`` is replaced by the OpenWrt version number (e.g. "17.01") - - ``%S`` is replaced by the target board (e.g. "ar71xx/generic") + - ``%S`` is replaced by the target board (e.g. "ath79/generic") - ``%A`` is replaced by the target architecture (e.g. "mips_24kc") - ``%GS`` is replaced by the Gluon site code (as specified in ``site.conf``) - ``%GV`` is replaced by the Gluon version