diff options
| author | Emmanuele Bassi <ebassi@gnome.org> | 2018-02-20 18:33:19 +0000 |
|---|---|---|
| committer | P. F. Chimento <philip.chimento@gmail.com> | 2018-03-21 12:14:59 -0700 |
| commit | 4caf9df8b070140ee62218d3ea678f9732c1b8a7 (patch) | |
| tree | 3e8cda6fef7671840387f938e671a72ba8933dd5 /docs/reference/endless/eos-profile.xml | |
| parent | e53d0ffdd87927e1a8cdeed2f3d15e0fd102c8cc (diff) | |
Build man page and reference for eos-profile
Documenting CLI tools that we ship should be part of the API reference.
Diffstat (limited to 'docs/reference/endless/eos-profile.xml')
| -rw-r--r-- | docs/reference/endless/eos-profile.xml | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/reference/endless/eos-profile.xml b/docs/reference/endless/eos-profile.xml new file mode 100644 index 0000000..dc3b09f --- /dev/null +++ b/docs/reference/endless/eos-profile.xml @@ -0,0 +1,83 @@ +<refentry id="eos-profile-tool" lang="en"> + <refentryinfo> + <title>eos-profile</title> + <productname>Endless</productname> + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Emmanuele</firstname> + <surname>Bassi</surname> + <org><orgname>Endless</orgname></org> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>eos-profile</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="manual">User Commands</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>eos-profile</refname> + <refpurpose>Inspect profiling data</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>eos-profile</command> + <arg choice="plain">help</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>eos-profile</command> + <arg choice="plain">show</arg> + <arg choice="plain"><replaceable>FILE</replaceable></arg> + </cmdsynopsis> + <cmdsynopsis> + <command>eos-profile</command> + <arg choice="plain">convert</arg> + <arg choice="plain"><replaceable>FILE</replaceable></arg> + </cmdsynopsis> + <cmdsynopsis> + <command>eos-profile</command> + <arg choice="plain">diff</arg> + <arg choice="plain" rep="repeat"><replaceable>FILE</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + <command>eos-profile</command> is a tool for inspecting, converting, and + comparing profile data files generated by the Endless SDK. + </para> + </refsect1> + + <refsect1> + <title>Commands</title> + <variablelist> + <varlistentry> + <term><option>show</option></term> + <listitem><para> + Prints out a list of the profiling probes for the given file, + as well as the various timing information associated to each + probe, and their location in the source. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>convert</option></term> + <listitem><para> + Converts a profile data file into other formats, like JSON. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>diff</option></term> + <listitem><para> + Compares two or more profile data files, and prints out the + timing information for each probe in each file. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + +</refentry> |