From 9c3123113f395e7ea634c522e340604331359e7e Mon Sep 17 00:00:00 2001 From: dagenais Date: Wed, 28 Jan 2004 17:03:02 +0000 Subject: [PATCH] Add copyright notices and some comments about status and TODO git-svn-id: http://ltt.polymtl.ca/svn@431 04897980-b3bd-0310-b5e0-8ef037075253 --- ltt/branches/poly/AUTHORS | 12 +++--- ltt/branches/poly/README | 29 +++++++++------ ltt/branches/poly/doc/developer/coding.html | 32 ++++++++++++++++ ltt/branches/poly/doc/developer/format.html | 8 ++-- ltt/branches/poly/doc/developer/index.html | 9 +++-- .../poly/doc/developer/library-header.txt | 17 +++++++++ ltt/branches/poly/doc/developer/lttv.html | 4 +- .../poly/doc/developer/program-header.txt | 17 +++++++++ ltt/branches/poly/doc/developer/status.html | 26 +++++++++++++ ltt/branches/poly/doc/developer/todo.html | 37 +++++++++++++++++++ ltt/branches/poly/include/ltt/event.h | 18 +++++++++ ltt/branches/poly/include/ltt/facility.h | 19 ++++++++++ ltt/branches/poly/include/ltt/ltt.h | 18 +++++++++ ltt/branches/poly/include/ltt/time.h | 18 +++++++++ ltt/branches/poly/include/ltt/trace.h | 18 +++++++++ ltt/branches/poly/include/ltt/type.h | 18 +++++++++ ltt/branches/poly/include/lttv/attribute.h | 18 +++++++++ .../poly/include/lttv/batchAnalysis.h | 18 +++++++++ ltt/branches/poly/include/lttv/filter.h | 18 +++++++++ ltt/branches/poly/include/lttv/hook.h | 18 +++++++++ ltt/branches/poly/include/lttv/iattribute.h | 18 +++++++++ ltt/branches/poly/include/lttv/lttv.h | 18 +++++++++ ltt/branches/poly/include/lttv/module.h | 18 +++++++++ ltt/branches/poly/include/lttv/option.h | 18 +++++++++ ltt/branches/poly/include/lttv/processTrace.h | 18 +++++++++ ltt/branches/poly/include/lttv/state.h | 18 +++++++++ ltt/branches/poly/include/lttv/stats.h | 18 +++++++++ ltt/branches/poly/include/lttv/traceset.h | 18 +++++++++ ltt/branches/poly/lttv/main/attribute.c | 17 +++++++++ ltt/branches/poly/lttv/main/filter.c | 18 +++++++++ ltt/branches/poly/lttv/main/hook.c | 18 +++++++++ ltt/branches/poly/lttv/main/iattribute.c | 18 +++++++++ ltt/branches/poly/lttv/main/main.c | 18 +++++++++ ltt/branches/poly/lttv/main/module.c | 18 +++++++++ ltt/branches/poly/lttv/main/option.c | 18 +++++++++ ltt/branches/poly/lttv/main/processTrace.c | 18 +++++++++ ltt/branches/poly/lttv/main/state.c | 18 +++++++++ ltt/branches/poly/lttv/main/stats.c | 18 +++++++++ ltt/branches/poly/lttv/main/traceset.c | 18 +++++++++ .../poly/lttv/modules/text/batchAnalysis.c | 18 +++++++++ .../poly/lttv/modules/text/textDump.c | 18 +++++++++ 41 files changed, 725 insertions(+), 24 deletions(-) create mode 100644 ltt/branches/poly/doc/developer/coding.html create mode 100644 ltt/branches/poly/doc/developer/library-header.txt create mode 100644 ltt/branches/poly/doc/developer/program-header.txt create mode 100644 ltt/branches/poly/doc/developer/status.html create mode 100644 ltt/branches/poly/doc/developer/todo.html diff --git a/ltt/branches/poly/AUTHORS b/ltt/branches/poly/AUTHORS index e5c5c466..eff2bd6c 100644 --- a/ltt/branches/poly/AUTHORS +++ b/ltt/branches/poly/AUTHORS @@ -1,9 +1,11 @@ -Project author : Karim Yaghmour +Project author: Karim Yaghmour Contributors : -Michel Dagenais (Coordination of other contributions) -Tom Zanussi (RelayFS) +Michel Dagenais (New trace format, lttv main) +Mathieu Desnoyers (Directory structure, build with automake/conf, + lttv gui, control flow view) Benoit Des Ligneris (Cluster adaptation) -Xang-Xiu Yang (LibLTT API, modular user interface) -Mathieu Desnoyers (Modular user interface, modular tools, packaging) +Xang-Xiu Yang (new trace reading library and converter, lttv gui, + detailed event list and statistics view) +Tom Zanussi (RelayFS) diff --git a/ltt/branches/poly/README b/ltt/branches/poly/README index e5b3fcc4..d1e6a82b 100644 --- a/ltt/branches/poly/README +++ b/ltt/branches/poly/README @@ -1,3 +1,10 @@ + +This package contains the trace reading library and trace viewing tools for +the new Linux Trace Toolkit trace format. The associated kernel files to +generate the new traces are not yet included. In the meantime, a converter +from the old trace format to the new is provided. For more detailed information +see doc/developer/index.html + * Compiling Some development libraries are needed for compiling : @@ -21,17 +28,17 @@ use make, make install. This is a sample of the suggested tree for Linux Trace Toolkit. -LibLTT : Libraries used for LTT. -README : This file. Introduction pointing to specific resources in the tree. -debian : debian config files. -doc : LTT Documentation. -doc/user : User related documentation. -doc/developer : Developer related documentation. -kernel : LTT kernel patches. -lttd : Linux Trace Toolkit daemon. -lttv : Linux Trace Toolkit visualizer/analyzer. -lttv/plugins : Linux Trace Toolkit visualizer plugins. -specs : RPM config files. +ltt: new trace format reading library (and converter). +README: This file. +debian: debian config files (currently empty). +doc: Documentation. +doc/user: User related documentation. +doc/developer: Developer related documentation. +kernel: Linux Trace Toolkit kernel code (currently empty). +lttd: Linux Trace Toolkit daemon (currently empty). +lttv: Linux Trace Toolkit trace analysis tool and viewer. +lttv/modules: Linux Trace Toolkit analysis tool and viewer plugin modules. +specs: RPM config files (currently empty). * For Developers diff --git a/ltt/branches/poly/doc/developer/coding.html b/ltt/branches/poly/doc/developer/coding.html new file mode 100644 index 00000000..4822f45e --- /dev/null +++ b/ltt/branches/poly/doc/developer/coding.html @@ -0,0 +1,32 @@ + + + + Coding practices + + + +

Coding practices

+ +

+The Linux Trace Toolkit viewer and libltt libraries use the coding standards +of the underlying glib and gtk libraries. +This includes: + +

+ +

+Each file in the libltt library should contain a +LGPL header while each file in the LTT viewer +should contain a +GPL header. + + + + + + diff --git a/ltt/branches/poly/doc/developer/format.html b/ltt/branches/poly/doc/developer/format.html index 7bb1a123..d41df440 100644 --- a/ltt/branches/poly/doc/developer/format.html +++ b/ltt/branches/poly/doc/developer/format.html @@ -41,9 +41,11 @@ facilities used. The syntax is a simple subset of XML; XML is widely known and easily parsed or hand edited. Each file contains one or more ... elements. Indeed, several facilities may have the same name but different content (and thus will -generate a different checksum), typically when the event descriptions -for a given facility change from one version to the next, if a module -is recompiled and reloaded during a trace. +generate a different checksum). It typically happens when, while tracing +is enabled, a module using the named facility is unloaded, modified +(along with the description of some events), recompiled and reloaded. +Then, the trace will contain events from two different, similarly named, +facility versions.

A small number of events are predefined, part of the "builtin" facility, diff --git a/ltt/branches/poly/doc/developer/index.html b/ltt/branches/poly/doc/developer/index.html index 8c2c41e7..1b793883 100644 --- a/ltt/branches/poly/doc/developer/index.html +++ b/ltt/branches/poly/doc/developer/index.html @@ -1,16 +1,19 @@ - Linux Trace Toolkit Development + Linux Trace Toolkit trace analysis tools development -

Linux Trace Toolkit Development

+

Linux Trace Toolkit trace analysis tools development

diff --git a/ltt/branches/poly/doc/developer/library-header.txt b/ltt/branches/poly/doc/developer/library-header.txt new file mode 100644 index 00000000..00e2ecf1 --- /dev/null +++ b/ltt/branches/poly/doc/developer/library-header.txt @@ -0,0 +1,17 @@ +/* This file is part of the Linux Trace Toolkit trace reading library + * Copyright (C) 2003-2004 Your Name + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License Version 2.1 as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ diff --git a/ltt/branches/poly/doc/developer/lttv.html b/ltt/branches/poly/doc/developer/lttv.html index 3dc192dd..0f2f6dd3 100644 --- a/ltt/branches/poly/doc/developer/lttv.html +++ b/ltt/branches/poly/doc/developer/lttv.html @@ -1,11 +1,11 @@ - Linux Trace Toolkit User tools + Linux Trace Toolkit trace analysis tools -

Linux Trace Toolkit User tools

+

Linux Trace Toolkit trace analysis tools

The Linux Trace Toolkit Visualizer, lttv, is a modular and extensible tool to read, analyze, annotate and display traces. It accesses traces through diff --git a/ltt/branches/poly/doc/developer/program-header.txt b/ltt/branches/poly/doc/developer/program-header.txt new file mode 100644 index 00000000..ccf99692 --- /dev/null +++ b/ltt/branches/poly/doc/developer/program-header.txt @@ -0,0 +1,17 @@ +/* This file is part of the Linux Trace Toolkit viewer + * Copyright (C) 2003-2004 Your Name + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License Version 2 as + * published by the Free Software Foundation; + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, + * MA 02111-1307, USA. + */ diff --git a/ltt/branches/poly/doc/developer/status.html b/ltt/branches/poly/doc/developer/status.html new file mode 100644 index 00000000..9fc1e4d7 --- /dev/null +++ b/ltt/branches/poly/doc/developer/status.html @@ -0,0 +1,26 @@ + + + + Current status + + + +

Current status

+ +

+As of january 28 2004, the Linux Trace Toolkit viewer is nearing feature +completeness for the first release. A few features need some additional work. +Thereafter, polishing, stabilizing, and documentation will take place before +adding new features. It can be considered pre alpha but usable for displaying +detailed event lists. Furthermore, it may be used to plan the development of +new modules for the viewer. + +The underlying libltt library is fairly stable and mature. It may be considered +alpha. +

+ + + + + + diff --git a/ltt/branches/poly/doc/developer/todo.html b/ltt/branches/poly/doc/developer/todo.html new file mode 100644 index 00000000..675f3533 --- /dev/null +++ b/ltt/branches/poly/doc/developer/todo.html @@ -0,0 +1,37 @@ + + + + Roadmap + + + +

Roadmap

+ +

+As of january 28 2004, the short term development plans include the following +items. + +