Update man pages for 2.11 #143
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Philippe Proulx <[email protected]>
Signed-off-by: Philippe Proulx <[email protected]>
`lttng disable-rotation` only unsets what has been previously set by `lttng enable-rotation`. The real limitations are for `lttng enable-rotation` and `lttng rotate`. Signed-off-by: Philippe Proulx <[email protected]>
Signed-off-by: Philippe Proulx <[email protected]>
Signed-off-by: Philippe Proulx <[email protected]>
Signed-off-by: Philippe Proulx <[email protected]>
* Better inline styles for option variables. * Option descriptions moved to the OPTIONS section. * Expand SDT acronym. * Add note indicating that SDT probes surrounded by reference counts are not supported. * Use "application" and "library" instead of "executable". Signed-off-by: Philippe Proulx <[email protected]> Reviewed-by: Francis Deslauriers <[email protected]>
Many people have contributed to LTTng-tools and the original authors are not necessarily the top ones now. For instance, GitHub reports this top 5 as of this patch: 1. jgalar 952 commits 45,889 ++ 13,959 -- 2. compudj 880 commits 56,579 ++ 28,095 -- 3. PSRCode 303 commits 25,553 ++ 10,909 -- 4. eepp 199 commits 12,119 ++ 6,461 -- 5. jdesfossez 174 commits 32,546 ++ 3,381 -- Also, man-pages(7), the conventions for writing Linux man pages, says: > Use of an AUTHORS section is strongly discouraged. Let's just keep the project's copyrights and some special thanks without selecting specific authors to list on each man page. Signed-off-by: Philippe Proulx <[email protected]>
jgalar
reviewed
Nov 13, 2018
doc/man/lttng-enable-rotation.1.txt
Outdated
| schedule condition periodically using the monitor timers of the tracing | ||
| session's channels. This means that, with the option:--timer option, the | ||
| automatic rotation can occur when the elapsed time since the last | ||
| automatic rotation is greater than 'PERIOD', and with the option:--size | ||
| option, the automatic rotation can occur when the size of the flushed | ||
| part of the current trace chunk is greater than 'SIZE'. See the | ||
| part of the current trace chunk is greater than 'SIZE'. Therefore the | ||
| 'PERIOD' and 'SIZE' arguments are approximations. See the |
There was a problem hiding this comment.
While SIZE is an approximation, the precision of which is governed by the monitor-timer, the PERIOD is fairly precise as it basically relies on the precision of the platform's implementation of POSIX timers.
jgalar
reviewed
Nov 13, 2018
| * Tracepoint/system call name ('EVENT' argument with option:--tracepoint | ||
| or option:--syscall options) or dynamic probe/function name/address | ||
| (option:--probe, option:--userspace-probe, and option:--function | ||
| option's argument) which must match event source's equivalent. |
There was a problem hiding this comment.
Is there a word missing on the last line?
There was a problem hiding this comment.
event source's equivalent [tracepoint/system call name] (implicit).
jgalar
reviewed
Nov 13, 2018
doc/man/lttng-enable-event.1.txt
Outdated
| an available symbol name or a SystemTap Statically Defined Tracepoints | ||
| (SDT, a DTrace-style marker) probe's provider and probe names. As of | ||
| this version, only SDT probes that are :not: surrounded by a reference | ||
| counter (semaphore). |
There was a problem hiding this comment.
Is there a "are supported" missing here?
Signed-off-by: Philippe Proulx <[email protected]>
Signed-off-by: Philippe Proulx <[email protected]>
|
Merged in master and stable-2.11, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.