Fix README and add doc to tarball

Signed-off-by: David Goulet <david.goulet@polymtl.ca>

diff --git a/Makefile.am b/Makefile.am
index 3d86d6e66f238ff51569f22c6f3d1f90e213b25d..94b0c376d1aa6cbb97a1515bb6d841681b1d2204 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -10,4 +10,5 @@ SUBDIRS = liblttsessiondcomm \
                  ltt-kconsumerd \
                  ltt-sessiond \
                  tests \
-                 include
+                 include \
+                 doc

diff --git a/README b/README
index af6e8648895afcf7d68c9f6e74c1d4adf390ca59..389f3eda10f131ead3f62294a744ad0e05782c9c 100644 (file)
--- a/README
+++ b/README
@@ -5,60 +5,65 @@ Please visit http://lttng.org for more information.
 
 Latest development can be found at:
 
-       * Gitweb :      http://git.lttng.org/lttng-tools.git/
-       * Git :         git://git.lttng.org/lttng-tools.git
+    * Gitweb :  http://git.lttng.org/lttng-tools.git/
+    * Git :     git://git.lttng.org/lttng-tools.git
 
-PREREQUISITES:
+REQUIREMENTS:
 
-       - liburcu
-         Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-         
-         -> Tested with liburcu >= v0.5.4
+    - liburcu
+      Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-         * Debian/Ubuntu package: liburcu-dev
-         * Git : git://lttng.org/userspace-rcu.git
-         * Website:  http://lttng.org/urcu
+      -> Tested with liburcu >= v0.5.4
 
-       - libustctl
-         LTTng user-space tracer control library
+      * Debian/Ubuntu package: liburcu-dev
+      * Git : git://lttng.org/userspace-rcu.git
+      * Website:  http://lttng.org/urcu
 
-         Needed for interaction with that tracer.
+    - libpopt
+      Library for parsing command line parameters
 
-       - liblttctl
-         LTTng kernel tracer control library
-
-         Needed for interaction with that tracer.
+      * Debian/Ubuntu package: libpopt-dev
 
 INSTALLATION INSTRUCTIONS:
 
-  - Download, compile and install liburcu, libuuid, libustctl and liblttctl
-  - In this package's tree, run ./configure.
-  - Run make.
-  - Run make install.
-  - Run ldconfig.
+  - Download, compile and install the prerequisites.
+  Then:
+  $ ./configure
+  $ make
+  $ sudo make install
+  $ sudo ldconfig
 
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
 PACKAGE CONTENTS:
 
-       This package contains the following elements:
+    This package contains the following elements:
+
+    - liblttngctl
+      The LTTng tracing control library.
+
+    - liblttsessiondcomm
+      The ltt-sessiond communication library. In order to talk with ltt-sessiond,
+      thiis library must be used.
+
+    - libkernelctl
+      Kernel tracer control and ioctl definitions.
 
-       - liblttngctl
-         The LTTng trace control library.
+    - liblttkconsumerd
+      Library for Kernel trace consumer.
 
-       - liblttsessiondcomm
-         The ltt-sessiond communication library. In order to talk with ltt-sessiond,
-         thi library must be used.
+    - ltt-kconsumerd
+      The Kernel consumer daemon which uses liblttkconsumerd.
 
-       - ltt-sessiond
-         The LTTng session daemon binary.
+    - ltt-sessiond
+      The LTTng session daemon binary.
 
-       - lttng
-         The LTTng tracer command line control tool.
+    - lttng
+      The LTTng tracer command line control tool.
 
-       - include
-         The liblttngctl API header file.
+    - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
+      The liblttngctl API header file.
 
-       - tests
-         Various test programs.
+    - tests
+      Various test programs.

diff --git a/configure.ac b/configure.ac
index 2661173833b5fef62456ac2066b06ff9b9258137..a051887a643081d65b2de0ec54d2e56c5f119692 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -52,6 +52,7 @@ AC_CONFIG_FILES([
        ltt-sessiond/Makefile
        lttng/Makefile
        tests/Makefile
+       doc/Makefile
 ])
 
 AC_OUTPUT

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644 (file)
index 0000000..9ec9e42
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1 @@
+EXTRA_DIST = quickstart.txt session-daemon-model.txt