Repository : ssh://git@open-mesh.org/doc
On branches: backup-redmine/2017-07-13,master
commit 9c9a23ebfb15941d1f50830bfd04ecb2d9f93057 Author: Marek Lindner mareklindner@neomailbox.ch Date: Thu Aug 26 14:44:05 2010 +0000
doc: batman-adv/Building-with-openwrt
9c9a23ebfb15941d1f50830bfd04ecb2d9f93057 batman-adv/Building-with-openwrt.textile | 141 +++++++++++++------------------ 1 file changed, 60 insertions(+), 81 deletions(-)
diff --git a/batman-adv/Building-with-openwrt.textile b/batman-adv/Building-with-openwrt.textile index 90bafed5..d8b846d7 100644 --- a/batman-adv/Building-with-openwrt.textile +++ b/batman-adv/Building-with-openwrt.textile @@ -1,177 +1,156 @@
+= Building B.A.T.M.A.N. Advanced with OpenWRT =
-h1. Building B.A.T.M.A.N. Advanced with [[OpenWRT]] +{{{ +#!div style="width: 46em; text-align: justify"
+Many tutorials assume that you have batman-adv running on an OpenWRT system without going into detail how to get the system built and configured. This documents aims to fill the gap by providing a step-by-step explanation how to get your OpenWRT system up & running.
-<pre> -<code class="div"> +=== Getting the OpenWRT build environment ===
-Many tutorials assume that you have batman-adv running on an [[OpenWRT]] system without going into detail how to get the system built and configured. This documents aims to fill the gap by providing a step-by-step explanation how to get your [[OpenWRT]] system up & running. +First, you need to obtain a copy of the OpenWRT build system which contains all the build information to compile & package a complete linux system. You can either checkout the last stable or the trunk directly from the OpenWRT SVN repository or get tarballs from the OpenWRT project website. We assume you intend to download the latest stable (backfire 10.03 at the point of writing this document) via SVN:
- -h3. Getting the [[OpenWRT]] build environment - - -First, you need to obtain a copy of the [[OpenWRT]] build system which contains all the build information to compile & package a complete linux system. You can either checkout the last stable or the trunk directly from the [[OpenWRT]] SVN repository or get tarballs from the [[OpenWRT]] project website. We assume you intend to download the latest stable (backfire 10.03 at the point of writing this document) via SVN: - -<pre> +{{{ svn co svn://svn.openwrt.org/openwrt/tags/backfire_10.03 openwrt -</code></pre> +}}}
Change into the openwrt-kamikaze directory and configure the system to meet you needs (e.g. choose the platform and additional packages you intend to use).
-<pre> +{{{ cd openwrt make menuconfig -</code></pre> - -+Note+: The batman-adv package is not there yet because it needs to be activated seperately (see the following steps). +}}}
+__Note__: The batman-adv package is not there yet because it needs to be activated seperately (see the following steps). [[BR]]
To build your images you always have to invoke the "make" command from within the openwrt folder:
-<pre> +{{{ cd openwrt make -</code></pre> - -The rest of the document will focus on the batman-adv package. It is assumed that you configured the system to work on your platform. If you require additional information on how to tweak your [[OpenWRT]] system, please see "the [[OpenWRT]] project website":http://www.openwrt.org. +}}}
+The rest of the document will focus on the batman-adv package. It is assumed that you configured the system to work on your platform. If you require additional information on how to tweak your OpenWRT system, please see [http://www.openwrt.org the OpenWRT project website].
-h3. Adding the batman-adv package +=== Adding the batman-adv package ===
+The standard OpenWRT package feed contains a batman-adv package which is intended to be used on a day to day basis, therefore it retrieves the latest batman-adv stable release. Since a lot of people want to experiment with the latest features or use OpenWRT to test their own batman-adv patches we also provide an openwrt package feed which contains the batman-adv development version.
-The standard [[OpenWRT]] package feed contains a batman-adv package which is intended to be used on a day to day basis, therefore it retrieves the latest batman-adv stable release. Since a lot of people want to experiment with the latest features or use [[OpenWRT]] to test their own batman-adv patches we also provide an openwrt package feed which contains the batman-adv development version. +__Adding the stable version__: [[BR]]
-+Adding the stable version+: - - -<pre> +{{{ scripts/feeds update scripts/feeds install kmod-batman-adv -</code></pre> -_Note_: If you downloaded an [[OpenWRT]] release but intend to build the latest batman-adv package you might need to modify your feeds.conf(.default). Make sure you have _"svn-src packages !svn://svn.openwrt.org/openwrt/packages"_ instead of e.g. _"src-svn packages !svn://svn.openwrt.org/openwrt/branches/packages_8.09"_. - -+Adding the developer version+: +}}} +''Note'': If you downloaded an OpenWRT release but intend to build the latest batman-adv package you might need to modify your feeds.conf(.default). Make sure you have ''"svn-src packages !svn://svn.openwrt.org/openwrt/packages"'' instead of e.g. ''"src-svn packages !svn://svn.openwrt.org/openwrt/branches/packages_8.09"''.
+__Adding the developer version__: [[BR]]
Append the following line to your openwrt feed configuration file (either feeds.conf or feeds.conf.default):
-<pre> +{{{ src-svn batman http://downloads.open-mesh.org/svn/openwrt-feed/ -</code></pre> +}}}
Update the package information and add the development package:
-<pre> +{{{ scripts/feeds update scripts/feeds install kmod-batman-adv-devel -</code></pre> - - +}}}
-h3. Configuring the batman-adv package
+=== Configuring the batman-adv package ===
-As soon as the batman-adv package has been added, it will show up in the [[OpenWRT]] package menu: +As soon as the batman-adv package has been added, it will show up in the OpenWRT package menu:
-+stable version+: - -<pre> +__stable version__: [[BR]] +{{{ Kernel modules ---> Network Support ---> kmod-batman-adv -</code></pre> - -+developer version+: +}}}
-<pre> +__developer version__: [[BR]] +{{{ Kernel modules ---> Network Support ---> kmod-batman-adv-devel -</code></pre> +}}}
Once the package had been selected a number of suboptions will become visible. You can enable/disable the verbose debug logging as well as choose whether or not to include the batctl tool.
In addition, the batman-adv package comes with an init script which is installed per default. This script will run at boot time and can be used to configure your desired batman-adv options. It reads the batman-adv uci file to retrieve the settings which allows to specify interfaces, intervals, log level and more.
+=== Advanced features ===
-h3. Advanced features - - -If you experience build problems or simply intend to rebuild the batman-adv package only, you can tell [[OpenWRT]] to build a specific package and enable the debugging mode as follows: - -+stable version+: +If you experience build problems or simply intend to rebuild the batman-adv package only, you can tell OpenWRT to build a specific package and enable the debugging mode as follows:
-<pre> +__stable version__: [[BR]] +{{{ cd openwrt make package/batman-advanced/clean make package/batman-advanced/compile V=99 -</code></pre> +}}}
-+developer version+: - -<pre> +__developer version__: [[BR]] +{{{ cd openwrt make package/batman-adv-devel/clean make package/batman-adv-devel/compile V=99 -</code></pre> +}}}
The package offers an easy way to apply custom patches whenever batman-adv is built. Simply copy your patches into the "patches" folder inside the package directory (you have to create the folder in case it does not exist yet). The location of the folder depends on which package you want to patch:
-+stable version+: - -<pre> +__stable version__: [[BR]] +{{{ openwrt/feeds/packages/net/batman-advanced/patches -</code></pre> - -+developer version+: +}}}
-<pre> +__developer version__: [[BR]] +{{{ openwrt/feeds/batman/batman-adv-devel/patches -</code></pre> +}}}
It is also possible to modify the batman-adv version if you ever wanted to build an older/newer version than configured in the package:
-+stable version+: - +__stable version__: [[BR]]
Adjust the PKG_VERSION variable to download & build the stable release you are interested in.
-<pre> +{{{ cat openwrt/feeds/packages/net/batman-advanced/Makefile [..] PKG_VERSION:=2010.0.0 [..] -</code></pre> - -+developer version+: +}}}
+__developer version__: [[BR]]
Ajust the PKG_REV variable to download & build the SVN revision you are interested in:
-<pre> +{{{ cat openwrt/feeds/batman/batman-adv-devel/Makefile [..] PKG_REV:=1764 [..] -</code></pre> +}}}
-In case you experience kernel oopses it might prove helpful to enable the kernel symbol table which translates the cryptic numbers which are part of each kernel oops log into readable function names. This calltrace can help developers to analyze the problem. Use [[OpenWRT]]'s config menu to enable the kernel symbol table and rebuild your image: +In case you experience kernel oopses it might prove helpful to enable the kernel symbol table which translates the cryptic numbers which are part of each kernel oops log into readable function names. This calltrace can help developers to analyze the problem. Use OpenWRT's config menu to enable the kernel symbol table and rebuild your image:
-<pre> +{{{ make menuconfig Global build settings ---> Compile the kernel with symbol table information -</code></pre> +}}}
-If you can't find this option you are using an older [[OpenWRT]] version which doesn't offer this config switch in the main menu. You have to modify the kernel settings directly: +If you can't find this option you are using an older OpenWRT version which doesn't offer this config switch in the main menu. You have to modify the kernel settings directly:
-<pre> +{{{ make kernel_menuconfig General setup ---> Configure standard kernel features (for small systems) ---> Load all symbols for debugging/ksymoops -</code></pre> +}}}
-</code></pre> +}}}