From: Steven Rostedt <rostedt@goodmis.org>
To: David Woodhouse <dwmw2@infradead.org>
Cc: Dan Carpenter <dan.carpenter@oracle.com>,
ksummit-discuss@lists.linuxfoundation.org
Subject: Re: [Ksummit-discuss] [CORE-TOPIC] Documentation
Date: Mon, 13 Jul 2015 13:35:19 -0400 [thread overview]
Message-ID: <20150713133519.22018176@gandalf.local.home> (raw)
In-Reply-To: <1436806006.20909.59.camel@infradead.org>
On Mon, 13 Jul 2015 17:46:46 +0100
David Woodhouse <dwmw2@infradead.org> wrote:
> I'm guilty of it myself. And I've also suffered from it. Sometimes,
> with a few years in between, I have even inflicted this pain on
> *myself* :)
Me too. I have to admit, that I've done the same with my own functions.
But I've become much better lately at documenting.
A lot of these functions are from years past. We should go back and try
to document them. Perhaps we may even find and fix a few bugs in doing
so.
I forgot who said it, but I remember reading a quote that stated "When
the code does not match the comments, they are probably both wrong".
-- Steve
next prev parent reply other threads:[~2015-07-13 17:51 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-12 22:38 Peter Hüwe
2015-07-12 23:15 ` Julia Lawall
2015-07-14 11:59 ` Mauro Carvalho Chehab
2015-07-13 9:47 ` Alexey Dobriyan
2015-07-13 16:01 ` Randy Dunlap
2015-07-13 16:37 ` Steven Rostedt
2015-07-13 16:46 ` David Woodhouse
2015-07-13 17:35 ` Steven Rostedt [this message]
2015-07-13 19:22 ` Peter Hüwe
2015-07-13 19:28 ` Peter Hüwe
2015-07-13 17:42 ` Jason Cooper
2015-07-13 18:11 ` Steven Rostedt
2015-07-14 3:56 ` Zefan Li
2015-07-13 19:25 ` Peter Hüwe
2015-07-13 22:10 ` Laurent Pinchart
2015-07-13 17:45 ` Jonathan Corbet
2015-07-13 19:46 ` Peter Hüwe
2015-07-14 2:36 ` Jonathan Corbet
2015-07-14 8:40 ` Laurent Pinchart
2015-07-14 11:19 ` Daniel Vetter
2015-07-14 12:43 ` Mauro Carvalho Chehab
2015-07-14 12:53 ` Jonathan Corbet
2015-07-14 13:57 ` Laurent Pinchart
2015-07-14 6:44 ` Johannes Berg
2015-07-13 19:20 ` Peter Hüwe
2015-07-13 23:01 ` Laurent Pinchart
2015-07-13 17:05 ` Lai Jiangshan
2015-07-13 17:42 ` Jonathan Corbet
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=20150713133519.22018176@gandalf.local.home \
--to=rostedt@goodmis.org \
--cc=dan.carpenter@oracle.com \
--cc=dwmw2@infradead.org \
--cc=ksummit-discuss@lists.linuxfoundation.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox