Repository : ssh://git@diktynna/doc On branch : main
commit e3cf23012fcace9753b4d33e61d1752dca2bf4d3 Merge: b75ae92a e6ca019e Author: Sven Eckelmann sven@narfation.org Date: Sat Nov 4 09:46:04 2023 +0100
Merge branch 'backup-redmine/2023-11-04'
e3cf23012fcace9753b4d33e61d1752dca2bf4d3 batman-adv/Feature-History.rst | 3 +++ open-mesh/Contribute.rst | 7 ++++--- open-mesh/MailingList.rst | 2 ++ 3 files changed, 9 insertions(+), 3 deletions(-)
diff --cc batman-adv/Feature-History.rst index 0dfaa958,00000000..aeae7fc9 mode 100644,000000..100644 --- a/batman-adv/Feature-History.rst +++ b/batman-adv/Feature-History.rst @@@ -1,83 -1,0 +1,86 @@@ +.. SPDX-License-Identifier: GPL-2.0 + +Feature History +=============== + +- **AP Isolation** + + - Initial support: 2011.4.0 + - Extended AP Isolation: v2014.1.0 + +- **BLA** + + - Initial support: v2011.0.0 + - BLA v2: v2012.2.0 + - Enabled by default: v2015.1 + - Detection of complex bridge loops: v2016.2 + +- **Bonding** + + - v2010.1.0 + +- **Broadcast** + + - 3x broadcast: v0.2 + - Retransmissions only on wireless: v2013.3.0 + - Broadcast Avoidances: v2016.5 + +- **DAT** + + - Initial support: v2013.0.0 + - DHCP-ACK snooping: v2019.1 + - Before timeout refreshing: v2019.2 + +- **Fragmentation** + + - Initial support: v2010.2.0 + - Fragmentation v2: v2014.0.0 + +- **Gateway Feature** + + - Initial support: v2011.0.0 + +- **Interface Alternating** + + - Initial support: v2010.1.0 + - Interface Alternating v2: v2014.1.0 + +- **Multicast Optimizations** + + - Multicast TT + TVLV support: v2014.2.0 + - Bridge support: v2016.3 + - Multicast-to-multi-unicast: v2019.2 ++ - Preliminary routable IPv6 multicast address support: v2019.3 ++ - Full, MRD based routable IPv4/IPv6 multicast address support: v2021.2 + +- **Network Coding** + + - v2013.2.0 + +- **BATMAN IV** + + - v0.1 + +- **BATMAN V** + + - OGMv2 / ELP / Throughput metric: v2016.1 ++ - WLAN TX bitrate fallback: v2020.0 + +- **TT** + + - Initial support: 2011.3.0 + - Speedy Join: v2012.4.0 + +- **TVLV support (compat 15):** + + - v2014.0.0 + +- **Vis** + + - removed in: v2014.0.0 + +- **Misc:** + + - Hop-penalty 15 -> 30: v2014.4.0 (and in v2012.2.0? how much?) + - Multiple mesh interfaces: v2010.2.0 + - Netlink: v2016.3 (+ v2016.4, v2016.5, …) diff --cc open-mesh/Contribute.rst index 882c764a,00000000..25ea077d mode 100644,000000..100644 --- a/open-mesh/Contribute.rst +++ b/open-mesh/Contribute.rst @@@ -1,124 -1,0 +1,125 @@@ +.. SPDX-License-Identifier: GPL-2.0 + +How to Contribute +================= + +Thanks for using B.A.T.M.A.N.! If you have suggestions, comments, want +to tell us about your experiences or discuss problems the best thing is +always to use the :doc:`Mailing List <MailingList>` You can always contact +us via :doc:`IRC <IRC>`. + +If you like this project and you want to take part and/or give something +back, here is a short list of starting points: + +Reporting Bugs +-------------- + +If you find a bug, please see if the problem is already known in the by +Reading the Tickets: + +- for `batman-adv </projects/batman-adv/issues>`__ +- for `batctl </projects/batctl/issues>`__ +- for `alfred </projects/alfred/issues>`__ +- for `batmand </projects/batmand/issues>`__ +- for `vis </projects/vis/issues>`__ + +If not, please add a new Ticket: + +- for `batman-adv </projects/batman-adv/issues/new>`__ +- for `batctl </projects/batctl/issues/new>`__ +- for `alfred </projects/alfred/issues/new>`__ +- for `batmand </projects/batmand/issues/new>`__ +- for `vis </projects/vis/issues/new>`__ + +Please add as much information as possible. In particular interesting +are: + +- Which branch (batman, batctl, batman-adv) +- Which version (0.X, git revision number) +- kernel version, distribution (and version) +- machine type (PC, Linksys WRT, Fon, NS2, ...) +- command line parameters used +- iptables/firewall rules +- :doc:`get a coredump </batmand/Coredump>` if you experience a segfault +- your guess what triggered the problem. ;) + +Documentation / Feedback +------------------------ + +Write an article about your experience with B.A.T.M.A.N. and have it +published here or ask us to link to your site: + +- How did you find us ? +- How does you setup look like ? +- Where are you building your mesh ? +- What problems did you encounter ? +- How did you debug / solve them ? +- What did you like / not like ? +- How can B.A.T.M.A.N. improve ? + +There's lots of people that want to know about B.A.T.M.A.N. - help us to +spread the word! You also can create a wiki account and improve the +documentation. + +Research +-------- + +B.A.T.M.A.N. gives much room for research, especially the layer 2 +implementation in the kernel. Get in touch with us to share your ideas. +If you write papers we are happy to publish them here or link to your +page. If you are looking for the right topic or mentorship feel free to +contact us. We have more ideas than time to implement them. + +Development +----------- + +You looked in the code ? Fixed bugs ? Added a cool new function ? +Integrated B.A.T.M.A.N. in a distribution ? Don't hesitate to let us and +others know! We can avoid duplicated work by publishing it here or +linking to your page. Patches are always welcome and can be posted on +the :doc:`mailing list <MailingList>` to get integrated. We also hand out +git access to people that want to get involved. + +Submitting patches +------------------ + +If you intend to send us patches, please consider the following +guidelines: + +* Prefer small & digestible over long "all in one" patches. +* No MIME, no links, no compression, no attachments. Just plain text + (patches are to be sent inline). +* Patches sent to the mailing list should include "PATCH" in the + subject to make it easier to distinguish between patches and + discussions. +* The mail's subject will become the first line in the commit message. + The body contains the longer patch description and the patch (unified + format) itself. Please also specify the target branch (e.g. batctl, + batman-adv, etc) at the beginning of the subject line. +* Add a "Signed-off-by: Your Name you@example.com" line to the patch + message to make the ownership of the patch clear. +* Patches for B.A.T.M.A.N. Advanced need to follow the linux kernel + coding style closely (use checkpatch.pl to verify your patch) as well as + the linux "how to submit patches" guidelines (search for the term + SubmitPatches to find thorough documentation). +* Check it using static analysis tools like + `sparse https://sparse.wiki.kernel.org/`__ (cgcc) and + `cppcheck http://cppcheck.sourceforge.net/`__ +* Patches against the batman-adv main branch must be formatted using + - :: ++ :: + + git format-patch $BASECOMMIT + ++ or an equivalent tool (like ``b4``) ++ +- README, manpage and sysfs-class-net-* must be updated together with + the related source change +- Add or update kerneldoc to functions and structures you add or + modify. +- batman-adv changes affecting batctl have to be send with the batctl + patches in the same patchset - - it is recommended to use `git send-email` to send the mails to the - mailinglist ++- it is recommended to use `b4 https://b4.docs.kernel.org/`__ to send the patch mails to the mailinglist - but plain ``git send-email`` is also fine. +- An exemplary good submission you may want to look at can be found + here: + https://patchwork.open-mesh.org/project/b.a.t.m.a.n./patch/1261051915-13960-... diff --cc open-mesh/MailingList.rst index 24783d58,00000000..47268237 mode 100644,000000..100644 --- a/open-mesh/MailingList.rst +++ b/open-mesh/MailingList.rst @@@ -1,18 -1,0 +1,20 @@@ +.. SPDX-License-Identifier: GPL-2.0 + +Mailing List +============ + +You can subscribe to our Mailing Lists +`here https://lists.open-mesh.org/`__. You can also send an E-Mail +without subscription to b.a.t.m.a.n@lists.open-mesh.org, but keep in +mind that this message will have to be accepted manually (and this can +take some time). + +*Note*: HTML email will be rejected - just plain text is allowed (this +cuts the rate of SPAM mails dramatically). + ++And please follow the `Mailing list etiquette https://subspace.kernel.org/etiquette.html`__. ++ +Old messages can be read in the `B.A.T.M.A.N. +archives https://lists.open-mesh.org/mailman3/hyperkitty/list/b.a.t.m.a.n@lists.open-mesh.org/`__. +Or via the various subscription (or mirror) methods from +`lore.kernel.org https://lore.kernel.org/batman`__