Re: [PATCH 2/3] ring-buffer: rename debugfs file tracing_on to writing_enabled




On Tue, 6 Jan 2009, Andrew Morton wrote:

On Tue, 06 Jan 2009 17:33:39 -0500

There's no corresponding documentation update needed?

I've fallen a little behind in the documentation. I wanted to see what got
pulled in before updating ftrace.txt. But you are correct, I probably
should add the documentation updates along with the patches.

But unfortunately, I'm a bit lazy. I like to wait and see what makes it to
mainline, and then write a patch to update ftrace.txt to reflect that. It
lets me do it in one sitting, instead of doing it for each change.

Honestly, I think I document it better that way. If I document right after
writing the code, I do it with too much knowledge of the code, and my
writing is confusing for others. If I wait to document, I forget what I
did, and have to relearn what I wrote, and then I have a better
perspective of what others will want to know.

Thanks,

-- Steve

--
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

  • Re: Platform Builder Help Update
    ... The documentation changes have never been documented in detail. ... the name but no download link. ... And since it's a documentation update: It's ok to have the latest docs ...
    (microsoft.public.windowsce.platbuilder)
  • Re: Dolphin 6 Release Date
    ... the documentation update and integration. ... Of course, personally, I'd like to ship it out without any documentation at all;-) but we have been promising an update to the help and the docs for so long now that I don't think we get away with it :-( ...
    (comp.lang.smalltalk.dolphin)
  • Re: [PATCH 2/3] vga: drops a documentation regarding the VGA arbiter
    ... I think the documentation update should be part of the same patch ... arbiter before doing hacks with DRM/PCI drivers. ...
    (Linux-Kernel)
  • Re: programming job market in bay area in US
    ... certainly not enough to be able to debug my translator by knowing what ... any of a wide range of different things, from simply writing utility ... Would any of that qualify as "systems programming"? ... drafts of the documentation, then I wrote all the rest of the ...
    (comp.programming)
  • Re: The rise and fall of linux
    ... > Have you ever considered picking a chunk of outdated ... > domumentation and writing an improved replacement? ... Linux including and especially writing documents. ...
    (alt.linux)

Loading