Commit Graph

71 Commits

Author SHA1 Message Date
Matthias Schiffer efb4a4f637
docs: user/getting_started: add a footnote regarding `make update`
Add some explanation when `make update` needs to be run again.
2021-12-31 02:50:23 +01:00
Matthias Schiffer 854fef4e12
docs: consistently indent .rst files with 2 spaces
2 spaces is the most common indentation width used in the docs; adjust
the rest for consistency.

Also change .editorconfig accordingly.
2021-12-24 14:16:04 +01:00
Matthias Schiffer 1c89f616a9 build: add support for .scmversion files for GLUON_VERSION and GLUON_SITE_VERSION
Sometimes it is useful to override the default version detection, for
example when local patches are applied to a repo. Allow providing a
version number using a file called .scmversion, which is the same that
the Linux kernel and U-Boot use.
2021-10-07 23:42:38 +02:00
lemoer d4dee692c6
contrib: add push_pkg.sh to enhance package development workflow (v2) (#2023)
v2: In contrast to the last patches, this is now built on top of ssh
    only, without using e.g. 9pfs. Furthermore it works also with
    arbitary remote hosts on any target/architecture. Also the
    scripts were renamed and moved to /scripts.

The aim of this commit is to allow fast rebuild cycles during the
development of gluon packages.

Currently the following workflow can be used:

	# start a local qemu instance
	scripts/run_qemu.sh output/images/factory/[...].img

	# do your changes in the file you want to patch
	vi package/gluon-ebtables/files/etc/init.d/gluon-ebtables

	# rebuild and update the package
	scripts/push_pkg.sh package/gluon-ebtables/

	# test your changes
	...

	# do more changes
	...

	# rebuild and update the package
	scripts/push_pkg.sh package/gluon-ebtables/

	# test your changes
	...

	(and so on...)

Implementation details:
- Currently this is based on ssh/scp.
- Opkg is used to install/update the packages in the remote machine.

Benefits:
- This works with compiled and non-compiled packages.
- This works with native OpenWrt and Gluon packages.
- This even performs the check_site.lua checks as they are integrated
  as post_install scripts into the openwrt package.
- It works for all architectures/targets.
2021-07-23 19:50:15 +02:00
David Bauer 9c60b455c9 docs: hardware: fix minor grammar issue 2021-06-26 22:55:03 +02:00
David Bauer f16061e021 docs: replace ar71xx occurences with ath79
Replace occurences of ar71xx with ath79. Remove references of ar71xx
targets which are not relevant anymore.
2021-06-26 02:20:08 +02:00
aiyion.prime 9303297b35 docs: add 'make refresh-patches' 2021-05-27 11:25:31 +02:00
Matthias Schiffer 13b743d51e features: fix handling of logical expressions
The rewrite of the feature handling introduced multiple major bugs. One
of them was caused by the way Lua's logical operators work:

An expression of the form

    _'autoupdater' and _'web-advanced'

would return 'web-advanced' rather than the boolean true when _ returned
both strings unchanged (because the features are enabled).

As entries with more than a single feature name in their expressions did
not set no_default, Gluon would then attempt to add gluon-web-advanced to
the package selection, as web-advanced is a "pure" feature.

To fix this, and get rid of the annoying nodefault, separate handling of
"pure" feature and handling of logical expressions into two separate
functions, called feature() and when(). To simplify the feature
definitions, the package list is now passed directly to these functions
rather than in a table with a single field 'packages'.

Fixes: ee5ec5afe5 ("build: rewrite features.sh in Lua")
2020-08-28 22:27:38 +02:00
bobcanthelpyou 2ad473bcd4
docs: fix small typos and use common used notation (#2088) 2020-08-13 13:25:45 +02:00
Matthias Schiffer ee5ec5afe5 build: rewrite features.sh in Lua
The `features` file is converted to a Lua-based DSL.

A helper function `_` is used in the DSL; this will return the original
string for enabled features, and nil for disabled features. This allows
to use boolean operations on features without making the code too
verbose.

Besides having more readable and robust code, this also fixes the bug
that all files `packages/*/features` were evaluated instead of only
using the feature definitions of currently active feeds.
2020-07-01 20:35:22 +02:00
Chrissi^ (Chris Fiege) 1956696da5
openwrt: Store Kernel Debug-Info (#1971)
This change stores a Kernel with Debug-Symbols for the current
architecture in a new output directory '<outputdir>/debug'.
This allows a developer or operator of a network to store the kernel
along with the actual images. In case of a kernel oops the debug
information can be used with the script
'scripts/decode_stacktrace.sh' in the kernel source tree to get the
names to the symbols of the stack trace.

OpenWRT already provides the CONFIG_COLLECT_KERNEL_DEBUG -option that
creates a kernel with debug-symbols in the OpenWRT output directory.
This change enables this option and copies the generated kernel to the
gluon output directory.

Signed-off-by: Chrissi^ <chris@tinyhost.de>
2020-06-04 22:35:58 +02:00
Sven Roederer 5e35fa1ac4
docs/build: add a short summary for some scripts
This summaries giving an overview of a scripts function and a short summary
how it's doing this. Only the scripts are covered, that are used by the
Freifunk-Berlin firmwarebuiler too.

[Matthias Schiffer: slightly reworded some descriptions]
2020-05-31 23:44:34 +02:00
David Bauer daf8a6c18c docs: dev: add link to device checklist
Closes #1993
2020-05-02 16:15:31 +02:00
David Bauer c4d70f29e6 docs: dev: add OWE MAC-assignment
Fixes commit 6692095f9d
2020-04-11 15:13:57 +02:00
Matthias Schiffer 4e02d9ba9f docs: start doc page on the build system 2020-04-09 14:30:44 +02:00
David Bauer 7903d9eb64 docs: add device-classes 2020-03-25 02:05:18 +01:00
Martin Weinelt 1c2dc51b76
add .editorconfig (#1951)
Resolves #1929
2020-03-08 19:18:17 +01:00
David Bauer 25a4f3b816 docs: add mt76 to supported chipsets (#1870)
The docs previously only listed ath9k and ath10k based chipsets as fully
supported by Gluon, however we also support mt76.
2019-12-28 18:40:33 +01:00
David Bauer ea34bc757c docs: clarify WAN port on LAN-only devices
At the December 2019 review day, the behavior for LAN only devices was
defined. Such devices will use each LAN port as WAN.
2019-12-06 18:29:19 +01:00
Matthias Schiffer ed8cd9c0f7 docs: update for reflect dropped IBSS support 2019-11-07 19:48:16 +01:00
Chrissi^ (Chris Fiege) 9dfaed000c doc/dev/package: Fix path to gluon.mk (#1774)
$(TOPDIR) does not contain a trailing slash.
Thus the 'gluon.mk'-include must include
the trailing slash. (Just like the link to
$(INCLUDE_DIR)/package.mk does.)

Signed-off-by: Chris Fiege <chris@tinyhost.de>
2019-06-29 23:41:07 +02:00
rubo77 2541d0a0e2 docs: Add information how to automatically check your code with luacheck 2019-06-26 23:30:17 +02:00
lrnzo d42705f36a docs: update upgrade.rst
small grammatical fix
2019-06-24 13:37:06 +02:00
bobcanthelpyou ff7aeafad2 docs: fix typos and small text improvements 2019-04-02 02:32:50 +02:00
bobcanthelpyou cae79eb074 docs: add new <%| tag for escaped expressions (#1683)
the tag was added by dd23a805c2
2019-03-23 18:37:49 +01:00
bobcanthelpyou 170c494f40 docs: fix typos and common misspellings (#1668) 2019-03-10 20:15:25 +01:00
Martin Weinelt 9f7276cdd6 docs: improve references to the IRC chatroom (#1643) 2019-02-07 01:53:18 +01:00
Matthias Schiffer 688de03db2
docs: dev/web: update model/view/controller paths
Fixes #1491
2018-08-15 19:31:43 +02:00
Matthias Schiffer 210d97c53e
Switch to OpenWrt 18.06 branch 2018-07-10 22:57:40 +02:00
Matthias Schiffer 6a5e67b383
docs: add documentation for site library 2018-07-07 11:43:37 +02:00
Matthias Schiffer b2436f674b
docs: add new doc page about package development
Explain the magic of gluon.mk. The feature flag documention is moved into
this new page.
2018-06-23 19:44:43 +02:00
Matthias Walther 4aa6dce17a docs: hardware.rst: explain how to get the image name for a new device (#1335) 2018-03-12 03:28:28 +01:00
Matthias Schiffer 4ba7356a24
docs: dev/web: update i18n docs 2018-02-23 14:05:32 +01:00
Matthias Schiffer 0cb4cfdadf
docs: dev/hardware: remove some outdated info, reword a bit 2018-01-19 14:17:33 +01:00
lrnzo 0b4cbec0e9
docs: change group name gluon-fastd to gluon-mesh-vpn
The group was renamed during the development of Gluon v2017.1, adjust the
documentation accordingly.
2017-10-22 20:34:05 +02:00
Matthias Schiffer 9ae2be7b55
docs: dev/feature-flags: fix a few typos 2017-07-09 02:35:06 +02:00
Matthias Schiffer 6ca841bad5
build: introduce GLUON_FEATURES
To reduce the number of packages that need to be listed in
GLUON_SITE_PACKAGES, this adds a new variable GLUON_FEATURES. Sets of
packages are enabled automatically based on the combination of listed
feature flags.

Site-specified package feeds can provide their own feature flag
definitions.
2017-07-09 02:31:38 +02:00
kb-light c90e13594a docs: dev/web/model: fix typo (#1152) 2017-06-24 19:25:12 +02:00
Matthias Schiffer 606e8490d3
docs: dev/upgrade: some minor text improvements 2017-06-08 20:59:57 +02:00
Matthias Schiffer 4ca67dcca5
gluon-mesh-batman-adv-*: unify into a single source package
For simplicity, we don't use different MTUs for compat 14 and 15 anymore,
there's no harm in using 1532 for batman-adv-legacy as well.
2017-04-12 04:22:45 +02:00
lrnzo 54e271ad99 docs: dev/web/i18n: fix typo (#1068) 2017-03-12 00:49:56 +01:00
Matthias Schiffer 568ba483bb
docs: dev/web/view: fix a typo 2017-02-24 15:22:27 +01:00
Matthias Schiffer 1d7b4482b7
gluon-web: add renderer._translate()
_translate() will return nil when no match is found.
2017-02-22 19:28:22 +01:00
Matthias Schiffer 22746a2a0d
docs: add documentation for gluon-web 2017-02-22 01:32:19 +01:00
Matthias Schiffer 31d3f08f25
treewide: convert all LuCI-based packages to gluon-web 2017-02-22 01:31:25 +01:00
Matthias Schiffer 0775bf76aa
docs: dev/hardware: update libplatforminfo instructions 2017-02-12 06:11:43 +01:00
Matthias Schiffer 78b2775eec
Use LEDE as base for Gluon 2017-01-18 17:21:43 +01:00
Christof Schulze 4a1b47de45 docs: dev/basics: add rules for coding guide (#970)
* use tabs instead of spaces
* use jsonfilter for speed
2016-12-08 23:56:43 +01:00
Christof Schulze 54109702bd docs: add development guide including one first guideline wrt lua vs. sh usage (#951) 2016-11-29 20:45:25 +01:00
Matthias Schiffer 3ac9d34c49
docs: dev/basics: remove outdated docs about patch and unpatch commands 2016-11-19 17:34:19 +01:00