bug#67597: [PATCH] Specific rcirc log file time stamp format

[Philip Kaludercic]

Matto Fransen <matto@matto.nl> writes:

> Tags: patch
>
> Allows the time stamp in crirc log files to differ from
                           ^
                           "rcirc"; you appear to make this typo a few
                           more times below.

> the format in the chat buffers.
> For example, the chat buffers can have the format "%H:%M ",
> while the log files can have a format including the date.
>
> In GNU Emacs 30.0.50 (build 1, x86_64-unknown-freebsd14.0) of 2023-12-02
>  built on testnuc.tradesystem.nl
>  Repository revision: fb4b0b30a24e8192e71c1425dc8a295cf39f64ff
>  Repository branch: rcirc-log-timestamp-format
>  System Description: 14.0-RELEASE-p1
>
> Configured using:
>  'configure --with-x-toolkit=no --without-x'
>  
>
>>From fa0927f06e88322e274f8ce668a71de41b02b80a Mon Sep 17 00:00:00 2001
> From: Matto Fransen <mattofransen@gmail.com>
> Date: Sat, 2 Dec 2023 20:55:37 +0100
> Subject: [PATCH] Specific crirc log file time stamp fomrmat
>
> The time stamp format in the chat buffer may now
> differ from the format in the log files.
> * doc/misc/rcirc.texi: Document new variable
> * lisp/net/rcirc.el (rcirc-log-time-format):
> Custom variable for the format.
>
> Copyright-paperwork-exempt: yes
> ---
>  doc/misc/rcirc.texi | 8 ++++++++
>  etc/NEWS            | 7 ++++++-
>  lisp/net/rcirc.el   | 8 +++++++-
>  3 files changed, 21 insertions(+), 2 deletions(-)
>
> diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi
> index 6b10d1ab2a4..aa424d8e164 100644
> --- a/doc/misc/rcirc.texi
> +++ b/doc/misc/rcirc.texi
> @@ -929,6 +929,7 @@ Changing the time stamp format
>  @cindex date time
>  @cindex format time stamp
>  @vindex rcirc-time-format
> +@vindex rcirc-log-time-format
>  
>  @code{rcirc-time-format} is the format used for the time stamp.  Here's
>  how to include the date in the time stamp:
> @@ -937,6 +938,13 @@ Changing the time stamp format
>  (setopt rcirc-time-format "%Y-%m-%d %H:%M ")
>  @end example
>  
> +@code{rcirc-log-time-format} is the format used for the time stamp
> +in the log files.  Here's how to use month and day in the time stamp:
> +
> +@example
> +(setopt rcirc-log-time-format "%m-%d %H:%M ")
> +@end example

I don't think the example here is necessary, nor does duplicating the
previous paragraph sound nice IMO.  It should suffice to just mention
the user option in a sentence like

  "For log files, a different time format can be specified using the
  `rcirc-log-time-format' user option."

>  @findex rcirc-when
>  If you don't wish to use verbose time formatting all the time, you can
>  use the @code{rcirc-when} command to display a complete timestamp for
> diff --git a/etc/NEWS b/etc/NEWS
> index da00ea9dbda..44cbf21a3d3 100644
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -1077,11 +1077,16 @@ For links in 'webjump-sites' without an explicit URI 
> scheme, it was
>  previously assumed that they should be prefixed with "http://";.  Such
>  URIs are now prefixed with "https://"; instead.
>  
> ----
> +
>  *** 'bug-reference-mode' now supports 'thing-at-point'.
>  Now, calling '(thing-at-point 'url)' when point is on a bug reference
>  will return the URL for that bug.
>  
> +

You don't need to add these empty newlines before each header.

> +*** Specific timestamp format for crirc log files
> +Now, the timestamp format in crirc chat buffers can differ from the
> +timestamp format in the log files.
> +
>  ** Customize
>  
>  +++
> diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
> index ecfeb9f8f84..6390d4dd284 100644
> --- a/lisp/net/rcirc.el
> +++ b/lisp/net/rcirc.el
> @@ -229,6 +229,12 @@ rcirc-time-format
>  Used as the first arg to `format-time-string'."
>    :type 'string)
>  
> +(defcustom rcirc-log-time-format "%d-%b %H:%M "
> +  "Describes how timestamps are printed in the log files.
> +Used as the first arg to `format-time-string'."
> +  :version "30.1"
> +  :type 'string )
> +
>  (defcustom rcirc-input-ring-size 1024
>    "Size of input history ring."
>    :type 'integer)
> @@ -2209,7 +2215,7 @@ rcirc-log
>                  (parse-iso8601-time-string time t))))
>      (unless (null filename)
>        (let ((cell (assoc-string filename rcirc-log-alist))
> -            (line (concat (format-time-string rcirc-time-format time)
> +            (line (concat (format-time-string rcirc-log-time-format time)
>                            (substring-no-properties
>                             (rcirc-format-response-string process sender
>                                                           response target 
> text))