changeset 91:039aae9a01f7

Improve documentation on TTY functions.
author Paul Fisher <paul@pfish.zone>
date Wed, 18 Jun 2025 16:30:41 -0400
parents f6186e41399b
children 5ddbcada30f2
files src/handle.rs
diffstat 1 files changed, 4 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/handle.rs	Sat Jun 14 09:30:16 2025 -0400
+++ b/src/handle.rs	Wed Jun 18 16:30:41 2025 -0400
@@ -138,17 +138,16 @@
     );
 
     trait_item!(
-        /// "The terminal name prefixed by /dev/ for device files."
+        /// The device path of the TTY being used to log in.
         ///
-        /// This is the terminal the user is logging in on.
+        /// This is the terminal the user is logging in on,
+        /// specified as the full device path (e.g. `/dev/tty0`).
         /// Very old applications may use this instead of `PAM_XDISPLAY`.
         get = tty_name,
         item = "PAM_TTY"
     );
     trait_item!(
-        /// Sets the terminal name.
-        ///
-        /// (TODO: See if libpam sets this itself or if the application does.)
+        /// Sets the path to the terminal where the user is logging on.
         set = set_tty_name,
         item = "PAM_TTY",
         see = Self::tty_name