Messages in this thread | | | From | Mike Frysinger <> | Date | Mon, 14 Sep 2009 17:30:05 -0400 | Subject | Re: [PATCH v4] ftrace: document basic ftracer/ftracer graph needs |
| |
On Mon, Sep 14, 2009 at 17:20, Steven Rostedt wrote: > On Mon, 2009-09-14 at 17:01 -0400, Mike Frysinger wrote: >> On Mon, Sep 14, 2009 at 16:53, Steven Rostedt wrote: >> > On Mon, 2009-09-14 at 16:21 -0400, Mike Frysinger wrote: >> >> On Mon, Sep 14, 2009 at 15:48, Steven Rostedt wrote: >> >> > On Sat, 2009-06-13 at 23:05 -0400, Mike Frysinger wrote: >> >> >> diff --git a/Documentation/trace/ftrace.txt b/Documentation/trace/ftrace.txt >> >> >> index fd9a3e6..95a39fb 100644 >> >> >> --- a/Documentation/trace/ftrace.txt >> >> >> +++ b/Documentation/trace/ftrace.txt >> >> >> @@ -27,6 +27,12 @@ disabled, and more (ftrace allows for tracer plugins, which >> >> >> means that the list of tracers can always grow). >> >> >> >> >> >> >> >> >> +Implementation Details >> >> >> +---------------------- >> >> >> + >> >> >> +See ftrace-implementation.txt for details for arch porters and such. >> >> > >> >> > Might want to specify that this is for the function tracer. >> >> >> >> well, all of ftrace.txt says "function tracer", so if/when someone >> >> cleans that up, this will get fixed in the process. >> > >> > Well things do need to be clean up, the original code had the function >> > tracer called ftrace, which it no longer does. Why add more incorrect >> > documentation just to match the previous incorrect documentation? >> >> if the filename is updated, do i really need to duplicate it ? >> >> See function-tracer-design.txt for details for arch porters and such. >> >> if people add other design/porting info, this can be a simple list and >> the filename itself can imply the details contained within ... > > Fine, then rename it to ftrace-design.txt (this corresponds to other > docs in Documentation, like lockdep-design.txt and rt-mutex-design.txt) > > Then in the file, start it with "Function tracer implementation" or > something similar.
i'm fine with either way, i was just trying to point out what i thought was redundant information in the brief description. "See function-tracer-design.txt for details on the function tracer design.".
although, if we're going to add nmi/syscall/dynamic tracer to the same file, it probably makes sense to go with "ftrace-design.txt". -mike -- 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/
| |