Re: Documentation of kernel messages (Summary)

[Theodore Tso <tytso@mit.edu>]

On Wed, Jul 11, 2007 at 02:13:02PM -0400, Rob Landley wrote:
> > IMHO, having contribution merged into the kernel has the MAGIC to
> > attract people to work for recognition.  When more and more people
> > volunteer to work on it, the documentation will be up to date magically.
> 
> Obvious counter-arguments include the floppy driver, the floppy tape driver, 
> the tty layer, and most of the existing english Documentation directory...
> 
> I'll happily stay out of the way of people who actually want to merge 
> translations of documentation into the kernel.  I reserve the right to say "I 
> told you so" in about five years.

One thing that would be a VERY good idea is to make sure that each
translated document is tagged with when it was last translated, and
against which kernel version (using either a GIT commit id or a
2.6.x.y revision, I don't care), and who is responsible for keeping
that particular document translated.  That way, it becomes a lot
easier to recognize when something is stale, and if has gotten stale,
we can just delete it.

If someone keeping some files translated into Klingon up to date for 3
months, and then disappears, we can just delete it, and it's no big
deal.  You can even say "I told you so" when you submit the patch to
delete the stale translation.  :-)

> A list works fine as a point of contact.  I note that in general, maintainers 
> are individuals (who delegate like mad, of course), because otherwise agenda 
> items languish with everyone thinking it's someone else's responsibility.

I agree; if we're going to have a language translated in
Documentation/<lang>, there ought to be one or two overall language
maintainer, plus a maintainer for each file that is being translated,
who is responsible for updating the translated file when the base
English Documentation file is updated.

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