public inbox for b.a.t.m.a.n@lists.open-mesh.org
 help / color / mirror / Atom feed
From: Sven Eckelmann <sven@narfation.org>
To: Markus Pargmann <mpa@pengutronix.de>
Cc: b.a.t.m.a.n@lists.open-mesh.org
Subject: Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
Date: Sun, 01 Nov 2015 16:32:09 +0100	[thread overview]
Message-ID: <2794351.UgJrBE9pQk@sven-edge> (raw)
In-Reply-To: <20151101151302.GA32213@pengutronix.de>

[-- Attachment #1: Type: text/plain, Size: 1348 bytes --]

On Sunday 01 November 2015 16:13:02 Markus Pargmann wrote:
> > diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
> > index 06bab51..3404195 100644
> > --- a/net/batman-adv/bitarray.c
> > +++ b/net/batman-adv/bitarray.c
> > @@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long
> > *seq_bits, s32 n)> 
> >  	bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
> >  
> >  }
> > 
> > -/* receive and process one packet within the sequence number window.
> > +/**
> > + * batadv_bit_get_packet - receive and process one packet within the
> > sequence + *  number window
> 
> Are you sure this works? IIRC some time ago multi line function
> descriptions were not supported.

Yes, it works since 2009 [1,2,3].

Here is the kerneldoc (text) output for the function you've quoted:

    Name:
    
    batadv_bit_get_packet - receive and process one packet within the sequence number window
    
    Synopsis:
    [...]


Kind regards,
	Sven

[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=6423133bdee0e07d1c2f8411cb3fe676c207ba33
[2] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=4c98ecaf350737cd424eb94140e9e9f1a3408956
[3] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=47e0c88b37a5c3d6732f4ec896dfa8aa55868b4f

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

  reply	other threads:[~2015-11-01 15:32 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-31 11:28 [B.A.T.M.A.N.] [PATCH 0/2] Kerneldoc fixes and TODOs Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
2015-10-31 11:29   ` [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions Sven Eckelmann
2015-11-17  7:34     ` Marek Lindner
2015-11-01 15:13   ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Markus Pargmann
2015-11-01 15:32     ` Sven Eckelmann [this message]
2015-11-01 15:35       ` Markus Pargmann
2015-11-17  7:33   ` Marek Lindner

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=2794351.UgJrBE9pQk@sven-edge \
    --to=sven@narfation.org \
    --cc=b.a.t.m.a.n@lists.open-mesh.org \
    --cc=mpa@pengutronix.de \
    /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