On Wed, Jan 23, 2019 at 11:34:22AM +0300, Ilya Maximets wrote:
> On 23.01.2019 1:43, Ben Pfaff wrote:
> > On Tue, Jan 22, 2019 at 12:52:56PM +0300, Ilya Maximets wrote:
> >> On 22.01.2019 4:14, Ben Pfaff wrote:
> >>> It was deceptive for the example to imply that a seq can be declared
> >>> directly, because the API only allows for creating a new one on the heap.
> >>>
> >>> Signed-off-by: Ben Pfaff <[email protected]>
> >>
> >> Thanks.
> >> Maybe you can additionally fix the C99-style comment here to not use
> >> a bad style inside the example.
> >>
> >> Anyway,
> >> Acked-by: Ilya Maximets <[email protected]>
> > 
> > Thanks, I applied this to master.
> > 
> > It's tricky to avoid C99 comments in code samples inside regular C
> > comments, because C comments don't nest.  Do you have a suggestion on
> > how to do it?
> 
> Oops. Yes, you're right, it's a bit tricky.
> 
> So, I'm not sure if this needed, but I see 2 possible solutions:
> 
>   1. Add some spaces like / * Comment * /.
>      But this increases the line length over 79 chars here.
> 
>   2. Make it look not like a comment at all. i.e. Make it look like a
>      a simple text. For example:
> 
>          if (ovs_list_is_singleton(&queue)) {  <-- The 'if' test here is 
> optional.
> 
>      This doesn't give a bad comment example and obviously should be removed
>      while copying to the real code.
> 
> Best regards, Ilya Maximets.

Good ideas.  I like #2 better than #1.  I sent a fix.
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to