-
-
-[[terminology]]
-== Terminology
-
-What follows is an official, partial list of technical terms used by the
-LTTng Documentation. Other forms of those terms are _not_ permitted. For
-example, do not write `use-case` or `filesystem`.
-
-Autotools::
- The GNU Autotools.
-+
-Do not use _autotools_.
-
-Babeltrace::
- The Babeltrace project, which includes the `babeltrace` command, some
- libraries, and Python bindings.
-+
-Use +`babeltrace`+ to refer to the actual `babeltrace` command.
-
-Babeltrace Python bindings::
- The Python bindings of Babeltrace.
-+
-The plural _bindings_ is important.
-
-Bash::
- The Bash shell.
-+
-Do not use _bash_.
-
-buffering scheme::
- A layout of tracing buffers applied to a given channel.
-
-channel::
- An LTTng channel.
-
-CLI::
- Prefer expanding this acronym to _command-line interface_ in the text.
-
-clock::
- A reference of time for a tracer.
-+
-Use _system time_ to refer to the date and time as seen by a user.
-
-command-line::
- Adjective version of _command line_: _command-line option_,
- _command-line interface_.
-
-command-line interface::
- An interface in which the user enters command lines to instruct the
- system what to do.
-+
-Prefer using _command_ or _command-line tool_ to refer to a
-specific command.
-
-command line::
- An actual line of command entered by the user in a terminal, at a
- command prompt.
-+
-Write _command-line_ when used as an adjective.
-
-consumer daemon::
- The LTTng consumer daemon.
-+
-Do not use _consumerd_.
-+
-Use +`lttng-consumerd`+ to refer to the consumer daemon
-executable.
-
-domain::
- Do not use when referring to a _tracing domain_.
-
-event::
- Occurrence recognised by software, emitted by a tracer when specific
- conditions are met, at a given time. An event _occurs_ at a specific
- time, after which a tracer can record its payload.
-
-event loss mode::
- The mechanism by which event records of a given channel are lost
- (not recorded) when there is no sub-buffer space left to store them.
-
-event name::
- The name of an event, which is also the name of the event record.
- This is different from a _tracepoint name_, which is only the name
- of the instrumentation point, not necessarily equal to the event
- name.
-
-event record::
- Record, in a trace, of the payload of an event which occured.
-
-event rule::
- Set of conditions which must be satisfied for one or more events
- to occur. The `lttng enable-event` command creates and enables
- _event rules_, not _events_.
-
-file system::
- Contains directories, files, and links in an organized structure.
-+
-Do not use _filesystem_ or _file-system_.
-
-+`java.util.logging`+::
- Even though the `--jul` command-line option is an acronym for this
- term, there is no such thing as _Java Util Logging_. The only
- correct form is the name of the Java package,
- +`java.util.logging`+.
-
-instrumentation::
- The use of LTTng probes to make a software traceable.
-
-libc::
- Do not use.
-+
-Use _the C standard library_ to refer to the standard library for
-the C programming language, or _glibc_ to refer to the GNU C Library
-specifically.
-
-log4j::
- LTTng-UST supports Java logging using Apache _log4j_, not Apache
- Log4j 2.
-
-log level::
- Level of severity of a log statement.
-+
-Do not hyphenate.
-
-kernel::
- In general, do not use _kernel_ to refer to the _Linux kernel_: use
- the whole _Linux kernel_ term, because other operating system kernels
- exist. Since the _L_ in _LTTng_ means _Linux_, it's okay to use _LTTng
- kernel modules_.
-
-Linux Trace Toolkit: next generation::
- The expansion of the _LTTng_ acronym.
-+
-The colon and the lowercase _n_ and _g_ are important.
-
-LTTng-analyses::
- The LTTng-analyses project.
-
-LTTng-modules::
- The LTTng-modules project.
-
-LTTng-tools::
- The LTTng-tools project.
-
-LTTng-UST::
- The LTTng-UST project.
-
-LTTng-UST Java agent::
-LTTng-UST Python agent::
- An LTTng user space agent.
-+
-Do not use _Java LTTng-UST agent_ or _Python LTTng-UST agent_.
-
-LTTng Documentation::
- The name of this project.
-+
-Do not use _LTTng documentation_.
-+
-When referring to the project, the _the_ determiner can be lowercase:
-_Welcome to the LTTng Documentation!_.
-
-LTTng live::
- The name of a communication protocol between Babeltrace and the
- relay daemon which makes it possible to see events "live",
- as they are received by the relay daemon.
-+
-Do not hyphenate.
-
-the +`lttng`+ tool::
-the +`lttng`+ command line tool::
- The `lttng` command line tool.
-+
-When _tool_ has been mentioned in the previous sentences, you can use
-+`lttng`+ alone.
-
-Makefile::
- An input for the make tool.
-+
-Do not use _makefile_ or _make file_.
-
-man page::
- Unix-style reference manual page.
-+
-Do not hyphenate.
-
-per-process buffering::
- A buffering scheme in which each process has its own buffer for a
- given user space channel.
-+
-Do not use _per-PID buffering_.
-
-per-user buffering::
- A buffering scheme in which all the processes of a user share the same
- buffer for a given user space channel.
-+
-Do not use _per-UID buffering_.
-
-probe::
- An instrumentation point.
-+
-Prefer _tracepoint_ when referring to a user space or Linux kernel
-LTTng tracepoint.
-
-real-time clock::
- A clock which keeps track of the current time, including eventual
- time corrections.
-+
-Do not use _realtime clock_ or _real time clock_.
-
-relay daemon::
- The LTTng relay daemon.
-+
-Do not use _relayd_.
-+
-Use +`lttng-relayd`+ to refer to the relay daemon executable.
-
-root user::
- A superuser of a Linux system.
-+
-Do not use +`root`+.
-
-session::
- Do not use when referring to a _tracing session_.
-
-session daemon::
- The LTTng session daemon.
-+
-Do not use _sessiond_.
-+
-Use +`lttng-sessiond`+ to refer to the session daemon
-executable.
-
-snapshot::
- Copy of the current data of all the buffers of a given tracing
- session, saved as a trace.
-
-sub-buffer::
- One part of an LTTng ring buffer.
-+
-Do not use _subbuffer_ since it's harder to read with the two
-contiguous b's.
-
-timestamp::
- Time information attached to an event when it is emitted. This is not
- necessarily a _Unix timestamp_.
-+
-Do not use _time stamp_.
-
-trace::
- As a verb: a user or a tracer can _trace_ an application.
-
-Trace Compass::
- The Trace Compass project and application.
-+
-Do not hyphenate. Do not use _Trace compass_, _TraceCompass_, or
-_Tracecompass_.
-
-tracepoint::
- An instrumentation point using the tracepoint mechanism of
- the Linux kernel or of LTTng-UST.
-+
-Do not use _trace point_ or _trace-point_.
-
-tracepoint definition::
- The definition of a single tracepoint.
-
-tracepoint name::
- The name of a _tracepoint_.
-+
-Not to be confused with an _event name_.
-
-tracepoint provider::
- A set of functions providing tracepoints to an instrumented user
- application.
-+
-Not to be confused with a _tracepoint provider package_: many tracepoint
-providers can exist within a tracepoint provider package.
-
-tracepoint provider package::
- One or more tracepoint providers compiled as an object file or as
- a shared library.
-
-tracing domain::
- An LTTng tracing domain.
-+
-Always use the complete _tracing domain_ term, not _domain_ alone,
-unless _tracing domain_ has been used in the few preceding sentences.
-
-tracing group::
- The Unix group in which a user can be to be allowed to trace the
- Linux kernel.
-+
-Do not use _`tracing` group_, as the name of the tracing
-group is configurable.
-
-tracing session::
- An LTTng tracing session.
-+
-Always use the complete _tracing session_ term, not _session_ alone.
-
-Unix::
- Unix operating system or philosophy.
-+
-Do not use _UNIX_.
-
-Unix epoch::
- Absolute reference of a real-time clock.
-+
-Use the term as a proper noun: do not precede it with _the_.
-+
-Do not use _Epoch_ alone.
-
-Unix timestamp::
- Timestamp represented as the number of seconds since Unix epoch.
-
-use case::
- According to Wikipedia: List of actions or event steps, typically
- defining the interactions between a role and a system, to
- achieve a goal.
-+
-Do not hyphenate.
-
-user application::
- An application running in user space, as opposed to a Linux kernel
- module, for example.
-+
-Do not use _user space application_, as this is redundant.
-
-user space::
- User processes.
-+
-Do not hyphenate.