Re: [PATCH 2/3] vga: drops a documentation regarding the VGA arbiter

On Wednesday 29 July 2009 02:52:29 am Vignatti Tiago (Nokia-D/Helsinki) wrote:
On Tue, Jul 28, 2009 at 09:25:50PM +0200, Bjorn Helgaas wrote:
On Thursday 16 July 2009 09:48:30 am Tiago Vignatti wrote:
Signed-off-by: Tiago Vignatti <tiago.vignatti@xxxxxxxxx>
---
Documentation/vgaarbiter.txt | 197 ++++++++++++++++++++++++++++++++++++++++++
1 files changed, 197 insertions(+), 0 deletions(-)
create mode 100644 Documentation/vgaarbiter.txt

I think the documentation update should be part of the same patch
that adds the functionality. Then the docs will always match
the code.

I don't think some "normal" kernel developer will need such document.

Looks like we're doing nice cuts (well, Dave is) on this patch and coming in a
state that people won't need to understand in deep things related with VGA
arbiter before doing hacks with DRM/PCI drivers. Moreover, the vgaarb.h is
pretty well readable :)

I guess I didn't make my point very well :-) I haven't even looked at
the code, so I'll take your word for the fact that it's readable without
extra documentation.

My point was that if you add a feature "X" and you add documentation
for "X", both should be in a single patch so the logically related things
are all in one commit.

Bjorn
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

Relevant Pages
Loading