Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions

[Sven Eckelmann <sven@narfation.org>]

[-- 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 --]