chiark / gitweb /
man: document sd_pid_get_slice() call of libsystemd-login
authorLennart Poettering <lennart@poettering.net>
Fri, 19 Jul 2013 16:10:12 +0000 (18:10 +0200)
committerLennart Poettering <lennart@poettering.net>
Fri, 19 Jul 2013 16:10:12 +0000 (18:10 +0200)
Makefile-man.am
TODO
man/sd_pid_get_session.xml

index e74ccea..a8d418f 100644 (file)
@@ -828,6 +828,7 @@ MANPAGES_ALIAS += \
        man/sd_login_monitor_unref.3 \
        man/sd_pid_get_machine_name.3 \
        man/sd_pid_get_owner_uid.3 \
+       man/sd_pid_get_slice.3 \
        man/sd_pid_get_unit.3 \
        man/sd_pid_get_user_unit.3 \
        man/sd_seat_can_multi_session.3 \
@@ -855,6 +856,7 @@ man/sd_login_monitor_get_timeout.3: man/sd_login_monitor_new.3
 man/sd_login_monitor_unref.3: man/sd_login_monitor_new.3
 man/sd_pid_get_machine_name.3: man/sd_pid_get_session.3
 man/sd_pid_get_owner_uid.3: man/sd_pid_get_session.3
+man/sd_pid_get_slice.3: man/sd_pid_get_session.3
 man/sd_pid_get_unit.3: man/sd_pid_get_session.3
 man/sd_pid_get_user_unit.3: man/sd_pid_get_session.3
 man/sd_seat_can_multi_session.3: man/sd_seat_get_active.3
@@ -904,6 +906,9 @@ man/sd_pid_get_machine_name.html: man/sd_pid_get_session.html
 man/sd_pid_get_owner_uid.html: man/sd_pid_get_session.html
        $(html-alias)
 
+man/sd_pid_get_slice.html: man/sd_pid_get_session.html
+       $(html-alias)
+
 man/sd_pid_get_unit.html: man/sd_pid_get_session.html
        $(html-alias)
 
diff --git a/TODO b/TODO
index 63b1280..d1d7140 100644 (file)
--- a/TODO
+++ b/TODO
@@ -46,7 +46,7 @@ CGroup Rework Completion:
 * introduce high-level settings for RT budget, swappiness
 
 * wiki: document new bus APIs of PID 1 (transient units, Reloading signal)
-* review: scope units, slice units, pid1, machinectl, libsystem-login, pam_system, systemctl commands
+* review: scope units, slice units, pid1, pam_system, systemctl commands
 
 * Send SIGHUP and SIGTERM in session scopes
 
index fd1ce4b..ecd22f7 100644 (file)
                 <refname>sd_pid_get_user_unit</refname>
                 <refname>sd_pid_get_owner_uid</refname>
                 <refname>sd_pid_get_machine_name</refname>
-                <refpurpose>Determine session, service, owner of a session or container/VM of a specific PID</refpurpose>
+                <refname>sd_pid_get_slice</refname>
+                <refpurpose>Determine session, service, owner of a
+                session, container/VM or slice of a specific
+                PID</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                                 <paramdef>pid_t <parameter>pid</parameter></paramdef>
                                 <paramdef>char** <parameter>name</parameter></paramdef>
                         </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_pid_get_slice</function></funcdef>
+                                <paramdef>pid_t <parameter>pid</parameter></paramdef>
+                                <paramdef>char** <parameter>slice</parameter></paramdef>
+                        </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
                 and not being a shared process of a user this function
                 will fail.</para>
 
-                <para><function>sd_pid_machine_name()</function> may
-                be used to determine the name of the VM or container
-                is a member of. The machine name is a short string,
-                suitable for usage in file system paths. The returned
-                string needs to be freed with the libc
+                <para><function>sd_pid_get_machine_name()</function>
+                may be used to determine the name of the VM or
+                container is a member of. The machine name is a short
+                string, suitable for usage in file system paths. The
+                returned string needs to be freed with the libc
+                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call after use.</para>
+
+                <para><function>sd_pid_get_slice()</function> may be
+                used to determine the slice unit the process is a
+                member of. See
+                <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for details about slices. The returned string needs to
+                be freed with the libc
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
                 <para>The <function>sd_pid_get_session()</function>,
                 <function>sd_pid_get_unit()</function>,
                 <function>sd_pid_get_user_unit()</function>,
-                <function>sd_pid_get_owner_uid()</function> and
-                <function>sd_pid_get_machine_name()</function>
-                interfaces are available as shared library, which can
-                be compiled and linked to with the
+                <function>sd_pid_get_owner_uid()</function>,
+                <function>sd_pid_get_machine_name()</function> and
+                <function>sd_pid_get_slice()</function> interfaces are
+                available as shared library, which can be compiled and
+                linked to with the
                 <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
 
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>