linux-trace-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: Linux Trace Devel <linux-trace-devel@vger.kernel.org>
Subject: [PATCH] libtracefs: Add README
Date: Thu, 10 Dec 2020 12:13:47 -0500	[thread overview]
Message-ID: <20201210121347.5b8cfe33@gandalf.local.home> (raw)

From: "Steven Rostedt (VMware)" <rostedt@goodmis.org>

Add a README file that describes where the repositories are, how to build
and install the library, and how to ask questions and contribute.

Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
---
 README | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..ad95602
--- /dev/null
+++ b/README
@@ -0,0 +1,56 @@
+
+The official repository is here:
+
+  https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+
+This repository requires libtraceevent to be installed:
+
+  https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
+
+
+To build:
+
+    make;
+    sudo make install;
+
+To build in a specific directory outside of the source directory:
+
+    make O=/path/to/build; sudo make O=/path/to/build
+
+  Note that the path needs to exist before building.
+
+To set the install path (the expected final location):
+
+    make prefix=/usr; sudo make O=/path/to/build
+
+To install in a directory not for the local system (for use to move
+to another machine):
+
+    make DESTDIR=/path/to/dest/ install
+
+  Note, if you have write permission to the DESTDIR, then there is
+  no reason to use sudo or switch to root.
+
+  Note, DESTDIR must end with '/', otherwise the files will be appended
+  to the path, which will most likely have unwanted results.
+
+Contributions:
+
+  For questions about the use of the library, please send email to:
+
+    linux-trace-users@vger.kernel.org
+
+    Subscribe: http://vger.kernel.org/vger-lists.html#linux-trace-users
+    Archives: https://lore.kernel.org/linux-trace-users/
+
+  For contributions to development, please send patches to:
+
+    linux-trace-devel@vger.kernel.org
+
+    Subscribe: http://vger.kernel.org/vger-lists.html#linux-trace-devel
+    Archives: https://lore.kernel.org/linux-trace-devel/
+
+  Note, this project follows the style of submitting patches as described
+  by the Linux kernel.
+
+     https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html
-- 
2.25.4


                 reply	other threads:[~2020-12-10 17:49 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201210121347.5b8cfe33@gandalf.local.home \
    --to=rostedt@goodmis.org \
    --cc=linux-trace-devel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).