[ltt-dev] [RFC] UST v0.15 documentation

[David Goulet]

Hi Matthew,

Thanks for this great work. Here some comments for UstStartUpGuide.html:

- User Space v0.12 --> v0.15 ??

-  I think using numbers in titles would be a good idea since the table of
contents uses number and maybe use section number like "5.1 UST marker functions"

- "UST is open source and free", this section, I think also providing a link to
the LGPL license would be good.

- libUST --> libust

- "MariaDB and KVM already have fully instrumented", not KVM but "QEMU"

- In "How Do We Install UST?", your example is using $HOME. You must be careful
since this is *not* a standard location to install libraries and headers on
Linux system. Guide like this are usually the "normal use case" people should
use to I think simply "./configure" would be fine here. If they want custom
paths, "./configure --help" :).

- UST marker, trace_mark is now "ust_marker". trace_mark still works but is
DEPRECATED. The "channel" is not used anymore with ust_marker.

- trace_mark_tp does not exist anymore...

That's it for now :)

Cheers!
David

On 11-10-13 06:01 PM, Matthew Khouzam wrote:
> Hello Tracing Warlords,
> 
> I just finished off a new version of the UST documentation for v0.15. It
> can be found here
> 
> http://git.dorsal.polymtl.ca/~mattkhouzam?p=ust_documentation;a=tag;h=3d56d066bda55a68ade76bfe0459a4e2d807e3c4
> 
> new features for this document are:
> * More complex examples of UST code for beginners to use.
> * The examples in the document are C code and have to be compiled. It
> shows if the api changed immediately.
> * There is a "benchmark" that is run for the code, the results are
> automatically inserted into the document to show any regressions or gains.
> 
>  
> 
> _______________________________________________
> ltt-dev mailing list
> ltt-dev at lists.casi.polymtl.ca
> http://lists.casi.polymtl.ca/cgi-bin/mailman/listinfo/ltt-dev