From: Duncan Roe <duncan_roe@optusnet.com.au>
To: netfilter-devel@vger.kernel.org
Subject: [PATCH libnfnetlink v3 2/2] Make it clear that this library is deprecated
Date: Sun, 27 Oct 2019 19:49:07 +1100 [thread overview]
Message-ID: <20191027084907.24291-3-duncan_roe@optusnet.com.au> (raw)
In-Reply-To: <20191027084907.24291-1-duncan_roe@optusnet.com.au>
In-Reply-To: <20191026051937.GA17407@dimstar.local.net>
src/iftable.c: Update group description
src/libnfnetlink.c: - Re-work main page (which was based on the misconception
that this library always gets used)
- Update group description
Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
---
src/iftable.c | 6 +++++-
src/libnfnetlink.c | 17 ++++++++++++++---
2 files changed, 19 insertions(+), 4 deletions(-)
diff --git a/src/iftable.c b/src/iftable.c
index 6d1d135..aab59b3 100644
--- a/src/iftable.c
+++ b/src/iftable.c
@@ -25,7 +25,11 @@
#include "linux_list.h"
/**
- * \defgroup iftable Functions in iftable.c
+ * \defgroup iftable Functions in iftable.c [DEPRECATED]
+ * This documentation is provided for the benefit of maintainers of legacy code.
+ *
+ * New applications should use
+ * [libmnl](https://netfilter.org/projects/libmnl/doxygen/html/).
* @{
*/
diff --git a/src/libnfnetlink.c b/src/libnfnetlink.c
index 3db21e0..1cb6a82 100644
--- a/src/libnfnetlink.c
+++ b/src/libnfnetlink.c
@@ -55,12 +55,23 @@
/**
* \mainpage
*
- * libnfnetlink is the bottom-level communication between the kernel and
- * userspace
+ * Deprecated
+ * ---
+ * New applications should use
+ * [libmnl](https://netfilter.org/projects/libmnl/doxygen/html/).
+ *
+ * [libnetfilter_queue]
+ * (https://netfilter.org/projects/libnetfilter_queue/doxygen/html/)
+ * now provides a set of helpers for libmnl, in addition to those it provides
+ * for libnfnetlink (which are now deprecated).
*/
/**
- * \defgroup libnfnetlink Functions in libnfnetlink.c
+ * \defgroup libnfnetlink Functions in libnfnetlink.c [DEPRECATED]
+ * This documentation is provided for the benefit of maintainers of legacy code.
+ *
+ * New applications should use
+ * [libmnl](https://netfilter.org/projects/libmnl/doxygen/html/).
* @{
*/
--
2.14.5
next prev parent reply other threads:[~2019-10-27 8:49 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-14 2:02 [PATCH libnfnetlink 0/1] Minimally resurrect doxygen documentation Duncan Roe
2019-10-14 2:02 ` [PATCH libnfnetlink 1/1] src: " Duncan Roe
2019-10-23 11:13 ` Pablo Neira Ayuso
2019-10-23 15:12 ` Duncan Roe
2019-10-23 15:58 ` Jeremy Sowden
2019-10-23 20:55 ` Pablo Neira Ayuso
2019-10-23 15:31 ` Duncan Roe
2019-10-23 20:48 ` Pablo Neira Ayuso
2019-10-24 23:51 ` Duncan Roe
2019-10-26 7:40 ` Duncan Roe
2019-10-26 11:54 ` Pablo Neira Ayuso
2019-10-26 5:19 ` Duncan Roe
2019-10-26 6:59 ` [PATCH libnfnetlink v2 0/2] " Duncan Roe
2019-10-26 6:59 ` [PATCH libnfnetlink v2 1/2] " Duncan Roe
2019-10-26 6:59 ` [PATCH libnfnetlink v2 2/2] Make it clear that this library is deprecated Duncan Roe
2019-10-27 8:49 ` [PATCH libnfnetlink v3 0/2] Minimally resurrect doxygen documentation Duncan Roe
2019-10-27 8:49 ` [PATCH libnfnetlink v3 1/2] " Duncan Roe
2019-11-04 17:28 ` Pablo Neira Ayuso
2019-10-27 8:49 ` Duncan Roe [this message]
2019-11-04 17:28 ` [PATCH libnfnetlink v3 2/2] Make it clear that this library is deprecated Pablo Neira Ayuso
2019-10-15 22:52 ` [PATCH libnfnetlink 0/1] Minimally resurrect doxygen documentation Duncan Roe
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=20191027084907.24291-3-duncan_roe@optusnet.com.au \
--to=duncan_roe@optusnet.com.au \
--cc=netfilter-devel@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.