nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix and update make variable section

Browse Source
This commit is contained in:
Matthias Schiffer 2016-09-11 18:05:28 +02:00
parent 25907645b7
commit c3997455e8
No known key found for this signature in database
GPG Key ID: 16EF3F64CB201D9C
2 changed files with 64 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.rst
View File

@ -216,7 +216,7 @@ ar71xx-generic
.. [#ath10k] .. [#ath10k]
Device uses the ath10k WLAN driver; no image is built unless GLUON_ATH10K_MESH Device uses the ath10k WLAN driver; no image is built unless GLUON_ATH10K_MESH
is set as described in :ref:`getting-started-environment-variables` is set as described in :ref:`getting-started-make-variables`
ar71xx-nand ar71xx-nand
^^^^^^^^^^^ ^^^^^^^^^^^

95
docs/user/getting_started.rst
View File

@ -119,6 +119,17 @@ will ensure all packages are rebuilt for a single target; this is what you norma
will clean the entire tree, so the toolchain will be rebuilt as well, which is will clean the entire tree, so the toolchain will be rebuilt as well, which is
not necessary in most cases, and will take a while. not necessary in most cases, and will take a while.
So in summary, 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 GLUON_TARGET=ar71xx-generic
make GLUON_TARGET=ar71xx-generic
opkg repositories opkg repositories
----------------- -----------------
@ -148,36 +159,19 @@ When making firmware releases based on Gluon, it might make sense to store
the keypair, so updating the module repository later is possible. the keypair, so updating the module repository later is possible.
The location the keys are stored at and read from can be changed The location the keys are stored at and read from can be changed
(see :ref:`getting-started-environment-variables`). To only generate the keypair (see :ref:`getting-started-make-variables`). To only generate the keypair
at the configured location without doing a full build, use ``make create-key``. at the configured location without doing a full build, use ``make create-key``.
.. _getting-started-environment-variables: .. _getting-started-make-variables:
Environment variables Make variables
--------------------- --------------
Gluon's build process can be controlled by various environment variables. These variables can Gluon's build process can be controlled by various variables. They can
usually be set on the command line or in ``site.mk``. usually be set on the command line or in ``site.mk``.
GLUON_SITEDIR Common variables
Path to the site configuration. Defaults to ``site``. ................
GLUON_BUILDDIR
Working directory during build. Defaults to ``build``.
GLUON_OPKG_KEY
Path key file used to sign the module opkg repository. Defaults to ``$(GLUON_BULDDIR)/gluon-opkg-key``.
The private key will be stored as ``$(GLUON_OPKG_KEY)``, the public key as ``$(GLUON_OPKG_KEY).pub``.
GLUON_OUTPUTDIR
Path where output files will be stored. Defaults to ``output``.
GLUON_IMAGEDIR
Path where images will be stored. Defaults to ``$(GLUON_OUTPUTDIR)/images``.
GLUON_MODULEDIR
Path where the kernel module opkg repository will be stored. Defaults to ``$(GLUON_OUTPUTDIR)/modules``.
GLUON_ATH10K_MESH GLUON_ATH10K_MESH
While Gluon does support some hardware with ath10k-based 5GHz WLAN, these WLAN adapters don't work While Gluon does support some hardware with ath10k-based 5GHz WLAN, these WLAN adapters don't work
@ -187,14 +181,51 @@ GLUON_ATH10K_MESH
Setting GLUON_ATH10K_MESH to ``11s`` or ``ibss`` will enable generation of images for ath10k devices Setting GLUON_ATH10K_MESH to ``11s`` or ``ibss`` will enable generation of images for ath10k devices
and install the firmware for the corresponding WLAN mode. and install the firmware for the corresponding WLAN mode.
GLUON_BRANCH
Sets the default branch of the autoupdater. If unset, the autoupdater is disabled
by default. For the ``make manifest`` command, GLUON_BRANCH defines the branch to
generate a manifest for.
So all in all, to update and rebuild a Gluon build tree, the following commands should be used (repeat the GLUON_LANGS
``make clean`` and ``make`` for all targets you want to build): Space-separated list of languages to include for the config mode/advanced settings. Defaults to ``en``.
``en`` should always be included, other supported languages are ``de`` and ``fr``.
:: GLUON_PRIORITY
Defines the priority of an automatic update in ``make manifest``. See :doc:`../features/autoupdater` for
a detailed description of this value.
git pull GLUON_REGION
(cd site && git pull) Some devices (at the moment the TP-Link Archer C7) contain a region code that restricts
make update firmware installations. Set GLUON_REGION to ``eu`` or ``us`` to make the resulting
make clean GLUON_TARGET=ar71xx-generic images installable from the respective stock firmwares.
make GLUON_TARGET=ar71xx-generic
GLUON_RELEASE
Firmware release number: This string is displayed in the config mode, announced
via respondd/alfred and used by the autoupdater to decide if a newer version
is available.
GLUON_TARGET
Target architecture to build.
Special variables
.................
GLUON_BUILDDIR
Working directory during build. Defaults to ``build``.
GLUON_IMAGEDIR
Path where images will be stored. Defaults to ``$(GLUON_OUTPUTDIR)/images``.
GLUON_MODULEDIR
Path where the kernel module opkg repository will be stored. Defaults to ``$(GLUON_OUTPUTDIR)/modules``.
GLUON_OPKG_KEY
Path key file used to sign the module opkg repository. Defaults to ``$(GLUON_BULDDIR)/gluon-opkg-key``.
The private key will be stored as ``$(GLUON_OPKG_KEY)``, the public key as ``$(GLUON_OPKG_KEY).pub``.
GLUON_OUTPUTDIR
Path where output files will be stored. Defaults to ``output``.
GLUON_SITEDIR
Path to the site configuration. Defaults to ``site``.