[lttng-dev] [PATCH lttng-ust] Doc: Update README

[Mathieu Desnoyers]

----- On Apr 25, 2016, at 4:11 PM, Mathieu Desnoyers mathieu.desnoyers at efficios.com wrote:

> ----- On Apr 25, 2016, at 4:06 PM, Michael Jeanson mjeanson at efficios.com wrote:
> 
>> ----- On Apr 25, 2016, at 3:53 PM, Mathieu Desnoyers
>> mathieu.desnoyers at efficios.com wrote:
>> 
>>> ----- On Apr 25, 2016, at 3:08 PM, Michael Jeanson mjeanson at efficios.com wrote:
>>> 
>>>> Signed-off-by: Michael Jeanson <mjeanson at efficios.com>
>>>> ---
>>>> README.md | 14 +++++++++-----
>>>> 1 file changed, 9 insertions(+), 5 deletions(-)
>>>> 
>>>> diff --git a/README.md b/README.md
>>>> index a2d9e63..728c103 100644
>>>> --- a/README.md
>>>> +++ b/README.md
>>>> @@ -33,7 +33,7 @@ compile the Git repository tree:
>>>> 
>>>> ### Optional dependencies
>>>> 
>>>> -Optional packages to build LTTng-tools man pages:
>>>> +Optional packages to build LTTng-ust man pages:
>>>> 
>>>>   - **[AsciiDoc](http://www.methods.co.nz/asciidoc/) >= 8.4.5**
>>>>     (previous versions may work, but were not tested)
>>>> @@ -225,15 +225,19 @@ This package contains the following elements:
>>>>     It _has_ to be preloaded in order to hijack calls. In contrast,
>>>>     `liblttng-ust` may be linked at build time.
>>>>   - `liblttng-ust-java`: a simple library that uses JNI to allow tracing
>>>> -    in Java programs.
>>>> -  - `liblttng-ust-jul`: a package that includes a JNI library and a JAR
>>>> -    library to provide an LTTng-UST logging back-end for Java application
>>>> -    using Java Util Logging.
>>>> +    in Java programs. (Deprecated)
>>> 
>>> Is it really deprecated ?
>> 
>> Well, you tell me but I was lead to believe it would be removed once the java
>> agent was stable and feature complete. As far as I know, it is untested and
>> not even built in the CI.
> 
> This JNI interface is probably faster than going through the JUL/log4j agents.
> Therefore, there appears to be legitimate use-cases for it. If tests/CI
> integration
> are missing, we should eventually add those.
> 
> But AFAIK, it is not deprecated.

merging this patch, but removing the "(Deprecated)".

This is going into master, 2.8, and 2.7 (with changes).

Thanks,

Mathieu

> 
> Thanks,
> 
> Mathieu
> 
>> 
>>> 
>>> Mathieu
>>> 
>>>> +  - `liblttng-ust-java-agent`: a package that includes a JNI library and a
>>>> +    JAR library to provide an LTTng-UST logging back-end for Java
>>>> +    applications using Java Util Logging or Log4j.
>>>>   - `liblttng-ust-libc-wrapper`: an example library that can be
>>>>     preloaded to instrument some calls to libc (currently `malloc()` and
>>>>     `free()`) and to POSIX threads (mutexes currently instrumented) in
>>>>     any program without need to recompile it.
>>>> +  - `liblttng-ust-python-agent`: a library used by python-lttngust to allow
>>>> +    tracing in Python applications.
>>>>   - `libringbuffer`: the ring buffer implementation used within LTTng-UST.
>>>> +  - `python-lttngust`: a package to provide an LTTng-UST logging back-end
>>>> +    for Python applications using the standard logging framework.
>>>>   - `snprintf`: an asynchronous signal-safe version of `snprintf()`.
>>>>   - `tests`: various test programs.
>>>>   - `tools`: home of `lttng-gen-tp`.
>>>> --
>>>> 2.7.4
>>> 
>>> --
>>> Mathieu Desnoyers
>>> EfficiOS Inc.
>> > http://www.efficios.com
> 
> --
> Mathieu Desnoyers
> EfficiOS Inc.
> http://www.efficios.com
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> https://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev

-- 
Mathieu Desnoyers
EfficiOS Inc.
http://www.efficios.com