From: Alison Schofield <amsfield22@gmail.com>
To: gnudevliz@gmail.com
Cc: outreachy-kernel <outreachy-kernel@googlegroups.com>
Subject: Re: [Outreachy kernel] TODO/comment questions
Date: Tue, 27 Sep 2016 13:04:29 -0700 [thread overview]
Message-ID: <20160927200428.GA20525@d830.WORKGROUP> (raw)
In-Reply-To: <44f080fb-8ee2-4de0-8480-7b21534757ab@googlegroups.com>
On Tue, Sep 27, 2016 at 12:49:37PM -0700, gnudevliz@gmail.com wrote:
> I'm seeing a "Block comments use * on subsequent lines" checkpatch error in
> many spots on one driver so I thought I would change a few of those in
> multiple files and put them all in one patch. I think that's better than
> submitting multiple patches just for comment revision, but you tell me.
Sounds good.
Single driver with multiple files needing same type of change.
So the commit msg applies to everything you did..ie use kernel preferred block
commenting style.
>
> My second question-- one specific comment that is missing an asterisk
> includes a TODO line. Is it good practice to have a TODO in a comment? I'm
> not seeing anything about it in the style guide. If it's fine I'll just add
> an asterisk there and leave it the way it is.
When I "git grep TODO", I see the TODO inside comments a lot.
Don't know if it's good practice, but certainly common.
What would the alternative be?
alisons
>
> Thanks,
> Liz
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/44f080fb-8ee2-4de0-8480-7b21534757ab%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.
next prev parent reply other threads:[~2016-09-27 20:04 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-27 19:49 TODO/comment questions gnudevliz
2016-09-27 20:04 ` Alison Schofield [this message]
2016-09-27 20:16 ` [Outreachy kernel] " Julia Lawall
[not found] ` <20160927203553.GA20780@d830.WORKGROUP>
[not found] ` <20160927220413.GA23877@localhost>
[not found] ` <20160927222001.GA21768@d830.WORKGROUP>
2016-09-28 18:19 ` line wrap and rebase question Elizabeth Ferdman
2016-09-28 20:32 ` Alison Schofield
2016-09-28 20:43 ` [Outreachy kernel] " Julia Lawall
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=20160927200428.GA20525@d830.WORKGROUP \
--to=amsfield22@gmail.com \
--cc=gnudevliz@gmail.com \
--cc=outreachy-kernel@googlegroups.com \
/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.