From 8d81ab374da4d159cd05cd8caaaae2390829ccee Mon Sep 17 00:00:00 2001 From: Stephen Gildea Date: Tue, 9 Nov 2021 20:09:22 -0800 Subject: [PATCH] time-stamp: %F is "file name" not "pathname" + other doc * lisp/time-stamp.el (time-stamp-format): doc 'file' instead of 'path'. * test/lisp/time-stamp-tests.el (formatz, format-time-offset): Clarify the difference and similarity between these two test helpers. --- lisp/time-stamp.el | 4 ++-- test/lisp/time-stamp-tests.el | 11 ++++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/lisp/time-stamp.el b/lisp/time-stamp.el index 178e490fb7d..04e736d027c 100644 --- a/lisp/time-stamp.el +++ b/lisp/time-stamp.el @@ -65,7 +65,7 @@ with %, as follows. Non-date items: %% a literal percent character: `%' -%f file name without directory %F gives absolute pathname +%f file name without directory %F absolute file name %l login name %L full name of logged-in user %q unqualified host name %Q fully-qualified host name %h mail host name @@ -661,7 +661,7 @@ and all `time-stamp-format' compatibility." (if buffer-file-name (file-name-nondirectory buffer-file-name) time-stamp-no-file)) - ((eq cur-char ?F) ;buffer-file-name, full path + ((eq cur-char ?F) ;buffer-file-name, absolute name (or buffer-file-name time-stamp-no-file)) ((eq cur-char ?s) ;system name, legacy diff --git a/test/lisp/time-stamp-tests.el b/test/lisp/time-stamp-tests.el index fa9edcbd407..cb446eb486e 100644 --- a/test/lisp/time-stamp-tests.el +++ b/test/lisp/time-stamp-tests.el @@ -704,9 +704,10 @@ ;;;; Setup for tests of time offset formatting with %z (defun formatz (format zone) - "Uses time FORMAT string to format the offset of ZONE, returning the result. -FORMAT is \"%z\" or a variation. -ZONE is as the ZONE argument of the `format-time-string' function." + "Uses FORMAT to format the offset of ZONE, returning the result. +FORMAT must be time format \"%z\" or some variation thereof. +ZONE is as the ZONE argument of the `format-time-string' function. +This function is called by 99% of the `time-stamp' \"%z\" unit tests." (with-time-stamp-test-env (let ((time-stamp-time-zone zone)) ;; Call your favorite time formatter here. @@ -718,9 +719,9 @@ ZONE is as the ZONE argument of the `format-time-string' function." (defun format-time-offset (format offset-secs) "Uses FORMAT to format the time zone represented by OFFSET-SECS. -FORMAT must be \"%z\", possibly with a flag and padding. +FORMAT must be time format \"%z\" or some variation thereof. This function is a wrapper around `time-stamp-formatz-from-parsed-options' -and is used for testing." +and is called by some low-level `time-stamp' \"%z\" unit tests." ;; This wrapper adds a simple regexp-based parser that handles only ;; %z and variants. In normal use, time-stamp-formatz-from-parsed-options ;; is called from a parser that handles all time string formats. -- 2.39.2