From: Simon Wunderlich <sw@simonwunderlich.de>
To: davem@davemloft.net
Cc: netdev@vger.kernel.org, b.a.t.m.a.n@lists.open-mesh.org,
Sven Eckelmann <sven@narfation.org>,
Simon Wunderlich <sw@simonwunderlich.de>
Subject: [B.A.T.M.A.N.] [PATCH 02/12] batman-adv: Drop documentation about debugfs files
Date: Thu, 28 Mar 2019 16:41:42 +0100 [thread overview]
Message-ID: <20190328154152.20552-3-sw@simonwunderlich.de> (raw)
In-Reply-To: <20190328154152.20552-1-sw@simonwunderlich.de>
From: Sven Eckelmann <sven@narfation.org>
The debugfs files were marked as deprecated by commit 00caf6a2b318
("batman-adv: Mark debugfs functionality as deprecated"). The documentation
should not advertise its usage anymore and instead promote the generic
netlink family and a userspace tool to access it.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
---
Documentation/networking/batman-adv.rst | 29 +++++++++--------------------
1 file changed, 9 insertions(+), 20 deletions(-)
diff --git a/Documentation/networking/batman-adv.rst b/Documentation/networking/batman-adv.rst
index 245fb6c0ab6f..1b9ff47c0976 100644
--- a/Documentation/networking/batman-adv.rst
+++ b/Documentation/networking/batman-adv.rst
@@ -74,23 +74,9 @@ All mesh wide settings can be found in batman's own interface folder::
bridge_loop_avoidance gw_sel_class network_coding
distributed_arp_table hop_penalty orig_interval
-There is a special folder for debugging information::
-
- $ ls /sys/kernel/debug/batman_adv/bat0/
- bla_backbone_table log neighbors transtable_local
- bla_claim_table mcast_flags originators
- dat_cache nc socket
- gateways nc_nodes transtable_global
-
-Some of the files contain all sort of status information regarding the mesh
-network. For example, you can view the table of originators (mesh
-participants) with::
-
- $ cat /sys/kernel/debug/batman_adv/bat0/originators
-
-Other files allow to change batman's behaviour to better fit your requirements.
-For instance, you can check the current originator interval (value in
-milliseconds which determines how often batman sends its broadcast packets)::
+Some files allow to change batman-adv's behaviour to better fit your
+requirements. For instance, you can check the current originator interval (value
+in milliseconds which determines how often batman sends its broadcast packets)::
$ cat /sys/class/net/bat0/mesh/orig_interval
1000
@@ -103,6 +89,10 @@ In very mobile scenarios, you might want to adjust the originator interval to a
lower value. This will make the mesh more responsive to topology changes, but
will also increase the overhead.
+Information about the current state can be accessed via the batadv generic
+netlink family. batctl provides human readable version via its debug tables
+subcommands.
+
Usage
=====
@@ -147,10 +137,9 @@ batman-adv module. When building batman-adv as part of kernel, use "make
menuconfig" and enable the option ``B.A.T.M.A.N. debugging``
(``CONFIG_BATMAN_ADV_DEBUG=y``).
-Those additional debug messages can be accessed using a special file in
-debugfs::
+Those additional debug messages can be accessed using the perf infrastructure::
- $ cat /sys/kernel/debug/batman_adv/bat0/log
+ $ trace-cmd stream -e batadv:batadv_dbg
The additional debug output is by default disabled. It can be enabled during
run time. Following log_levels are defined:
--
2.11.0
next prev parent reply other threads:[~2019-03-28 15:41 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-28 15:41 [B.A.T.M.A.N.] [PATCH 00/12] pull request for net-next: batman-adv 2019-03-28 Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 01/12] batman-adv: Drop license boilerplate Simon Wunderlich
2019-03-28 15:41 ` Simon Wunderlich [this message]
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 03/12] batman-adv: Drop documentation about sysfs files Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 04/12] batman-adv: Make sysfs support optional Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 05/12] batman-adv: ABI: Mark sysfs files as deprecated Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 06/12] batman-adv: Warn about sysfs file access Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 07/12] MAINTAINERS: Add B(ugtracker) field for batman-adv Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 08/12] MAINTAINERS: Add C(hat) " Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 09/12] MAINTAINERS: Add T(ree) " Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 10/12] batman-adv: Adjust name for batadv_dat_send_data Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 11/12] batman-adv: allow updating DAT entry timeouts on incoming ARP Replies Simon Wunderlich
2019-03-28 15:41 ` [B.A.T.M.A.N.] [PATCH 12/12] batman-adv: Add multicast-to-unicast support for multiple targets Simon Wunderlich
2019-03-28 16:54 ` [B.A.T.M.A.N.] [PATCH 00/12] pull request for net-next: batman-adv 2019-03-28 David Miller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190328154152.20552-3-sw@simonwunderlich.de \
--to=sw@simonwunderlich.de \
--cc=b.a.t.m.a.n@lists.open-mesh.org \
--cc=davem@davemloft.net \
--cc=netdev@vger.kernel.org \
--cc=sven@narfation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).