commits July 2017

commits@lists.open-mesh.org

1 participants
1317 discussions

[doc] master: doc: Remove outdated/deprecated pages (a969f99)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit a969f99a4f395d5f6866c95140134facd2c8a8ad Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 20:24:59 2017 +0200 doc: Remove outdated/deprecated pages Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- a969f99a4f395d5f6866c95140134facd2c8a8ad attachments/outdated.svg | 81 --- .../Batman-adv-openwrt-config-sophisticated.rst | 139 ----- batman-adv/Filing.rst | 4 - batman-adv/Multi-link-optimizations-technical.rst | 159 ------ batman-adv/Multi-link-optimize-old.rst | 77 --- batman-adv/Openwrt-package-builder.rst | 2 - batman-adv/Outdated.rst | 1 - batman-adv/Release-todo.rst | 81 --- batman-adv/SubmittingLinux.rst | 563 --------------------- batman-adv/index.rst | 8 - open-mesh/Filing.rst | 1 - open-mesh/TemplateDeprecated.rst | 4 - open-mesh/index.rst | 2 - 13 files changed, 1122 deletions(-) diff --git a/attachments/outdated.svg b/attachments/outdated.svg deleted file mode 100644 index 318a9f1..0000000 --- a/attachments/outdated.svg +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> - - -<svg - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:cc="http://creativecommons.org/ns#" - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns="http://www.w3.org/2000/svg" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="408.92792mm" - height="33.169174mm" - viewBox="0 0 1448.9572 117.52857" - id="svg2" - version="1.1" - inkscape:version="0.91 r13725" - sodipodi:docname="outdated.svg"> - <defs - id="defs4" /> - <sodipodi:namedview - id="base" - pagecolor="#ffffff" - bordercolor="#666666" - borderopacity="1.0" - inkscape:pageopacity="0.0" - inkscape:pageshadow="2" - inkscape:zoom="0.35" - inkscape:cx="223.76427" - inkscape:cy="-162.66429" - inkscape:document-units="px" - inkscape:current-layer="layer1" - showgrid="false" - fit-margin-top="0" - fit-margin-left="0" - fit-margin-right="0" - fit-margin-bottom="0" - inkscape:window-width="1600" - inkscape:window-height="841" - inkscape:window-x="-4" - inkscape:window-y="0" - inkscape:window-maximized="1" /> - <metadata - id="metadata7"> - <rdf:RDF> - <cc:Work - rdf:about=""> - <dc:format>image/svg+xml</dc:format> - <dc:type - rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - <dc:title></dc:title> - </cc:Work> - </rdf:RDF> - </metadata> - <g - inkscape:label="Layer 1" - inkscape:groupmode="layer" - id="layer1" - transform="translate(314.47856,-252.16935)"> - <rect - style="fill:#ff0000;fill-opacity:1;stroke:#ff0000;stroke-width:6.55794382;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" - id="rect4140" - width="1442.3993" - height="110.97063" - x="-311.19958" - y="255.44832" - ry="14.938354" /> - <text - xml:space="preserve" - style="font-style:normal;font-weight:normal;font-size:40px;line-height:125%;font-family:Sans;letter-spacing:0px;word-spacing:0px;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - x="-244.56049" - y="325.49417" - id="text4136" - sodipodi:linespacing="125%"><tspan - sodipodi:role="line" - id="tspan4138" - x="-244.56049" - y="325.49417" - style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Sans;-inkscape-font-specification:'Sans Bold'">THE INFORMATION PROVIDED ON THIS PAGE IS OUTDATED</tspan></text> - </g> -</svg> diff --git a/batman-adv/Batman-adv-openwrt-config-sophisticated.rst b/batman-adv/Batman-adv-openwrt-config-sophisticated.rst deleted file mode 100644 index 9a861d1..0000000 --- a/batman-adv/Batman-adv-openwrt-config-sophisticated.rst +++ /dev/null @@ -1,139 +0,0 @@ -{{include(open-mesh:TemplateDeprecated)}} - -Example B.A.T.M.A.N. configuration snippets on OpenWRT -====================================================== - -**Note**: The script below was written for batman-adv 2012.4.0 and -older. With batman-adv 2013.0.0 came a new syntax as explained -[[Batman-adv-openwrt-config\|here]]. - -3-radio mesh-node, with one open VAP for roaming clients access, and another with WPA -------------------------------------------------------------------------------------- - -You should run the script inside the OpenWRT host, assuming: - -- batman-adv is compiled in, or installed (opkg install - kmod-batman-adv). -- your uci config resembles a vanilla OpenWRT (no esoteric setups done - yet) -- all radios are connected -- drivers for all radios are compiled in or installed (ex. opkg install - kmod-ath9k-htc) -- all your radios/drivers support adhoc mode properly (unfortunately - most USB don't, as of May 2012) -- main radio (radio0) supports multiple, mixed VAPs (adhoc and ap) - -You can use this configuration (run this script) on a node with just 1 -(or 2) radio(s) too, but you'll experience bandwidth degradation when -passing through that point. - -:: - - #!/bin/sh - - ### Main radio0 will broadcast one AP with no encryption, another AP with WPA2, - ### and both interfaces will be bridged together with eth0 and bat0 - ### Another VAP in adhoc mode is added to main radio0, - ### as well as adhoc networks in radio1 and radio2 if they are present. - ### All three adhoc networks are added to bat0 and thus managed by batman-adv - - ### Node-specific settings - export HOSTNAME="meshnodeX" - export IP="10.x.x.x" - export WPA_ESSID="$HOSTNAME.wpa" - export WPA_KEY="password" - - ### These parameters should be consistent across all nodes - export NETMASK="255.0.0.0" - export DNS="" - export GATEWAY="" - export PUBLIC_ESSID="3radio.mesh" - export MESH0_BSSID="CA:CA:CA:CA:CA:00" - export MESH0_ESSID="mesh0" - export MESH0_CHANNEL="1" - export MESH1_MODE="adhoc" - export MESH1_BSSID="CA:CA:CA:CA:CA:01" - export MESH1_ESSID="mesh1" - export MESH1_CHANNEL="11" - export MESH2_MODE="adhoc" - export MESH2_BSSID="CA:CA:CA:CA:CA:02" - export MESH2_ESSID="mesh2" - export MESH2_CHANNEL="6" - - ### Ensure of populating /etc/config/wireless with - ### autodetected wifi-device entries (radioX) - ### to get all list_capab and hwmode correct. Otherwise - ### OpenWRT might fail to configure the radio properly. - wifi detect >>/etc/config/wireless - - ### Clear preexisting wifi-iface sections to avoid conflicts or dups - ( for i in `seq 0 9` ; do echo "delete wireless.@wifi-iface[]" ; done ) | uci batch -q - - ### Create /etc/config/batman-adv if it's not there yet. - uci import -m batman-adv - -What if radio1 and/or radio2 don't support adhoc mode properly? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If the driver is buggy, unstable, or throughput is lower in adhoc mode, -you can fallback to using an ap/client design, at the cost of -redundancy. - -simply customize the MESHx\_ parameters on a per-node basis: - -:: - - ### Relative physical location: node1 <--ch6--> node2 <--ch11--> node3 - - # On node1 - export MESH1_MODE="client" - export MESH1_BSSID="" - export MESH1_ESSID="node2.ptp-channel6" - export MESH1_CHANNEL="6" - - # On node2 - export MESH1_MODE="ap" - export MESH1_BSSID="" - export MESH1_ESSID="node2.ptp-channel6" - export MESH1_CHANNEL="6" - export MESH2_MODE="client" - export MESH2_BSSID="" - export MESH2_ESSID="node3.ptp-channel11" - export MESH2_CHANNEL="11" - - # On node3 - export MESH1_MODE="ap" - export MESH1_BSSID="" - export MESH1_ESSID="node3.ptp-channel11" - export MESH1_CHANNEL="11" - -I like the script but I don't need/want an extra VAP with WPA2, how can I disable it? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Just remove or comment out the corresponding section - -:: - - #add wireless wifi-iface - #set wireless.(a)wifi-iface[-1].device=radio0 - #set wireless.(a)wifi-iface[-1].encryption=psk2 - #set wireless.(a)wifi-iface[-1].key='$WPA_KEY' - #set wireless.(a)wifi-iface[-1].network=lan - #set wireless.(a)wifi-iface[-1].mode=ap - #set wireless.(a)wifi-iface[-1].ssid='$WPA_ESSID' - -What if I am running batman-adv 2013.0.0 or later ? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Modify the bat0 and mesh0 networks to be as follows - -:: - - set network.bat0=interface - set network.bat0.ifname=bat0 - set network.bat0.proto=none - set network.bat0.mtu=1528 - set network.mesh0=interface - set network.mesh0.proto=batadv - set network.mesh0.mtu=1528 - set network.mesh0.mesh=bat0 diff --git a/batman-adv/Filing.rst b/batman-adv/Filing.rst deleted file mode 100644 index 614e8f9..0000000 --- a/batman-adv/Filing.rst +++ /dev/null @@ -1,4 +0,0 @@ -Filing -====== - -[[Doc-overview]] diff --git a/batman-adv/Multi-link-optimizations-technical.rst b/batman-adv/Multi-link-optimizations-technical.rst deleted file mode 100644 index c1ca315..0000000 --- a/batman-adv/Multi-link-optimizations-technical.rst +++ /dev/null @@ -1,159 +0,0 @@ -This page is OUTDATED! -====================== - -This page was superseded with an update for the feature, -[[Network-wide-multi-link-optimization\|documentered here]] - -Multi-link Optimizations (technical documentation) -================================================== - -Mesh nodes with multiple physical links to other mesh nodes can use this -capability to gain various benefits, for example: - -| \* bonding: use multiple links for the same data stream to boost - bandwidth -| \* interface alternating: send on other interfaces (and therefore - other channels, if configured correctly) to minimize multi-hop - bandwidth degradation - -These features operate under the following premises: - -| \* multiple links exist between two neighbors -| \* the routing decision is independent of the link a packet is - received on - -Notably, these multi-interface features are independent of B.A.T.M.A.N. -and could work with any routing algorithm/metric. The routing software -only needs to detect that multiple peers belong to the same neighbor -mesh node. This is also not related to Multi-Path Routing, which would -require multiple independent links. - -The multi-link optimization procedure can be broken into these steps: - -#. detect that a neighbor is reachable via multiple links -#. select suitable candidates among the the available links -#. use these multiple links for various manipulations - -Link detection --------------- - -The detection part is specific to batman-adv. To understand how the link -detection works it is necessary to recall how batman-adv handles -multiple interfaces: - -The MAC address (Originator address) of the primary interface (usually -the first added interface) is known throughout the mesh as OGMs -containing the MAC address are broadcasted on all available interfaces -with a big TTL. This ensures mesh nodes only reachable via secondary -interfaces will know about this node. All remaining interfaces are -"secondary" interfaces which are only known in the single hop -neighborhood. The OGMs containing their MAC addresses are broadcasted -with a small TTL on the respective interface only. These secondary OGMs -uniquely serve the purpose of detecting local neighbors and estimate the -link quality towards them. - -*Note*: It does not matter which interface is the primary interface, it -is only used to have a single Originator known in the mesh, thus -avoiding OGM overhead. - -To detect whether or not a neighbor has multiple links towards a node it -suffices to analyze the incoming primary OGM. If the primary OGM is -received via multiple interfaces a node can (almost) safely assume -having multiple links towards its Originator. However, the OGM protocol -demands to forward all incoming OGMs for the path detection which could -confuse the multi-link detection because it has to distinguish single -hop neighbors from neighbors that are further away. To resolve the issue -the PRIMARIES\_FIRST\_HOP flag was introduced. Only primary OGMs are -allowed to carry it and every node removes the flag before -rebroadcasting the OGM. - -|image0| - -In the illustration, A receives the OGM via A1 (sent out by B1) and A2 -(sent out by B2) - and detects that these two Links A1-B1, A2-B2 exist. -These link candidates are stored and further filtered - -Candidate selection -------------------- - -To be usable for the target features, the links must have a similar -quality and should operate on a different frequency. Therefore, in -batman-adv only links are further considered if: - -| \* the link quality is not much worse than the best link within a - certain TQ threshold (now: 50) -| \* the link destination is different from the other already selected - candidates - e.g. if A1-B1 was selected, A2-B1 would be forbidden as - they would operate on the same frequency and therefore would interfere - with each other - -In the illustration below, A1-B1 and A2-B2 meet this criteria and are -therefore selected as candidates. - -|image1| - -Implementation note: Detected links are internally stored within the -originator structure of the primary originator. The candidates are -internally called "bonding candidates" - -Using the candidates --------------------- - -Once a neighbor mesh node has been selected by the classic routing -algorithm, the individual links can now be equally be selected to send -data to the next neighbor without tampering with routing. Possible -mechanisms exploiting this fact are described below. - -More Info can be found in the [[multi-link-optimize\|Multi-Link -Optimization]] feature description page. - -Implementation note: the manipulations are hooked in the tx path when -selecting a neighbor in find\_router() - -Interface Alternating -~~~~~~~~~~~~~~~~~~~~~ - -Interface Alternating basically tries to forward a packet on another -interface than on which the frame was received. This is only done if -suitable candidate with another source interface exists. - -|image2| - -This feature is always enabled. - -Bonding -~~~~~~~ - -In bonding, we split a single stream and distribute the packets over -multiple links. Packets are sent in a round-robin fashion over the -available candidates. This can be used to increase the throughput for -data streams from node A to node B. In a perfect environment the -throughput is n times higher, where n is the number of candidates. - -|image3| - -Practice shows however that the theoretical bandwidth gain is not -reached - even if the links are physically disjoint. E.g. using a 2.4 -GHz and a 5 GHz with a modulation of 54 Mbit/s both has shown to gain -150% bandwith boost over a single link, not 200% as expected in theory. -Possible reasons may be the packet reordering and slightly different -queue load caused by random backoffs, retries, etc. For these reasons, -bonding must be enabled explicitly. - -Discussion and further work ---------------------------- - -As explained, the bonding mode stays behind the theoretical -expectations. The packet loss based TQ metric is also not optimal for -selecting bonding candidates - a bandwidth based metric would be more -suitable for this task, as slow links will slow down the whole -aggregated connection. - -These shortcomings would be subject to further improvements of this -featureset. - -.. |image0| image:: primary_flag.png -.. |image1| image:: interface_detection.dia.jpg -.. |image2| image:: alternation_chain.dia.jpg -.. |image3| image:: bonding_roundrobin.dia.jpg - diff --git a/batman-adv/Multi-link-optimize-old.rst b/batman-adv/Multi-link-optimize-old.rst deleted file mode 100644 index d3acdbc..0000000 --- a/batman-adv/Multi-link-optimize-old.rst +++ /dev/null @@ -1,77 +0,0 @@ -This page is OUTDATED! -====================== - -This page was superseded with an update for the feature, -[[Multi-link-optimize\|documentered here]] - -Multi-link Optimizations -======================== - -batman-adv is able to work on different interfaces - multiple WiFi -interfaces, but also Ethernet interfaces. If two or more nodes are -interconnected through batman-adv on multiple interfaces, they may -leverage some features to increase throughput, which are explained here. - -For more technical information, please see our -[[multi-link-optimizations-technical\|technical multi-link -documentation]] - -Interface alternating ---------------------- - -With Interface alternating, batman-adv forwards frames on a different -interface than on which the frame was received. The purpose of this -alternation is to reduce interference (we can either send or receive on -a WiFi interface at one time) and to balance the network load better on -the available interfaces, and eventually increases throughput. The -mechanism is illustrated below for a chain of nodes with two interfaces. - -|image0| - -Interface alternating is only performed if the two candidate links to -the next hop have a similar quality. This feature is enabled by default -and does not have to be enabled manually. - -Interface bonding ------------------ - -When multiple links (with similar transmit quality) are available to the -same neighbor, batman-adv may distribute the frames to be sent over -these available links. The individual frames are sent over the links in -a round robin fashion as illustrated below. Using this technique, the -throughput may be increased by the number of links involved in the -bonding. In practical tests over two WiFi links, we have seen more than -50% of throughput gain. - -|image1| - -However, if the links have different speeds (batman-adv won't detect -that), the throughput may even decrease due to the slower link slowing -down the whole bonding. Therefore, this feature must be explicitly -enabled. One may enable it for certain nodes in a known environment, the -same setting does not have to be applied mesh wide. - -To enable bonding, use batctl: - -:: - - batctl bonding enable - -Throughput gain ---------------- - -At the [[open-mesh:2010-06-13-wbm2010-bracciano\|WirelessBattleMesh v3]] -we performed throughput tests to measure the gain of the various modes: - -|image2| - -This graph shows a 3 node setup each with 2 802.11abg wifi interfaces -connected to the mesh network (1x 2.4GHz and 1x 5.8GHz). As you can see -the alternating mode is able to maintain the performance. The old -default behavior sometimes manages to maintain a similar level of -performance but is rather unstable. - -.. |image0| image:: alternation_chain.dia.jpg -.. |image1| image:: bonding_roundrobin.dia.jpg -.. |image2| image:: bonding_2hops.png - diff --git a/batman-adv/Openwrt-package-builder.rst b/batman-adv/Openwrt-package-builder.rst deleted file mode 100644 index d6580cf..0000000 --- a/batman-adv/Openwrt-package-builder.rst +++ /dev/null @@ -1,2 +0,0 @@ -A little script for building latest batman-adv versions compatible to -OpenWRT release versions. diff --git a/batman-adv/Outdated.rst b/batman-adv/Outdated.rst deleted file mode 100644 index ecbfa07..0000000 --- a/batman-adv/Outdated.rst +++ /dev/null @@ -1 +0,0 @@ -**** diff --git a/batman-adv/Release-todo.rst b/batman-adv/Release-todo.rst deleted file mode 100644 index 7d53f5d..0000000 --- a/batman-adv/Release-todo.rst +++ /dev/null @@ -1,81 +0,0 @@ -Release Checklist -================= - -This page contains a checklist of things that need to be done for a -release. - -Release Scheduling ------------------- - -|image0| - -- master branch is closed whenever net-next is closed -- master branch is released as feature release 20\_ \_.a after net-next - is closed (whenever Linus released a final Linux version) - - - actually only the patches which were really submitted should be - released (when possible) - -- maint branch is released on demand - - - for example after security issues - - when net.git/Linux was released with important fixes and users - cannot switch to new feature release (which is done at the same - time) - -Documentation -------------- - -- [ ] build changelog -- [ ] update README -- [ ] [[open-mesh:News-draft\|write release announcement]] -- [ ] update wiki documentation - -Code ----- - -- [ ] make sure all code contains the release version strings -- [ ] update copyright years (if needed) -- [ ] check coverity scan status -- [ ] remove dead code (if any) -- [ ] check against kernel versions -- [ ] check that maint branch is merged in master -- [ ] check for `open patches on the - ml <https://patchwork.open-mesh.org/project/b.a.t.m.a.n./list/>`__ -- [ ] git tag release - -Release -------- - -- [ ] build package tar.gz and generate checksums -- [ ] move packages/checksums to stable/sources / create symlinks from - releases -- [ ] update download links in the [[open-mesh:Download\|redmine - downloads page]] -- [ ] `Add news </projects/open-mesh/news/new>`__ based on - [[open-mesh:News-draft]] -- [ ] send release mail -- [ ] update IRC channel topic - -Distributions -------------- - -- [ ] update alfred openwrt package -- [ ] update batman-adv/batctl openwrt package -- [ ] update gentoo package -- [ ] update debian batctl package - -Aftershow ---------- - -- [ ] Merge current git tag into maint (must be -[STRIKEOUT:ff-only or - pre-tagging steps were done wrong] git merge --ff-only v20xx.x.x) -- [ ] close `current - version <https://www.open-mesh.org/projects/batman-adv/settings/versions>`__ -- [ ] add `new upcoming - version <https://www.open-mesh.org/projects/batman-adv/versions/new>`__ -- [ ] Mark issues from `Resolved to - Closed <https://www.open-mesh.org/projects/batman-adv/issues?utf8=%E2%9C%93&set_fil…>`__ - -.. |image0| image:: /attachments/download/706/release_scheduling.svg - diff --git a/batman-adv/SubmittingLinux.rst b/batman-adv/SubmittingLinux.rst deleted file mode 100644 index aa80fbe..0000000 --- a/batman-adv/SubmittingLinux.rst +++ /dev/null @@ -1,563 +0,0 @@ -{{include(open-mesh:TemplateDeprecated)}} - -Submitting Patches to Linux -=========================== - -We currently submit patches for Linux from our next branch. I try to -give a short overview about it using some patches submitted to DaveM. - -Following steps must always be done: - -- get the linux-integration + batman-adv repository -- get the newest patches from next and maint -- check for compat code -- squash/cleanup patches -- fix "Fixes: " and other commit id references -- check if coccinelle prints new warnings -- check if all versions compile cleanly using sparse (cgcc) -- do a merge in a temporary branch and compare the result with - batman-adv:next.git -- check commit messages author/signed-off-by of patches -- check if all patches are checkpatch.pl clean -- prepare changelog -- create tag for david which includes the changelog -- format patches -- submit cover letter + patches -- wait until David accepted the pull request -- update base patches - -Rules for patch handling ------------------------- - -- new patches enter batman-adv.git master branch -- new patches are forwarded to David from master branch -- master branch is closed whenever net-next is closed -- new patches for master should be avoided when Linux -rc7/final is - near (which will cause the closing of net-next) - -Variables ---------- - -There are different basepoints/references used when preparing the - -- GIT\_OM\_SERVER - - - server from which the open-mesh.org repositories are retrieved - -- LM\_MASTER - - - name of branch in batman-adv.git which points to the latest patch - already ported to linux-merge.git:batadv/net-next - -- LM\_MAINT - - - name of branch in batman-adv.git which points to the latest patch - already ported to linux-merge.git:batadv/net - -- BASE\_NETNEXT - - - some recent commit in net-next.git which should be used as base - commit for the patches which will be applied (chose wisely) - -- BASE\_NET - - - some recent commit in net.git which should be used as base commit - for the patches which will be applied (chose wisely) - -:: - - GIT_OM_SERVER="git+ssh://git@open-mesh.org" - LM_MASTER=ecsv/lm_master - LM_MAINT=ecsv/lm_maint - BASE_NETNEXT=v4.12-rc1 - BASE_NET=v4.12-rc1 - -get the linux-integration + batman-adv repository -------------------------------------------------- - -First step is to actually get the repositories and create the branches. -You may also use the --reference option for linux-merge to speedup the -download when you already have some linux repository on you system - -:: - - git clone "${GIT_OM_SERVER}/linux-merge.git" linux-merge - git -C linux-merge remote add net-next git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next.git - git -C linux-merge remote add net git://git.kernel.org/pub/scm/linux/kernel/git/davem/net.git - git -C linux-merge remote update --prune - git -C linux-merge branch base/net --track origin/base/net - git -C linux-merge branch base/net-next --track origin/base/net-next - git -C linux-merge branch batadv/net --track origin/batadv/net - git -C linux-merge branch batadv/net-next --track origin/batadv/net-next - git clone "${GIT_OM_SERVER}/batman-adv.git" batman-adv - git -C batman-adv branch "${LM_MASTER}" --track "origin/${LM_MASTER}" - git -C batman-adv branch "${LM_MAINT}" --track "origin/${LM_MAINT}" - -The next step is to make sure that out linux-merge.git branches are -either on top or equal the chosen. It should also be checked first that -it is really a basepoint in the chosen branches - -:: - - git -C linux-merge remote update --prune - git -C linux-merge branch -r --contains="${BASE_NET}" net/master - git -C linux-merge branch -r --contains="${BASE_NETNEXT}" net-next/master - - git -C linux-merge checkout base/net - git -C linux-merge merge --ff-only "origin/base/net" - git -C linux-merge merge --ff-only "${BASE_NET}" - - git -C linux-merge checkout base/net-next - git -C linux-merge merge --ff-only "origin/base/net-next" - git -C linux-merge merge --ff-only "${BASE_NETNEXT}" - - git -C linux-merge push origin base/net base/net-next - -Problems during this have to either be fixed by using a correct base -commit, fixing the local branches or by rebasing the remaining patches -on the batadv/\* branches on top of the base commits (think twice before -rebasing). - -The same has to be done for the batman-adv repository. Here it is is -important to update the maint branch manually after releases. Otherwise -it would look like patches which were already submitted to net-next have -to be send again to net. But make sure that there are no actual fixes -between ${LM\_MAINT} and origin/maint which were missed earlier - -:: - - git -C batman-adv remote update --prune - - git -C batman-adv checkout "${LM_MAINT}" - git -C batman-adv merge --ff-only "origin/${LM_MAINT}" - - git -C batman-adv checkout "${LM_MASTER}" - git -C batman-adv merge --ff-only "origin/${LM_MASTER}" - -get the newest patches ----------------------- - -from master -~~~~~~~~~~~ - -:: - - cd batman-adv - git checkout -B rebase --no-track origin/master - GIT_SEQUENCE_EDITOR="sh -c 'git rev-list --reverse --no-merges '\\''${LM_MASTER}..origin/master'\\'' --not origin/maint|awk '\\''{ print \"pick \"\$1}'\\'' > \$1' \$@" \ - git rebase -i origin/maint --onto "${LM_MASTER}" --no-ff - -This patches have to be cleaned up. First these these changes have to be -squashed so that "Fixes: " patches are squashed together with the -patches which introduced the problem (when they exist). Also compat code -has to be removed. Both things can be identified with git log: - -Patches with "Fixes: " lines: - -:: - - git log --grep='^Fixes: ' "${LM_MASTER}"..rebase - -The extra stuff which should not be submitted can be identified via: - -:: - - git log --stat --oneline "${LM_MASTER}"..rebase -- compat-sources compat-include README.external CHANGELOG Makefile .gitignore .gitattributes compat.h gen-compat-autoconf.sh README - -This can all be cleaned up by using git-rebase and then marking the -relevant commits for editing. It may also be a good idea to move patches -like "Start-new-development-cycle" to the front - -:: - - git rebase -i "${LM_MASTER}" - - # edit the commit message to point to the correct upstream commit -- just search in linux-merge for the commit name - git commit --amend - - # remove changes either reverting to previous versions (new files have to be deleted) - git checkout HEAD~1 compat-sources compat-include README.external CHANGELOG Makefile .gitignore .gitattributes compat.h gen-compat-autoconf.sh README - - # delete some new file (example) - git rm -f compat-include/net/genetlink.h - - # at the end continue with the rebase to the next commit - git rebase --continue - -It is a good idea to check again if some file was missed. It is also a -good idea to manually check the commit messages for other commit -references: - -:: - - git log --stat "${LM_MASTER}"..rebase - -If everything looks good then these patches should be formatted (make -sure that you don't have some old patches in the directory). The branch -of already prepared patches has to be updated - -:: - - git format-patch -s "${LM_MASTER}"..rebase - git checkout "${LM_MASTER}" - git merge --ff-only origin/master - git push origin "${LM_MASTER}" - -Save the generated patches to a save place. Lets call this place -$EXPORTED\_PATCHES\_MASTER - -from maint -~~~~~~~~~~ - -Make sure that ${LM\_MASTER} was updated after a release correctly and -${LM\_MASTER}..origin/maint is containing patches which were send to -net-next - -The rest of the rebase process works similar to the next process - -:: - - cd batman-adv - git checkout -B rebase --no-track origin/maint - git rebase -i "${LM_MAINT}" - -This patches have to be cleaned up. First these these changes have to be -squashed so that "Fixes: " patches are squashed together with the -patches which introduced the problem (when they exist). Also compat code -has to be removed. Both things can be identified with git log: - -Patches with "Fixes: " lines: - -:: - - git log --grep='^Fixes: ' "${LM_MAINT}"..rebase - -The extra stuff which should not be submitted can be identified via: - -:: - - git log --stat --oneline "${LM_MAINT}"..rebase -- compat-sources compat-include README.external CHANGELOG Makefile .gitignore .gitattributes compat.h gen-compat-autoconf.sh README - -This can all be cleaned up by using git-rebase and then marking the -relevant commits for editing. It may also be a good idea to move patches -like "Start-new-development-cycle" to the front - -:: - - git rebase -i "${LM_MAINT}" - - # edit the commit message to point to the correct upstream commit -- just search in linux-merge for the commit name - git commit --amend - - # remove changes either reverting to previous versions (new files have to be deleted) - git checkout HEAD~1 compat-sources compat-include README.external CHANGELOG Makefile .gitignore .gitattributes compat.h gen-compat-autoconf.sh README - - # delete some new file (example) - git rm -f compat-include/net/genetlink.h - - # at the end continue with the rebase to the next commit - git rebase --continue - -It is a good idea to check again if some file was missed. It is also a -good idea to manually check the commit messages for other commit -references or missing signed-off-by: - -:: - - git log --stat "${LM_MAINT}"..rebase - -If everything looks good then these patches should be formatted (make -sure that you don't have some old patches in the directory). The branch -of already prepared patches has to be updated - -:: - - git format-patch -s "${LM_MAINT}"..rebase - git checkout "${LM_MAINT}" - git merge --ff-only origin/maint - git push origin "${LM_MAINT}" - -Save the generated patches to a save place. Lets call this place -$EXPORTED\_PATCHES\_MAINT - -Apply patches on linux-merge ----------------------------- - -from master -~~~~~~~~~~~ - -The patches were already exported. So they only have to be applied in -the correct branch - -:: - - cd linux-merge - git checkout batadv/net-next - git merge --ff-only origin/batadv/net-next - ./scripts/checkpatch --strict "${EXPORTED_PATCHES_MASTER}"/*.patch - git am -s "${EXPORTED_PATCHES_MASTER}"/*.patch - git push origin batadv/net-next - -from maint -~~~~~~~~~~ - -The patches were already exported. So they only have to be applied in -the correct branch - -:: - - cd linux-merge - git checkout batadv/net - git merge --ff-only origin/batadv/net - ./scripts/checkpatch --strict "${EXPORTED_PATCHES_MAINT}"/*.patch - git am -s "${EXPORTED_PATCHES_MAINT}"/*.patch - git push origin batadv/net - -check if coccinelle prints new warnings ---------------------------------------- - -:: - - make coccicheck KBUILD_EXTMOD=net/batman-adv/ - -check if all versions compile cleanly using sparse (cgcc) ---------------------------------------------------------- - -First the linux-merge build environment has to be prepared - -:: - - make allnoconfig - cat >> .config << EOF - CONFIG_SMP=y - CONFIG_EMBEDDED=n - CONFIG_EXPERT=n - CONFIG_MODULES=y - CONFIG_MODULE_UNLOAD=y - CONFIG_MODVERSIONS=y - CONFIG_MODULE_SRCVERSION_ALL=y - - CONFIG_CRC16=y - CONFIG_LIBCRC32C=y - CONFIG_NET=y - CONFIG_INET=y - CONFIG_DEBUG_FS=y - CONFIG_IPV6=y - CONFIG_BRIDGE=y - CONFIG_VLAN_8021Q=y - CONFIG_WIRELESS=y - CONFIG_CFG80211=y - CONFIG_CFG80211=y - - CONFIG_BATMAN_ADV=y - CONFIG_BATMAN_ADV_BATMAN_V=y - CONFIG_BATMAN_ADV_BLA=y - CONFIG_BATMAN_ADV_DAT=y - CONFIG_BATMAN_ADV_NC=y - CONFIG_BATMAN_ADV_MCAST=y - - CONFIG_CC_STACKPROTECTOR_STRONG=y - CONFIG_LOCKUP_DETECTOR=y - CONFIG_DETECT_HUNG_TASK=y - CONFIG_SCHED_STACK_END_CHECK=y - CONFIG_DEBUG_RT_MUTEXES=y - CONFIG_DEBUG_SPINLOCK=y - CONFIG_DEBUG_MUTEXES=y - CONFIG_PROVE_LOCKING=y - CONFIG_LOCK_STAT=y - CONFIG_DEBUG_LOCKDEP=y - CONFIG_DEBUG_ATOMIC_SLEEP=y - CONFIG_DEBUG_LIST=y - CONFIG_DEBUG_PI_LIST=y - CONFIG_DEBUG_SG=y - CONFIG_DEBUG_NOTIFIERS=y - CONFIG_PROVE_RCU_REPEATEDLY=y - CONFIG_SPARSE_RCU_POINTER=y - CONFIG_DEBUG_STRICT_USER_COPY_CHECKS=y - CONFIG_X86_VERBOSE_BOOTUP=y - CONFIG_DEBUG_RODATA=y - CONFIG_DEBUG_RODATA_TEST=n - CONFIG_DEBUG_SET_MODULE_RONX=y - CONFIG_PAGE_EXTENSION=y - CONFIG_DEBUG_PAGEALLOC=y - CONFIG_DEBUG_OBJECTS=y - CONFIG_DEBUG_OBJECTS_FREE=y - CONFIG_DEBUG_OBJECTS_TIMERS=y - CONFIG_DEBUG_OBJECTS_WORK=y - CONFIG_DEBUG_OBJECTS_RCU_HEAD=y - CONFIG_DEBUG_OBJECTS_PERCPU_COUNTER=y - CONFIG_DEBUG_KMEMLEAK=y - CONFIG_DEBUG_STACK_USAGE=y - CONFIG_DEBUG_STACKOVERFLOW=y - CONFIG_DEBUG_INFO=y - CONFIG_DEBUG_INFO_DWARF4=y - CONFIG_GDB_SCRIPTS=y - CONFIG_READABLE_ASM=y - CONFIG_STACK_VALIDATION=y - CONFIG_WQ_WATCHDOG=y - CONFIG_DEBUG_KOBJECT_RELEASE=y - CONFIG_DEBUG_WQ_FORCE_RR_CPU=y - CONFIG_OPTIMIZE_INLINING=y - EOF - make olddefconfig - make -j$(nproc || echo 1) - -Then the rebuild has to be done between batadv/net-next and -base/net-next (or between batadv/net and base/net) for each commit: - -:: - - git checkout batadv/net-next - git rebase -i base/net-next -x 'make C=1' - -check if all patches are in linux-merge ---------------------------------------- - -TODO - -submit patches --------------- - -TODO - -A good commit in has to be chosen. We should not send more than 20 -patches for net-next for each pull request. A lower number (6?) of -patches should be used for net. - -Lets assume a good commit is 4e3e823b5a503235630921287f130e1d8d22d200 - -:: - - TAG=batadv-next-for-davem-20160701 - git tag -s ${TAG} 4e3e823b5a503235630921287f130e1d8d22d200 - # write a good commit message - git push origin ${TAG} - -The patches then have to be prepared and the cover letter has to be -created for the pull request. For net-next it would look like: - -:: - - TAG=batadv-next-for-davem-20160701 - git format-patch --cover-letter base/net-next..${TAG} - sed -i '/\*\*\* BLURB HERE \*\*\*/q' 0000-cover-letter.patch - git request-pull base/net-next git://git.open-mesh.org/linux-merge.git ${TAG} >> 0000-cover-letter.patch - # write cover letter - git send-email --to=davem(a)davemloft.net --cc=netdev(a)vger.kernel.org --cc=b.a.t.m.a.n(a)lists.open-mesh.org 00*.patch - -or for net: - -:: - - TAG=batadv-net-for-davem-20160701 - git format-patch --cover-letter base/net..${TAG} - sed -i '/\*\*\* BLURB HERE \*\*\*/q' 0000-cover-letter.patch - git request-pull base/net git://git.open-mesh.org/linux-merge.git ${TAG} >> 0000-cover-letter.patch - # write cover letter - git send-email --to=davem(a)davemloft.net --cc=netdev(a)vger.kernel.org --cc=b.a.t.m.a.n(a)lists.open-mesh.org 00*.patch - -Now I will write something like - -:: - - Subject: pull request for net-next: batman-adv 2016-07-01 - - Hi David, - - we are a bit late to submit our feature patches, but I hope we make it in time. - Antonio is taking a pause in his upstream work, so I'll be submitting our - batman-adv patches for now. It is my first time, so please bear with me. - - Please pull or let me know of any problem! - - Thank you, - Simon - - The following changes since commit 99860208bc62d8ebd5c57495b84856506fe075bc: - - sched: remove NET_XMIT_POLICED (2016-06-12 22:02:11 -0400) - - are available in the git repository at: - - git://git.open-mesh.org/linux-merge.git tags/batadv-next-for-davem-20160701 - - for you to fetch changes up to 4e3e823b5a503235630921287f130e1d8d22d200: - - batman-adv: Add debugfs table for mcast flags (2016-06-30 10:29:43 +0200) - - ---------------------------------------------------------------- - This feature patchset includes the following changes: - - - two patches with minimal clean up work by Antonio Quartulli and - Simon Wunderlich - - - eight patches of B.A.T.M.A.N. V, API and documentation clean - up work, by Antonio Quartulli and Marek Lindner - - - Andrew Lunn fixed the skb priority adoption when forwarding - fragmented packets (two patches) - - - Multicast optimization support is now enabled for bridges which - comes with some protocol updates, by Linus Luessing - - ---------------------------------------------------------------- - Andrew Lunn (2): - batman-adv: Set skb priority in fragments - batman-adv: Include frame priority in fragment header - - Antonio Quartulli (4): - batman-adv: statically print gateway table header - batman-adv: remove ogm_emit and ogm_schedule API calls - batman-adv: remove useless inline attribute for sysfs helper function - batman-adv: move GW mode and selection class to private data structure - - Linus Lüssing (4): - batman-adv: Always flood IGMP/MLD reports - batman-adv: Add multicast optimization support for bridged setups - batman-adv: Adding logging of mcast flag changes - batman-adv: Add debugfs table for mcast flags - - Marek Lindner (5): - batman-adv: document sysfs files in alphabetical order - batman-adv: update elp interval documentation - batman-adv: refactor batadv_neigh_node_* functions to follow common - style - batman-adv: remove unused callback from batadv_algo_ops struct - batman-adv: init ELP tweaking options only once - - Simon Wunderlich (2): - batman-adv: Start new development cycle - batman-adv: remove unused vid local variable in tt seq print - - .../ABI/testing/sysfs-class-net-batman-adv | 20 +- - net/batman-adv/Kconfig | 2 +- - net/batman-adv/bat_algo.h | 7 +- - net/batman-adv/bat_iv_ogm.c | 72 ++- - net/batman-adv/bat_v.c | 29 +- - net/batman-adv/bat_v_elp.c | 4 +- - net/batman-adv/bat_v_ogm.c | 4 +- - net/batman-adv/debugfs.c | 23 + - net/batman-adv/fragmentation.c | 12 +- - net/batman-adv/gateway_client.c | 15 +- - net/batman-adv/gateway_common.c | 6 +- - net/batman-adv/hard-interface.c | 6 +- - net/batman-adv/main.c | 2 - - net/batman-adv/main.h | 6 +- - net/batman-adv/multicast.c | 499 +++++++++++++++++++-- - net/batman-adv/multicast.h | 3 + - net/batman-adv/originator.c | 40 +- - net/batman-adv/originator.h | 6 +- - net/batman-adv/packet.h | 7 +- - net/batman-adv/routing.c | 2 + - net/batman-adv/send.c | 61 +-- - net/batman-adv/send.h | 4 +- - net/batman-adv/soft-interface.c | 10 +- - net/batman-adv/sysfs.c | 22 +- - net/batman-adv/translation-table.c | 2 - - net/batman-adv/types.h | 32 +- - 26 files changed, 704 insertions(+), 192 deletions(-) - -update base patches after successful pull request -------------------------------------------------- - -TODO diff --git a/batman-adv/index.rst b/batman-adv/index.rst index 5ae2227..a9a29f4 100644 --- a/batman-adv/index.rst +++ b/batman-adv/index.rst @@ -10,7 +10,6 @@ Contents: Bandwidth_meter_technical Bandwidth_meter_tests Batman-adv-openwrt-config - Batman-adv-openwrt-config-sophisticated BATMAN_V BATMAN_V_Tests Batman_v_throughput_experimental @@ -33,7 +32,6 @@ Contents: ELP Extended-isolation Faq - Filing Fragmentation-technical Gateways Kmalloc-kmem-cache-tests @@ -46,21 +44,15 @@ Contents: Multicast-optimizations-report-suppresion Multicast-optimizations Multicast-optimizations-tech - Multi-link-optimizations-technical - Multi-link-optimize-old Multi-link-optimize NetworkCoding NetworkCoding-technical Network-wide-multi-link-optimization OGM OGMv2 - Openwrt-package-builder - Outdated Packet-types Quick-start-guide - Release-todo RIP - SubmittingLinux Throughput_meter Troubleshooting TT-Flags diff --git a/open-mesh/Filing.rst b/open-mesh/Filing.rst deleted file mode 100644 index 2ba7245..0000000 --- a/open-mesh/Filing.rst +++ /dev/null @@ -1 +0,0 @@ -[[WikiStart]] diff --git a/open-mesh/TemplateDeprecated.rst b/open-mesh/TemplateDeprecated.rst deleted file mode 100644 index bbee036..0000000 --- a/open-mesh/TemplateDeprecated.rst +++ /dev/null @@ -1,4 +0,0 @@ -|image0| - -.. |image0| image:: /attachments/download/543/outdated.svg - diff --git a/open-mesh/index.rst b/open-mesh/index.rst index 6d4eafc..70813e9 100644 --- a/open-mesh/index.rst +++ b/open-mesh/index.rst @@ -16,7 +16,6 @@ Contents: Experience FAQ FFTrace - Filing Gsoc2010-ideas Gsoc2011-ideas Gsoc2011-roadmap @@ -32,7 +31,6 @@ Contents: News-draft ResearchProposals Routing_scenarios - TemplateDeprecated The-olsr-story UsingBatmanGit Wbmv4-batmandev-agenda

1 0

[doc] master: doc: Remove Linus' "junkyard" (4d38ccc)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 4d38cccb179e4a4884eda83fa5902f8d8e4f509d Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 20:31:17 2017 +0200 doc: Remove Linus' "junkyard" Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- batman-adv/T_X's_Junkyard.rst | 5 - ..._Junkyard_\342\200\223_BATMAN_V_Extensions.rst" | 129 ----- "batman-adv/T_X's_Junkyard_\342\200\223_MGO.rst" | 601 --------------------- ...rd_\342\200\223_Multicast_Snooping_Revised.rst" | 233 -------- ...223_Multicast_snooping_domain_segmentation.rst" | 57 -- "batman-adv/T_X's_Junkyard_\342\200\223_dTT.rst" | 47 -- ...casting-unsolicited-neighbor-advertisements.rst | 109 ---- batman-adv/index.rst | 7 - batman-adv/unsol-NA-flooded.dia | Bin 2246 -> 0 bytes batman-adv/unsol-NA-flooded.png | Bin 180627 -> 0 bytes batman-adv/unsol-NA-lost-data.dia | Bin 3440 -> 0 bytes batman-adv/unsol-NA-lost-data.png | Bin 137560 -> 0 bytes batman-adv/unsol-NA-unicast.dia | Bin 3423 -> 0 bytes batman-adv/unsol-NA-unicast.png | Bin 138956 -> 0 bytes 14 files changed, 1188 deletions(-) Diff suppressed because of size. To see it, use: git diff-tree --patch-with-stat --no-color --find-copies-harder --ignore-space-at-eol --cc 4d38cccb179e4a4884eda83fa5902f8d8e4f509d

1 0

[doc] master: doc: Fix link to Understand-your-batman-adv-network (64d95c0)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 64d95c07b80028d4fcb11555e9c56e7e0d30c4b3 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 20:29:51 2017 +0200 doc: Fix link to Understand-your-batman-adv-network Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- 64d95c07b80028d4fcb11555e9c56e7e0d30c4b3 batman-adv/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/batman-adv/index.rst b/batman-adv/index.rst index a9a29f4..ccac127 100644 --- a/batman-adv/index.rst +++ b/batman-adv/index.rst @@ -65,7 +65,7 @@ Contents: T_X's_Junkyard_–_Multicast_Snooping_Revised T_X's_Junkyard Uevent - Undand-your-batman-adv-network.rst + Understand-your-batman-adv-network Unicasting-unsolicited-neighbor-advertisements Using-batctl Wiki

1 0

[doc] master: doc: Fix malformed tables (69435a1)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 69435a1cf56ae3a465d25d72530b9570539251cb Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 17:28:27 2017 +0200 doc: Fix malformed tables Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- 69435a1cf56ae3a465d25d72530b9570539251cb batman-adv/Multicast-optimizations-tech.rst | 40 ++++++++++++------- batman-adv/TT-Flags.rst | 61 +++++++++++++++++------------ 2 files changed, 63 insertions(+), 38 deletions(-) diff --git a/batman-adv/Multicast-optimizations-tech.rst b/batman-adv/Multicast-optimizations-tech.rst index 3ee708a..30e43d6 100644 --- a/batman-adv/Multicast-optimizations-tech.rst +++ b/batman-adv/Multicast-optimizations-tech.rst @@ -114,20 +114,32 @@ other nodes, there are various limitations and exceptions. If multicast optimization is not supported for whatever reason, the packets will be sent as broadcast as a fallback solution. -+----------------------------+----------------------------------------------+---------------------------------------------+ -| *address range* | \\2=. *address family* | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| | **IPv4** | **IPv6** | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **all nodes link-scope** | =. supported without bridges¹. | =. supported without bridges¹. | -| | Example: 224.0.0.1 (all nodes) | Example: ff02::1 (all nodes) | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **link-local** | =. supported without bridges¹. | =. supported². | -| (excl. all nodes addr.) | Example: 224.0.0.251 (mDNS) | Example: ff12::39 (locally administrated) | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **routable** | =. support planned³. | =. support planned³. | -| | Example: 239.1.2.3 (locally administrated) | Example: ff0e::101 (NTP) | -+----------------------------+----------------------------------------------+---------------------------------------------+ +.. list-table:: + :stub-columns: 1 + :header-rows: 2 + + * - address range + - address family + - address family + * - + - IPv4 + - IPv6 + * - all nodes link-scope + - supported without bridges¹ + Example: 224.0.0.1 (all nodes) + - supported without bridges¹ + Example: ff02::1 (all nodes) + * - link-local + (excl. all nodes addr.) + - supported without bridges¹ + Example: 224.0.0.251 (mDNS) + - supported² + Example: ff12::39 (locally administrated) + * - routable + - support planned³ + Example: 239.1.2.3 (locally administrated) + - support planned³ + Example: ff0e::101 (NTP) ¹: These addresses cannot be considered for optimization towards nodes which have a bridge interface on top of their batman interface as they diff --git a/batman-adv/TT-Flags.rst b/batman-adv/TT-Flags.rst index 8e74190..fa04853 100644 --- a/batman-adv/TT-Flags.rst +++ b/batman-adv/TT-Flags.rst @@ -12,34 +12,47 @@ This section describes the flags used in the TT code, what they mean and where they are used. There are 3 possible locations where the flags field is used: -| \* OGM: there is a flag field within each of the tt\_change structs +* OGM: there is a flag field within each of the tt\_change structs which are sent along with the OGM frames. -| \* tt\_global: these structs are stored in the global hash table and +* tt\_global: these structs are stored in the global hash table and represent the mapping which originator hosts which client. -| \* tt\_local: these structs are stored in the local hash table and +* tt\_local: these structs are stored in the local hash table and represent the the clients which the own node hosts. -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| Name | used in | Description | -+=======================+==============================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================+==========================+ -| TT\_CLIENT\_DEL | OGM | The TT\_CLIENT\_DEL flag is used in the OGM tt\_change entries to distinguish whether the entry should be added (no DEL flag set) or deleted (DEL flag set). | -| | | It is also set to pass add/deletion information between functions internally. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_ROAM | OGM, tt\_global | The TT\_CLIENT\_ROAM flag is used to announce in an OGM tt\_change entry that a client is deleted because of roaming. The node which receives this entry may still send traffic to this node, which will re-route it to the new destination, until an OGM from the new node now hosting the client is received. The tt\_global entry with the old node for this client is then replaced with the new entry. | -| | | Other than thise case, whenever a node receives a Roaming\_Advertisement packet, it will add a new tt\_global entry which will create a new route to this client. This tt\_global entry is marked with the TT\_CLIENT\_ROAM flag so that it can be eventually deleted if no node will claim the client afterwards (with an ADD event) | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_WIFI | OGM, tt\_local, tt\_global | The TT\_CLIENT\_WIFI flag is used to announce that this client is a WiFi client. This information is used for the AP isolation feature. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_ISOLA | OGM, tt\_local, tt\_global | The TT\_CLIENT\_ISOLA flag is used to announce that packets sent by this client were marked with the isolation mark when received on the soft-interface. A node receiving packets from this client has to mark the related skbs with the configured isolation mark before delivering them to its own soft-interface. Moreover two clients marked with this flag cannot exchange packets over the mesh network (this behavior is part of the [[Extended-isolation | extended isolation]]). | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_NOPURGE | tt\_local | The private TT\_CLIENT\_NOPURGE is used to mark a local client to not be purged. This is only used for the address of the mesh soft interface, which should always be announced and never deleted/purged. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_NEW | tt\_local | The private TT\_CLIENT\_NEW flag is used to mark clients which have been added to the local list, but not yet announced within an OGM. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_PENDING | tt\_local | The private TT\_CLIENT\_PENDING flag is set for local entries which should be removed. These entries are not removed immediately, but when the next OGM is sent, to keep the information sent with the OGM or tt\_requests consistent. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT\_CLIENT\_TEMP | tt\_global | This flag is used to mark a client that has not been advertised by any node yet, but it has already been detected to be part of the network. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ +.. list-table:: + :stub-columns: 1 + :header-rows: 1 + + + * - Name + - used in + - Description + * - TT\_CLIENT\_DEL + - OGM + - The TT\_CLIENT\_DEL flag is used in the OGM tt\_change entries to distinguish whether the entry should be added (no DEL flag set) or deleted (DEL flag set). + It is also set to pass add/deletion information between functions internally. + * - TT\_CLIENT\_ROAM + - OGM, tt\_global + - The TT\_CLIENT\_ROAM flag is used to announce in an OGM tt\_change entry that a client is deleted because of roaming. The node which receives this entry may still send traffic to this node, which will re-route it to the new destination, until an OGM from the new node now hosting the client is received. The tt\_global entry with the old node for this client is then replaced with the new entry. + Other than thise case, whenever a node receives a Roaming\_Advertisement packet, it will add a new tt\_global entry which will create a new route to this client. This tt\_global entry is marked with the TT\_CLIENT\_ROAM flag so that it can be eventually deleted if no node will claim the client afterwards (with an ADD event) + * - TT\_CLIENT\_WIFI + - OGM, tt\_local, tt\_global + - The TT\_CLIENT\_WIFI flag is used to announce that this client is a WiFi client. This information is used for the AP isolation feature. + * - TT\_CLIENT\_ISOLA + - OGM, tt\_local, tt\_global + - The TT\_CLIENT\_ISOLA flag is used to announce that packets sent by this client were marked with the isolation mark when received on the soft-interface. A node receiving packets from this client has to mark the related skbs with the configured isolation mark before delivering them to its own soft-interface. Moreover two clients marked with this flag cannot exchange packets over the mesh network (this behavior is part of the [[Extended-isolation\|extended isolation]]). + * - TT\_CLIENT\_NOPURGE + - tt\_local + - The private TT\_CLIENT\_NOPURGE is used to mark a local client to not be purged. This is only used for the address of the mesh soft interface, which should always be announced and never deleted/purged. + * - TT\_CLIENT\_NEW + - tt\_local + - The private TT\_CLIENT\_NEW flag is used to mark clients which have been added to the local list, but not yet announced within an OGM. + * - TT\_CLIENT\_PENDING + - tt\_local + - The private TT\_CLIENT\_PENDING flag is set for local entries which should be removed. These entries are not removed immediately, but when the next OGM is sent, to keep the information sent with the OGM or tt\_requests consistent. + * - TT\_CLIENT\_TEMP + - tt\_global + - This flag is used to mark a client that has not been advertised by any node yet, but it has already been detected to be part of the network. Changes within in bridge loop avoidance II ------------------------------------------

1 0

[doc] master: doc: Remove sidebar pseudo files (e011df7)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit e011df785785700a76e9f9da1dad9d372c879e20 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 16:56:14 2017 +0200 doc: Remove sidebar pseudo files Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- e011df785785700a76e9f9da1dad9d372c879e20 alfred/Sidebar.rst | 7 ------- alfred/index.rst | 1 - batman-adv/Sidebar.rst | 7 ------- batman-adv/index.rst | 1 - batmand/Sidebar.rst | 7 ------- batmand/index.rst | 1 - open-mesh/Sidebar.rst | 7 ------- open-mesh/index.rst | 1 - 8 files changed, 32 deletions(-) diff --git a/alfred/Sidebar.rst b/alfred/Sidebar.rst deleted file mode 100644 index 1b10a27..0000000 --- a/alfred/Sidebar.rst +++ /dev/null @@ -1,7 +0,0 @@ -Wikis -~~~~~ - -| [[open-mesh:]] -| › [[batman-adv:]] -| » **[[alfred:]]** -| › [[batmand:]] diff --git a/alfred/index.rst b/alfred/index.rst index 3b39a48..fd40deb 100644 --- a/alfred/index.rst +++ b/alfred/index.rst @@ -12,7 +12,6 @@ Contents: Alfred Batadv-vis Building_information - Sidebar Wiki .. only:: subproject diff --git a/batman-adv/Sidebar.rst b/batman-adv/Sidebar.rst deleted file mode 100644 index 153fa3b..0000000 --- a/batman-adv/Sidebar.rst +++ /dev/null @@ -1,7 +0,0 @@ -Wikis -~~~~~ - -| [[open-mesh:]] -| ›  **[[batman-adv:]]** -| » [[alfred:]] -| › [[batmand:]] diff --git a/batman-adv/index.rst b/batman-adv/index.rst index 1549a73..5ae2227 100644 --- a/batman-adv/index.rst +++ b/batman-adv/index.rst @@ -60,7 +60,6 @@ Contents: Quick-start-guide Release-todo RIP - Sidebar SubmittingLinux Throughput_meter Troubleshooting diff --git a/batmand/Sidebar.rst b/batmand/Sidebar.rst deleted file mode 100644 index 419396f..0000000 --- a/batmand/Sidebar.rst +++ /dev/null @@ -1,7 +0,0 @@ -Wikis -~~~~~ - -| [[open-mesh:]] -| › [[batman-adv:]] -| » [[alfred:]] -| ›  **[[batmand:]]** diff --git a/batmand/index.rst b/batmand/index.rst index cd2989b..50b46d4 100644 --- a/batmand/index.rst +++ b/batmand/index.rst @@ -14,7 +14,6 @@ Contents: Faq InternetTuning RoutingVodoo - Sidebar VisOutput VisualizeMesh Why-starting-batman diff --git a/open-mesh/Sidebar.rst b/open-mesh/Sidebar.rst deleted file mode 100644 index e7d51e0..0000000 --- a/open-mesh/Sidebar.rst +++ /dev/null @@ -1,7 +0,0 @@ -Wikis -~~~~~ - -| **[[open-mesh:]]** -| › [[batman-adv:]] -| » [[alfred:]] -| › [[batmand:]] diff --git a/open-mesh/index.rst b/open-mesh/index.rst index c0c1fa4..6d4eafc 100644 --- a/open-mesh/index.rst +++ b/open-mesh/index.rst @@ -32,7 +32,6 @@ Contents: News-draft ResearchProposals Routing_scenarios - Sidebar TemplateDeprecated The-olsr-story UsingBatmanGit

1 0

[doc] master: doc: Remove recursive index include for batman-adv (e553c9a)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit e553c9a3ce2b50295c574be96071f1da16577a2e Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 16:55:03 2017 +0200 doc: Remove recursive index include for batman-adv Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- e553c9a3ce2b50295c574be96071f1da16577a2e batman-adv/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/batman-adv/index.rst b/batman-adv/index.rst index c6dda3d..1549a73 100644 --- a/batman-adv/index.rst +++ b/batman-adv/index.rst @@ -36,7 +36,6 @@ Contents: Filing Fragmentation-technical Gateways - index Kmalloc-kmem-cache-tests LinuxNextTracking Multicast-ideas

1 0

[doc] master: doc: Move images to projects (74cf321)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 74cf321fcc31f89c68967db809ec3482a4ac7265 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 15:49:50 2017 +0200 doc: Move images to projects >--------------------------------------------------------------- {attachments => alfred}/announce_master.dia | 0 {attachments => alfred}/announce_master.png | Bin {attachments => alfred}/batman-adv-vis-example.dot | 0 {attachments => alfred}/batman-adv-vis-example.png | Bin {attachments => alfred}/general_structure.dia | 0 {attachments => alfred}/general_structure.png | Bin {attachments => alfred}/master_selection.dia | 0 {attachments => alfred}/master_selection.png | Bin {attachments => alfred}/node_architecture_master.dia | 0 {attachments => alfred}/node_architecture_master.png | Bin {attachments => alfred}/node_architecture_slave.dia | 0 {attachments => alfred}/node_architecture_slave.png | Bin {attachments => alfred}/packet_announce_master_v0.dia | 0 {attachments => alfred}/packet_announce_master_v0.png | Bin {attachments => alfred}/packet_push_data_v0.dia | 0 {attachments => alfred}/packet_push_data_v0.png | Bin {attachments => alfred}/packet_request_v0.dia | 0 {attachments => alfred}/packet_request_v0.png | Bin {attachments => alfred}/packet_status_v0_end.dia | 0 {attachments => alfred}/packet_status_v0_end.png | Bin {attachments => alfred}/packet_status_v0_error.dia | 0 {attachments => alfred}/packet_status_v0_error.png | Bin {attachments => alfred}/synchronization.dia | 0 {attachments => alfred}/synchronization.png | Bin {attachments => batman-adv}/2mesh2lan.dia | Bin {attachments => batman-adv}/2mesh2lan.png | Bin {attachments => batman-adv}/Bw1.dia | Bin {attachments => batman-adv}/Bw1.png | Bin {attachments => batman-adv}/Flowchart.dia | Bin {attachments => batman-adv}/Flowchart.svg | 0 {attachments => batman-adv}/LAN_mesh.dia | Bin {attachments => batman-adv}/LAN_mesh.dia.png | Bin {attachments => batman-adv}/LAN_mesh_LAN.dia | Bin {attachments => batman-adv}/LAN_mesh_LAN.dia.png | Bin {attachments => batman-adv}/LAN_mesh_unicast.dia | Bin {attachments => batman-adv}/LAN_mesh_unicast.dia.png | Bin {attachments => batman-adv}/Test_2xLAN.dia | Bin {attachments => batman-adv}/Test_2xLAN.dia.png | Bin {attachments => batman-adv}/Test_2xmesh.dia | Bin {attachments => batman-adv}/Test_2xmesh.dia.png | Bin {attachments => batman-adv}/Test_gateway_selection.dia.png | Bin {attachments => batman-adv}/Test_limited_horizon.dia | Bin {attachments => batman-adv}/Test_limited_horizon.dia.png | Bin {attachments => batman-adv}/Test_roaming_LAN_mesh.dia | Bin {attachments => batman-adv}/Test_roaming_LAN_mesh.dia.png | Bin {attachments => batman-adv}/Test_roaming_mesh_LAN.dia | Bin {attachments => batman-adv}/Test_roaming_mesh_LAN.dia.png | Bin {attachments => batman-adv}/alice_bob_coding.jpg | Bin {attachments => batman-adv}/alternating-limited-view.dia | Bin {attachments => batman-adv}/alternating-limited-view.png | Bin {attachments => batman-adv}/alternation_chain.dia | Bin {attachments => batman-adv}/alternation_chain.dia.jpg | Bin {attachments => batman-adv}/ap-isola-75.png | Bin .../basic-multicast-bridge-scenario.dia | Bin .../basic-multicast-bridge-scenario.png | Bin .../basic-multicast-listener-announce.dia | Bin .../basic-multicast-listener-announce.png | Bin .../basic-multicast-listener-mldv1report-canceled-data.dia | Bin .../basic-multicast-listener-mldv1report-canceled-data.png | Bin .../basic-multicast-listener-mldv1report-canceled.dia | Bin .../basic-multicast-listener-mldv1report-canceled.png | Bin ...-multicast-listener-mldv1report-mcast-versions-flood.dia | Bin ...-multicast-listener-mldv1report-mcast-versions-flood.png | Bin ...lticast-listener-mldv1report-mcast-versions-nobridge.dia | Bin ...lticast-listener-mldv1report-mcast-versions-nobridge.png | Bin ...multicast-listener-mldv1report-mcast-versions-search.dia | Bin ...multicast-listener-mldv1report-mcast-versions-search.png | Bin .../basic-multicast-listener-mldv1report-mcast-versions.dia | Bin .../basic-multicast-listener-mldv1report-mcast-versions.png | Bin .../basic-multicast-listener-mldv1report.dia | Bin .../basic-multicast-listener-mldv1report.png | Bin .../basic-multicast-multiple-receivers.dia | Bin .../basic-multicast-multiple-receivers.png | Bin {attachments => batman-adv}/basic-multicast-no-receiver.dia | Bin {attachments => batman-adv}/basic-multicast-no-receiver.png | Bin .../basic-multicast-querier-no-listener.dia | Bin .../basic-multicast-querier-no-listener.png | Bin .../basic-multicast-querier-scenario-query.dia | Bin .../basic-multicast-querier-scenario-query.png | Bin .../basic-multicast-querier-scenario-report.dia | Bin .../basic-multicast-querier-scenario-report.png | Bin .../basic-multicast-querier-scenario.dia | Bin .../basic-multicast-querier-scenario.png | Bin .../basic-multicast-querier-want-#1.dia | Bin .../basic-multicast-querier-want-#1.png | Bin .../basic-multicast-querier-want-#2.dia | Bin .../basic-multicast-querier-want-#2.png | Bin .../basic-multicast-querier-want-#3.dia | Bin .../basic-multicast-querier-want-#3.png | Bin .../basic-multicast-querier-want.dia | Bin .../basic-multicast-querier-want.png | Bin .../basic-multicast-sender-receiver.dia | Bin .../basic-multicast-sender-receiver.png | Bin .../basic-multicast-single-receiver.dia | Bin .../basic-multicast-single-receiver.png | Bin .../basic-multicast-snoopables-announce.dia | Bin .../basic-multicast-snoopables-announce.png | Bin .../basic-multicast-snoopables-no-querier.dia | Bin .../basic-multicast-snoopables-no-querier.png | Bin .../basic-multicast-snoopables-shadowing-querier.dia | Bin .../basic-multicast-snoopables-shadowing-querier.png | Bin .../basic-multicast-snoopables-unknown.dia | Bin .../basic-multicast-snoopables-unknown.png | Bin .../basic-multicast-snooping-switch.dia | Bin .../basic-multicast-snooping-switch.png | Bin .../basic-multicast-switch-uncertain.dia | Bin .../basic-multicast-switch-uncertain.png | Bin {attachments => batman-adv}/basic-multicast-switch.dia | Bin {attachments => batman-adv}/basic-multicast-switch.png | Bin {attachments => batman-adv}/batman-l2-l3.dia | Bin {attachments => batman-adv}/batman-l2-l3.png | Bin {attachments => batman-adv}/batman_ogm.png | Bin {attachments => batman-adv}/batman_ogm.svg | 0 {attachments => batman-adv}/batman_structure.png | Bin {attachments => batman-adv}/batman_structure.svg | 0 {attachments => batman-adv}/bcast-avoid-no-neighbor.dia | Bin {attachments => batman-adv}/bcast-avoid-no-neighbor.png | Bin {attachments => batman-adv}/bcast-avoid-single-fwd.dia | Bin {attachments => batman-adv}/bcast-avoid-single-fwd.png | Bin {attachments => batman-adv}/bcast-avoid-single-orig.dia | Bin {attachments => batman-adv}/bcast-avoid-single-orig.png | Bin {attachments => batman-adv}/bonding_2hops.png | Bin {attachments => batman-adv}/bonding_roundrobin.dia | Bin {attachments => batman-adv}/bonding_roundrobin.dia.jpg | Bin {attachments => batman-adv}/bottle.dia | Bin {attachments => batman-adv}/bottle.png | Bin {attachments => batman-adv}/circle-v2.dia | Bin {attachments => batman-adv}/circle-v2.png | Bin {attachments => batman-adv}/circle.dia | Bin {attachments => batman-adv}/circle.png | Bin {attachments => batman-adv}/claimtypes.dia | Bin {attachments => batman-adv}/claimtypes.dia.png | Bin {attachments => batman-adv}/dat-net.dia | Bin {attachments => batman-adv}/dat-net.png | Bin {attachments => batman-adv}/dat-net2.dia | Bin {attachments => batman-adv}/dat-net2.png | Bin {attachments => batman-adv}/dat_dht-90.png | Bin {attachments => batman-adv}/ext-isola.png | Bin {attachments => batman-adv}/first_fragment.png | Bin {attachments => batman-adv}/gateway1.png | Bin {attachments => batman-adv}/gateway2.png | Bin {attachments => batman-adv}/gateway_selection.dia | Bin {attachments => batman-adv}/gateway_selection.dia.png | Bin {attachments => batman-adv}/interface_detection.dia | Bin {attachments => batman-adv}/interface_detection.dia.jpg | Bin {attachments => batman-adv}/kmalloc-kmem-cache-setup.dia | Bin {attachments => batman-adv}/kmalloc-kmem-cache-setup.png | Bin {attachments => batman-adv}/kmalloc_vs_kmem-cache.png | Bin {attachments => batman-adv}/lanloop1.png | Bin {attachments => batman-adv}/lanloop2.png | Bin {attachments => batman-adv}/lanloop3.png | Bin {attachments => batman-adv}/mesh_LAN.dia | Bin {attachments => batman-adv}/mesh_LAN.dia.png | Bin {attachments => batman-adv}/mesh_LAN_mesh.dia | Bin {attachments => batman-adv}/mesh_LAN_mesh.dia.png | Bin {attachments => batman-adv}/mesh_LAN_unicast.dia | Bin {attachments => batman-adv}/mesh_LAN_unicast.dia.png | Bin {attachments => batman-adv}/mob_node.dia | Bin {attachments => batman-adv}/mob_node.png | Bin {attachments => batman-adv}/mobile-clusters.dia | Bin {attachments => batman-adv}/mobile-clusters.png | Bin .../multicast-listener-fetching-no-bridge.dia | Bin .../multicast-listener-fetching-no-bridge.png | Bin .../multicast-listener-fetching-with-bridge.dia | Bin .../multicast-listener-fetching-with-bridge.png | Bin {attachments => batman-adv}/nc_gain.png | Bin {attachments => batman-adv}/net-wide-multiif.dia | Bin {attachments => batman-adv}/net-wide-multiif.png | Bin {attachments => batman-adv}/new_dist_neigh.dia | Bin {attachments => batman-adv}/new_dist_neigh.png | Bin {attachments => batman-adv}/new_neigh.dia | Bin {attachments => batman-adv}/new_neigh.png | Bin {attachments => batman-adv}/ogm_step1.png | Bin {attachments => batman-adv}/ogm_step2.png | Bin {attachments => batman-adv}/packet_pool.png | Bin {attachments => batman-adv}/primary_flag.dia | Bin {attachments => batman-adv}/primary_flag.png | Bin {attachments => batman-adv}/ptp-adsl.dia | Bin {attachments => batman-adv}/ptp-adsl.png | Bin {attachments => batman-adv}/quagga_integration.png | Bin {attachments => batman-adv}/rebroadcast-eval1.dia | Bin {attachments => batman-adv}/rebroadcast-eval1.png | Bin {attachments => batman-adv}/rebroadcast-eval2.dia | Bin {attachments => batman-adv}/rebroadcast-eval2.png | Bin {attachments => batman-adv}/rebroadcast-eval3.dia | Bin {attachments => batman-adv}/rebroadcast-eval3.png | Bin {attachments => batman-adv}/rebroadcasts.dia | Bin {attachments => batman-adv}/rebroadcasts.png | Bin {attachments => batman-adv}/roaming.png | Bin {attachments => batman-adv}/rx.png | Bin {attachments => batman-adv}/second_fragment.png | Bin {attachments => batman-adv}/situation.dia | Bin {attachments => batman-adv}/situation.dia.png | Bin {attachments => batman-adv}/tcp.png | Bin {attachments => batman-adv}/tcp_uni.png | Bin {attachments => batman-adv}/third_fragment.png | Bin {attachments => batman-adv}/topology-scheme.png | Bin {attachments => batman-adv}/triangle.dia | Bin {attachments => batman-adv}/triangle.png | Bin {attachments => batman-adv}/tx.png | Bin {attachments => batman-adv}/unsol-NA-flooded.dia | Bin {attachments => batman-adv}/unsol-NA-flooded.png | Bin {attachments => batman-adv}/unsol-NA-lost-data.dia | Bin {attachments => batman-adv}/unsol-NA-lost-data.png | Bin {attachments => batman-adv}/unsol-NA-unicast.dia | Bin {attachments => batman-adv}/unsol-NA-unicast.png | Bin {attachments => batman-adv}/wired-aps.dia | Bin {attachments => batman-adv}/wired-aps.png | Bin {attachments => batman-adv}/x_nc.png | Bin {attachments => batmand}/08-vis_zoomed.png | Bin {attachments => open-mesh}/asym_link.dia | Bin {attachments => open-mesh}/asym_link.png | Bin {attachments => open-mesh}/asym_path.dia | Bin {attachments => open-mesh}/asym_path.png | Bin .../batlogo_boot_screenshort_400px.jpg | Bin {attachments => open-mesh}/batlogo_transparent.png | Bin {attachments => open-mesh}/batlogo_transparent.svg | 0 {attachments => open-mesh}/batman_logo_menu.png | Bin {attachments => open-mesh}/bottle.dia | Bin {attachments => open-mesh}/bottle.png | Bin {attachments => open-mesh}/circle-v2.dia | Bin {attachments => open-mesh}/circle-v2.png | Bin {attachments => open-mesh}/circle.dia | Bin {attachments => open-mesh}/circle.png | Bin {attachments => open-mesh}/mesh.gif | Bin {attachments => open-mesh}/mob_node.dia | Bin {attachments => open-mesh}/mob_node.png | Bin {attachments => open-mesh}/new_dist_neigh.dia | Bin {attachments => open-mesh}/new_dist_neigh.png | Bin {attachments => open-mesh}/new_neigh.dia | Bin {attachments => open-mesh}/new_neigh.png | Bin {attachments => open-mesh}/triangle.dia | Bin {attachments => open-mesh}/triangle.png | Bin {attachments => open-mesh}/vde_switch.png | Bin 234 files changed, 0 insertions(+), 0 deletions(-) Diff suppressed because of size. To see it, use: git diff-tree --patch-with-stat --no-color --find-copies-harder --ignore-space-at-eol --cc 74cf321fcc31f89c68967db809ec3482a4ac7265

1 0

[doc] master: doc: Add basic sphinx infrastucture (4c80190)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 4c80190cd36b6ab21b2a9fcea906576d14392e11 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 15:36:15 2017 +0200 doc: Add basic sphinx infrastucture >--------------------------------------------------------------- 4c80190cd36b6ab21b2a9fcea906576d14392e11 Makefile | 225 ++++++++++++++++++++++++++++++++++ alfred/index.rst | 23 ++++ batman-adv/index.rst | 88 ++++++++++++++ batmand/index.rst | 27 ++++ conf.py | 338 +++++++++++++++++++++++++++++++++++++++++++++++++++ index.rst | 25 ++++ open-mesh/index.rst | 49 ++++++++ 7 files changed, 775 insertions(+) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7aae001 --- /dev/null +++ b/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/open-meshorg.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/open-meshorg.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/open-meshorg" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/open-meshorg" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/alfred/index.rst b/alfred/index.rst new file mode 100644 index 0000000..3b39a48 --- /dev/null +++ b/alfred/index.rst @@ -0,0 +1,23 @@ +alfred +====== + +Contents: + +.. toctree:: + :maxdepth: 2 + + Alfred_architecture + Alfred-gpsd + Alfred-output-format-proposal + Alfred + Batadv-vis + Building_information + Sidebar + Wiki + +.. only:: subproject + + Indices + ======= + + * :ref:`genindex` diff --git a/batman-adv/index.rst b/batman-adv/index.rst new file mode 100644 index 0000000..c6dda3d --- /dev/null +++ b/batman-adv/index.rst @@ -0,0 +1,88 @@ +batman-adv +========== + +Contents: + +.. toctree:: + :maxdepth: 2 + + Ap-isolation + Bandwidth_meter_technical + Bandwidth_meter_tests + Batman-adv-openwrt-config + Batman-adv-openwrt-config-sophisticated + BATMAN_V + BATMAN_V_Tests + Batman_v_throughput_experimental + Bcast-hidden-node + Bridge-loop-avoidance-II + Bridge-loop-avoidance-Protocol + Bridge-loop-avoidance + Bridge-loop-avoidance-Testcases + Broadcast-Avoidances-NHH-Assessment + Broadcast-Avoidances + Building-with-openwrt + Client-announcement + Client-roaming + Compatversion + Connecting-Batman-adv-clouds + Debian_batman-adv_AutoStartup + DistributedArpTable + DistributedArpTable-technical + Doc-overview + ELP + Extended-isolation + Faq + Filing + Fragmentation-technical + Gateways + index + Kmalloc-kmem-cache-tests + LinuxNextTracking + Multicast-ideas + Multicast-ideas-updated + Multicast-optimizations-bridges + Multicast-optimizations-flags + Multicast-optimizations-listener-reports + Multicast-optimizations-report-suppresion + Multicast-optimizations + Multicast-optimizations-tech + Multi-link-optimizations-technical + Multi-link-optimize-old + Multi-link-optimize + NetworkCoding + NetworkCoding-technical + Network-wide-multi-link-optimization + OGM + OGMv2 + Openwrt-package-builder + Outdated + Packet-types + Quick-start-guide + Release-todo + RIP + Sidebar + SubmittingLinux + Throughput_meter + Troubleshooting + TT-Flags + TVLV + Tweaking + T_X's_Junkyard_–_BATMAN_V_Extensions + T_X's_Junkyard_–_dTT + T_X's_Junkyard_–_MGO + T_X's_Junkyard_–_Multicast_snooping_domain_segmentation + T_X's_Junkyard_–_Multicast_Snooping_Revised + T_X's_Junkyard + Uevent + Undand-your-batman-adv-network.rst + Unicasting-unsolicited-neighbor-advertisements + Using-batctl + Wiki + +.. only:: subproject + + Indices + ======= + + * :ref:`genindex` diff --git a/batmand/index.rst b/batmand/index.rst new file mode 100644 index 0000000..cd2989b --- /dev/null +++ b/batmand/index.rst @@ -0,0 +1,27 @@ +batmand +======= + +Contents: + +.. toctree:: + :maxdepth: 2 + + AnnouncingNetworks + BerlinExperience + Coredump + DebugOutput + Doc-overview + Faq + InternetTuning + RoutingVodoo + Sidebar + VisOutput + VisualizeMesh + Why-starting-batman + +.. only:: subproject + + Indices + ======= + + * :ref:`genindex` diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..64372d6 --- /dev/null +++ b/conf.py @@ -0,0 +1,338 @@ +# -*- coding: utf-8 -*- +# +# open-mesh.org documentation build configuration file, created by +# sphinx-quickstart on Thu Jul 13 15:21:39 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'open-mesh.org' +copyright = u'2017, B.A.T.M.A.N. developers' +author = u'B.A.T.M.A.N. developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'latest' +# The full version, including alpha/beta/rc tags. +release = u'latest' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# "<project> v<release> documentation" by default. +# +# html_title = u'open-mesh.org v2017.0' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'open-meshorgdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'open-meshorg.tex', u'open-mesh.org Documentation', + u'B.A.T.M.A.N. developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'open-meshorg', u'open-mesh.org Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'open-meshorg', u'open-mesh.org Documentation', + author, 'open-meshorg', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False diff --git a/index.rst b/index.rst new file mode 100644 index 0000000..7f88ade --- /dev/null +++ b/index.rst @@ -0,0 +1,25 @@ +.. open-mesh.org documentation master file, created by + sphinx-quickstart on Thu Jul 13 15:21:39 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to open-mesh.org's documentation! +========================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + batman-adv/index + alfred/index + batmand/index + open-mesh/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/open-mesh/index.rst b/open-mesh/index.rst new file mode 100644 index 0000000..c0c1fa4 --- /dev/null +++ b/open-mesh/index.rst @@ -0,0 +1,49 @@ +open-mesh +========= + +Contents: + +.. toctree:: + :maxdepth: 2 + + BatmanAdvBootLogo + BATMANConcept + BranchesExplained + Contribute + Download + Emulation_Debug + Emulation + Experience + FAQ + FFTrace + Filing + Gsoc2010-ideas + Gsoc2011-ideas + Gsoc2011-roadmap + Gsoc2012-ideas + IRC + Joker + Logos + MailingList + MeshLinux + NetworkingTechnologies + New_papers + News-archive + News-draft + ResearchProposals + Routing_scenarios + Sidebar + TemplateDeprecated + The-olsr-story + UsingBatmanGit + Wbmv4-batmandev-agenda + Wbmv5-batmandev-agenda + Wbmv6-batmandev-agenda + WikiStart + +.. only:: subproject + + Indices + ======= + + * :ref:`genindex`

1 0

[doc] master: doc: Convert from textile to reStructuredText with pandoc (4875465)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 4875465bfbc65731286ded11a9c4d6f6ee7361d2 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 15:18:54 2017 +0200 doc: Convert from textile to reStructuredText with pandoc >--------------------------------------------------------------- alfred/Alfred-gpsd.rst | 15 + alfred/Alfred-gpsd.textile | 5 - alfred/Alfred-output-format-proposal.rst | 130 ++++ alfred/Alfred-output-format-proposal.textile | 112 --- alfred/Alfred.rst | 133 ++++ alfred/Alfred.textile | 75 -- alfred/Alfred_architecture.rst | 309 +++++++++ alfred/Alfred_architecture.textile | 145 ---- alfred/Batadv-vis.rst | 21 + alfred/Batadv-vis.textile | 7 - alfred/Building_information.rst | 46 ++ alfred/Building_information.textile | 36 - alfred/Sidebar.rst | 7 + alfred/Sidebar.textile | 6 - alfred/Wiki.rst | 52 ++ alfred/Wiki.textile | 28 - batman-adv/Ap-isolation.rst | 85 +++ batman-adv/Ap-isolation.textile | 36 - batman-adv/BATMAN_V.rst | 130 ++++ batman-adv/BATMAN_V.textile | 52 -- batman-adv/BATMAN_V_Tests.rst | 295 ++++++++ batman-adv/BATMAN_V_Tests.textile | 267 -------- batman-adv/Bandwidth_meter_technical.rst | 80 +++ batman-adv/Bandwidth_meter_technical.textile | 42 -- batman-adv/Bandwidth_meter_tests.rst | 198 ++++++ batman-adv/Bandwidth_meter_tests.textile | 115 ---- .../Batman-adv-openwrt-config-sophisticated.rst | 139 ++++ ...Batman-adv-openwrt-config-sophisticated.textile | 208 ------ batman-adv/Batman-adv-openwrt-config.rst | 174 +++++ batman-adv/Batman-adv-openwrt-config.textile | 125 ---- batman-adv/Batman_v_throughput_experimental.rst | 98 +++ .../Batman_v_throughput_experimental.textile | 52 -- batman-adv/Bcast-hidden-node.rst | 56 ++ batman-adv/Bcast-hidden-node.textile | 21 - batman-adv/Bridge-loop-avoidance-II.rst | 260 +++++++ batman-adv/Bridge-loop-avoidance-II.textile | 148 ---- batman-adv/Bridge-loop-avoidance-Protocol.rst | 277 ++++++++ batman-adv/Bridge-loop-avoidance-Protocol.textile | 218 ------ batman-adv/Bridge-loop-avoidance-Testcases.rst | 93 +++ batman-adv/Bridge-loop-avoidance-Testcases.textile | 58 -- batman-adv/Bridge-loop-avoidance.rst | 108 +++ batman-adv/Bridge-loop-avoidance.textile | 57 -- batman-adv/Broadcast-Avoidances-NHH-Assessment.rst | 298 ++++++++ .../Broadcast-Avoidances-NHH-Assessment.textile | 225 ------ batman-adv/Broadcast-Avoidances.rst | 310 +++++++++ batman-adv/Broadcast-Avoidances.textile | 194 ------ batman-adv/Building-with-openwrt.rst | 259 +++++++ batman-adv/Building-with-openwrt.textile | 196 ------ batman-adv/Client-announcement.rst | 228 +++++++ batman-adv/Client-announcement.textile | 93 --- batman-adv/Client-roaming.rst | 149 ++++ batman-adv/Client-roaming.textile | 49 -- batman-adv/Compatversion.rst | 48 ++ batman-adv/Compatversion.textile | 25 - batman-adv/Connecting-Batman-adv-clouds.rst | 231 +++++++ batman-adv/Connecting-Batman-adv-clouds.textile | 102 --- batman-adv/Debian_batman-adv_AutoStartup.rst | 172 +++++ batman-adv/Debian_batman-adv_AutoStartup.textile | 148 ---- batman-adv/DistributedArpTable-technical.rst | 192 ++++++ batman-adv/DistributedArpTable-technical.textile | 76 --- batman-adv/DistributedArpTable.rst | 95 +++ batman-adv/DistributedArpTable.textile | 40 -- batman-adv/Doc-overview.rst | 128 ++++ batman-adv/Doc-overview.textile | 66 -- batman-adv/ELP.rst | 135 ++++ batman-adv/ELP.textile | 93 --- batman-adv/Extended-isolation.rst | 137 ++++ batman-adv/Extended-isolation.textile | 68 -- batman-adv/Faq.rst | 275 ++++++++ batman-adv/Faq.textile | 144 ---- batman-adv/Filing.rst | 4 + batman-adv/Filing.textile | 3 - batman-adv/Fragmentation-technical.rst | 144 ++++ batman-adv/Fragmentation-technical.textile | 82 --- batman-adv/Gateways.rst | 151 ++++ batman-adv/Gateways.textile | 84 --- batman-adv/Kmalloc-kmem-cache-tests.rst | 273 ++++++++ batman-adv/Kmalloc-kmem-cache-tests.textile | 170 ----- batman-adv/LinuxNextTracking.rst | 80 +++ batman-adv/LinuxNextTracking.textile | 61 -- batman-adv/Multi-link-optimizations-technical.rst | 159 +++++ .../Multi-link-optimizations-technical.textile | 80 --- batman-adv/Multi-link-optimize-old.rst | 77 +++ batman-adv/Multi-link-optimize-old.textile | 39 -- batman-adv/Multi-link-optimize.rst | 111 +++ batman-adv/Multi-link-optimize.textile | 49 -- batman-adv/Multicast-ideas-updated.rst | 757 +++++++++++++++++++++ batman-adv/Multicast-ideas-updated.textile | 476 ------------- batman-adv/Multicast-ideas.rst | 316 +++++++++ batman-adv/Multicast-ideas.textile | 150 ---- batman-adv/Multicast-optimizations-bridges.rst | 68 ++ batman-adv/Multicast-optimizations-bridges.textile | 33 - batman-adv/Multicast-optimizations-flags.rst | 169 +++++ batman-adv/Multicast-optimizations-flags.textile | 101 --- .../Multicast-optimizations-listener-reports.rst | 164 +++++ ...ulticast-optimizations-listener-reports.textile | 91 --- .../Multicast-optimizations-report-suppresion.rst | 152 +++++ ...lticast-optimizations-report-suppresion.textile | 80 --- batman-adv/Multicast-optimizations-tech.rst | 209 ++++++ batman-adv/Multicast-optimizations-tech.textile | 121 ---- batman-adv/Multicast-optimizations.rst | 106 +++ batman-adv/Multicast-optimizations.textile | 56 -- .../Network-wide-multi-link-optimization.rst | 200 ++++++ .../Network-wide-multi-link-optimization.textile | 124 ---- batman-adv/NetworkCoding-technical.rst | 238 +++++++ batman-adv/NetworkCoding-technical.textile | 141 ---- batman-adv/NetworkCoding.rst | 120 ++++ batman-adv/NetworkCoding.textile | 56 -- batman-adv/OGM.rst | 701 +++++++++++++++++++ batman-adv/OGM.textile | 360 ---------- batman-adv/OGMv2.rst | 221 ++++++ batman-adv/OGMv2.textile | 133 ---- ...builder.textile => Openwrt-package-builder.rst} | 3 +- batman-adv/Outdated.rst | 1 + batman-adv/Outdated.textile | 1 - batman-adv/Packet-types.rst | 44 ++ batman-adv/Packet-types.textile | 19 - batman-adv/Quick-start-guide.rst | 175 +++++ batman-adv/Quick-start-guide.textile | 103 --- batman-adv/RIP.rst | 129 ++++ batman-adv/RIP.textile | 54 -- batman-adv/Release-todo.rst | 81 +++ batman-adv/Release-todo.textile | 56 -- batman-adv/Sidebar.rst | 7 + batman-adv/Sidebar.textile | 6 - batman-adv/SubmittingLinux.rst | 563 +++++++++++++++ batman-adv/SubmittingLinux.textile | 496 -------------- batman-adv/TT-Flags.rst | 146 ++++ batman-adv/TT-Flags.textile | 76 --- batman-adv/TVLV.rst | 338 +++++++++ batman-adv/TVLV.textile | 261 ------- batman-adv/T_X's_Junkyard.rst | 5 + batman-adv/T_X's_Junkyard.textile | 3 - ..._Junkyard_\342\200\223_BATMAN_V_Extensions.rst" | 129 ++++ ...kyard_\342\200\223_BATMAN_V_Extensions.textile" | 65 -- "batman-adv/T_X's_Junkyard_\342\200\223_MGO.rst" | 601 ++++++++++++++++ .../T_X's_Junkyard_\342\200\223_MGO.textile" | 369 ---------- ...rd_\342\200\223_Multicast_Snooping_Revised.rst" | 233 +++++++ ...342\200\223_Multicast_Snooping_Revised.textile" | 136 ---- ...223_Multicast_snooping_domain_segmentation.rst" | 57 ++ ...Multicast_snooping_domain_segmentation.textile" | 25 - "batman-adv/T_X's_Junkyard_\342\200\223_dTT.rst" | 47 ++ .../T_X's_Junkyard_\342\200\223_dTT.textile" | 21 - batman-adv/Throughput_meter.rst | 78 +++ batman-adv/Throughput_meter.textile | 40 -- batman-adv/Troubleshooting.rst | 127 ++++ batman-adv/Troubleshooting.textile | 68 -- batman-adv/Tweaking.rst | 526 ++++++++++++++ batman-adv/Tweaking.textile | 305 --------- batman-adv/Uevent.rst | 89 +++ batman-adv/Uevent.textile | 58 -- batman-adv/Understand-your-batman-adv-network.rst | 438 ++++++++++++ .../Understand-your-batman-adv-network.textile | 313 --------- ...casting-unsolicited-neighbor-advertisements.rst | 109 +++ ...ing-unsolicited-neighbor-advertisements.textile | 62 -- batman-adv/Using-batctl.rst | 44 ++ batman-adv/Using-batctl.textile | 27 - batman-adv/Wiki.rst | 59 ++ batman-adv/Wiki.textile | 29 - batmand/AnnouncingNetworks.rst | 51 ++ batmand/AnnouncingNetworks.textile | 41 -- batmand/BerlinExperience.rst | 34 + batmand/BerlinExperience.textile | 14 - batmand/Coredump.rst | 69 ++ batmand/Coredump.textile | 36 - batmand/DebugOutput.rst | 81 +++ batmand/DebugOutput.textile | 48 -- batmand/Doc-overview.rst | 54 ++ batmand/Doc-overview.textile | 29 - batmand/Faq.rst | 102 +++ batmand/Faq.textile | 62 -- batmand/InternetTuning.rst | 205 ++++++ batmand/InternetTuning.textile | 128 ---- batmand/RoutingVodoo.rst | 139 ++++ batmand/RoutingVodoo.textile | 82 --- batmand/Sidebar.rst | 7 + batmand/Sidebar.textile | 6 - batmand/VisOutput.rst | 105 +++ batmand/VisOutput.textile | 83 --- batmand/VisualizeMesh.rst | 78 +++ batmand/VisualizeMesh.textile | 47 -- batmand/Why-starting-batman.rst | 41 ++ batmand/Why-starting-batman.textile | 12 - open-mesh/BATMANConcept.rst | 75 ++ open-mesh/BATMANConcept.textile | 18 - open-mesh/BatmanAdvBootLogo.rst | 46 ++ open-mesh/BatmanAdvBootLogo.textile | 31 - open-mesh/BranchesExplained.rst | 103 +++ open-mesh/BranchesExplained.textile | 51 -- open-mesh/Contribute.rst | 129 ++++ open-mesh/Contribute.textile | 89 --- open-mesh/Download.rst | 224 ++++++ open-mesh/Download.textile | 112 --- open-mesh/Emulation.rst | 322 +++++++++ open-mesh/Emulation.textile | 243 ------- open-mesh/Emulation_Debug.rst | 255 +++++++ open-mesh/Emulation_Debug.textile | 239 ------- open-mesh/Experience.rst | 95 +++ open-mesh/Experience.textile | 42 -- open-mesh/FAQ.rst | 16 + open-mesh/FAQ.textile | 13 - open-mesh/FFTrace.rst | 31 + open-mesh/FFTrace.textile | 11 - open-mesh/Filing.rst | 1 + open-mesh/Filing.textile | 1 - open-mesh/Gsoc2010-ideas.rst | 206 ++++++ open-mesh/Gsoc2010-ideas.textile | 89 --- open-mesh/Gsoc2011-ideas.rst | 279 ++++++++ open-mesh/Gsoc2011-ideas.textile | 131 ---- open-mesh/Gsoc2011-roadmap.rst | 17 + open-mesh/Gsoc2011-roadmap.textile | 15 - open-mesh/Gsoc2012-ideas.rst | 12 + open-mesh/Gsoc2012-ideas.textile | 9 - open-mesh/IRC.rst | 11 + open-mesh/IRC.textile | 10 - open-mesh/Joker.rst | 225 ++++++ open-mesh/Joker.textile | 141 ---- open-mesh/Logos.rst | 14 + open-mesh/Logos.textile | 7 - open-mesh/MailingList.rst | 14 + open-mesh/MailingList.textile | 7 - open-mesh/MeshLinux.rst | 27 + open-mesh/MeshLinux.textile | 7 - open-mesh/NetworkingTechnologies.rst | 40 ++ open-mesh/NetworkingTechnologies.textile | 31 - open-mesh/New_papers.rst | 706 +++++++++++++++++++ open-mesh/New_papers.textile | 232 ------- .../{News-archive.textile => News-archive.rst} | 9 +- open-mesh/News-draft.rst | 122 ++++ open-mesh/News-draft.textile | 116 ---- open-mesh/ResearchProposals.rst | 86 +++ open-mesh/ResearchProposals.textile | 75 -- open-mesh/Routing_scenarios.rst | 89 +++ open-mesh/Routing_scenarios.textile | 73 -- open-mesh/Sidebar.rst | 7 + open-mesh/Sidebar.textile | 6 - open-mesh/TemplateDeprecated.rst | 4 + open-mesh/TemplateDeprecated.textile | 1 - open-mesh/The-olsr-story.rst | 278 ++++++++ open-mesh/The-olsr-story.textile | 124 ---- open-mesh/UsingBatmanGit.rst | 63 ++ open-mesh/UsingBatmanGit.textile | 48 -- open-mesh/Wbmv4-batmandev-agenda.rst | 28 + open-mesh/Wbmv4-batmandev-agenda.textile | 23 - open-mesh/Wbmv5-batmandev-agenda.rst | 29 + open-mesh/Wbmv5-batmandev-agenda.textile | 23 - open-mesh/Wbmv6-batmandev-agenda.rst | 71 ++ open-mesh/Wbmv6-batmandev-agenda.textile | 46 -- open-mesh/WikiStart.rst | 57 ++ open-mesh/WikiStart.textile | 38 -- 250 files changed, 18464 insertions(+), 11110 deletions(-) Diff suppressed because of size. To see it, use: git diff-tree --patch-with-stat --no-color --find-copies-harder --ignore-space-at-eol --cc 4875465bfbc65731286ded11a9c4d6f6ee7361d2

1 0

[batctl] master: batctl: Fix error message when tcpdump packet send failed (5fb3a49)
by postmaster＠open-mesh.org 11 Jul '17

11 Jul '17

Repository : ssh://git@open-mesh.org/batctl On branch : master >--------------------------------------------------------------- commit 5fb3a4916c5dd8fbbc61609bfbfa1de85f6de063 Author: Sven Eckelmann <sven(a)narfation.org> Date: Wed Jul 5 17:15:10 2017 +0200 batctl: Fix error message when tcpdump packet send failed The strerror converts the positive error code into a string. tcpdump must therefore convert the negative return code from icmp_interface_write into a positive one before using it as parameter for strerror. Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- 5fb3a4916c5dd8fbbc61609bfbfa1de85f6de063 traceroute.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/traceroute.c b/traceroute.c index 124ce7c..79d3800 100644 --- a/traceroute.c +++ b/traceroute.c @@ -150,7 +150,7 @@ int traceroute(char *mesh_iface, int argc, char **argv) (struct batadv_icmp_header *)&icmp_packet_out, sizeof(icmp_packet_out)); if (res < 0) { - fprintf(stderr, "Error - can't send icmp packet: %s\n", strerror(res)); + fprintf(stderr, "Error - can't send icmp packet: %s\n", strerror(-res)); continue; }

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

commits July 2017