All of lore.kernel.org
 help / color / mirror / Atom feed
From: Duncan Roe <duncan_roe@optusnet.com.au>
To: "G.W. Haywood" <ged@jubileegroup.co.uk>
Cc: Netfilter Development <netfilter-devel@vger.kernel.org>
Subject: Re: Documentation oddity.
Date: Wed, 2 Apr 2025 20:36:40 +1100	[thread overview]
Message-ID: <Z+0FKKFKcofghbwp@slk15.local.net> (raw)
In-Reply-To: <f87285a5-f381-bb1f-3d31-97ef214946dd@jubileegroup.co.uk>

Hi Ged,

On Fri, Mar 28, 2025 at 01:55:11PM +0000, G.W. Haywood wrote:
> Hi there,
>
> In the document at
>
> https://netfilter.org/projects/libnetfilter_queue/doxygen/html/group__tcp.html#ga66fd94158867c63be8e4104d84050ac4
>
> 1. At the top of the page it mentions a diagram, but I don't see anything
> in my browsers.  Have I missed something?

No, the diagram is not there because the system where the document was built did
not have the *graphviz* package installed. Graphviz supplies the `dot` utility
which doxygen uses to create diagrams.

In the absence of graphviz, the "Collaboration diagram..." line should not be
there. This was a build issue, now fixed but not yet released.

If you're keen to see the diagram, you could email the webmaster requesting a
rebuild with graphviz installed.
>
> 2. Each section covering a function mentions the function name three times.
>
> Except in the section for the function
>
> nfq_tcp_snprintf
>
> which at the third attempt actually calls it
>
> nfq_pkt_snprintf_tcp_hdr
>
> and which had me confused for a while.
>
> 3. It also spells "human" as "humnan". :/

2. & 3. are actually on the same line. It's been like that forever - I've
submitted a patch to fix (and nfq_udp_snprintf, same fixes).
>
Cheers ... Duncan.

      reply	other threads:[~2025-04-02  9:36 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-18 15:20 Documentation oddity G.W. Haywood
2024-12-19  9:22 ` Jozsef Kadlecsik
2025-03-10 18:00   ` G.W. Haywood
2025-03-11  0:00     ` Duncan Roe
2025-03-11 10:00       ` G.W. Haywood
2025-03-12  6:21         ` Duncan Roe
2025-03-12  9:48           ` G.W. Haywood
2025-03-13 10:04             ` Duncan Roe
2025-03-28 13:55           ` G.W. Haywood
2025-04-02  9:36             ` Duncan Roe [this message]

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=Z+0FKKFKcofghbwp@slk15.local.net \
    --to=duncan_roe@optusnet.com.au \
    --cc=ged@jubileegroup.co.uk \
    --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.