* Date in emacs man-file
@ 2020-09-13 10:50 Colin Baxter
2020-09-13 12:12 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Colin Baxter @ 2020-09-13 10:50 UTC (permalink / raw)
To: emacs-devel
Hello,
I notice the second line of the file man/emacs.1.in has "2007 April
13". Therefore "man emacs <RET>" will give this date at the foot of the
manual, along side the emacs version (27.1 in the case of the latest
release). Should not this date be amended to something more recent?
Best wishes,
Colin Baxter.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Date in emacs man-file
2020-09-13 10:50 Date in emacs man-file Colin Baxter
@ 2020-09-13 12:12 ` Stefan Kangas
2020-09-16 11:24 ` Colin Baxter
2020-10-11 11:49 ` Stefan Kangas
0 siblings, 2 replies; 6+ messages in thread
From: Stefan Kangas @ 2020-09-13 12:12 UTC (permalink / raw)
To: Colin Baxter, emacs-devel
Colin Baxter <m43cap@yandex.com> writes:
> I notice the second line of the file man/emacs.1.in has "2007 April
> 13". Therefore "man emacs <RET>" will give this date at the foot of the
> manual, along side the emacs version (27.1 in the case of the latest
> release). Should not this date be amended to something more recent?
"man 7 man-pages" says:
date The date of the last nontrivial change that was made to the man
page. (Within the man-pages project, the necessary updates to
these timestamps are handled automatically by scripts, so there
is no need to manually update them as part of a patch.) Dates
should be written in the form YYYY-MM-DD.
Perhaps we could add a local timestamp variable to update it
automatically? It would catch even insignificant changes, but it would
be up to the committer to update the timestamp or not.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Date in emacs man-file
2020-09-13 12:12 ` Stefan Kangas
@ 2020-09-16 11:24 ` Colin Baxter
2020-10-11 11:49 ` Stefan Kangas
1 sibling, 0 replies; 6+ messages in thread
From: Colin Baxter @ 2020-09-16 11:24 UTC (permalink / raw)
To: emacs-devel
>>>>> Stefan Kangas <stefankangas@gmail.com> writes:
> Colin Baxter <m43cap@yandex.com> writes:
>> I notice the second line of the file man/emacs.1.in has "2007
>> April 13". Therefore "man emacs <RET>" will give this date at the
>> foot of the manual, along side the emacs version (27.1 in the
>> case of the latest release). Should not this date be amended to
>> something more recent?
> "man 7 man-pages" says:
> date The date of the last nontrivial change that was made
> to the man page. (Within the man-pages project, the necessary
> updates to these timestamps are handled automatically by scripts,
> so there is no need to manually update them as part of a patch.)
> Dates should be written in the form YYYY-MM-DD.
> Perhaps we could add a local timestamp variable to update it
> automatically? It would catch even insignificant changes, but it
> would be up to the committer to update the timestamp or not.
Curiously, there's a recent reddit enquiry on just this very issue.
https://www.reddit.com/r/emacs/comments/hszg0a/hook_for_updating_manpage_timestamp_in_line_1/
The proposed lisp defun works on the first line only of the nroff file,
for a different date format - but it does work.
Best wishes,
Colin Baxter.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Date in emacs man-file
2020-09-13 12:12 ` Stefan Kangas
2020-09-16 11:24 ` Colin Baxter
@ 2020-10-11 11:49 ` Stefan Kangas
2020-10-11 15:14 ` Colin Baxter
1 sibling, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2020-10-11 11:49 UTC (permalink / raw)
To: Colin Baxter, emacs-devel
[-- Attachment #1: Type: text/plain, Size: 1263 bytes --]
Stefan Kangas <stefankangas@gmail.com> writes:
> Colin Baxter <m43cap@yandex.com> writes:
>
>> I notice the second line of the file man/emacs.1.in has "2007 April
>> 13". Therefore "man emacs <RET>" will give this date at the foot of the
>> manual, along side the emacs version (27.1 in the case of the latest
>> release). Should not this date be amended to something more recent?
>
> "man 7 man-pages" says:
>
> date The date of the last nontrivial change that was made to the man
> page. (Within the man-pages project, the necessary updates to
> these timestamps are handled automatically by scripts, so there
> is no need to manually update them as part of a patch.) Dates
> should be written in the form YYYY-MM-DD.
>
> Perhaps we could add a local timestamp variable to update it
> automatically? It would catch even insignificant changes, but it would
> be up to the committer to update the timestamp or not.
How does the attached patch look? In addition to fixing the dates, I
added a time-stamp-pattern and updated the title lines to match the
recommendations in "man man-pages". (I also took a look at the gcc man
page and made sure they use the "GNU" header like I do here.)
[-- Attachment #2: 0001-Fix-man-page-title-lines-and-timestamps.patch --]
[-- Type: text/x-diff, Size: 3576 bytes --]
From e253edcb7060c436b33f544450deb300d36bb594 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 11 Oct 2020 13:12:47 +0200
Subject: [PATCH] Fix man page title lines and timestamps
* doc/man/ebrowse.1:
* doc/man/emacs.1.in:
* doc/man/emacsclient.1:
* doc/man/etags.1: Update date to match last significant change. Set
file local variable time-stamp-pattern. Fix title line to match the
recommendations in "man man-pages".
Ref: https://lists.gnu.org/r/emacs-devel/2020-09/msg01002.html
---
doc/man/ebrowse.1 | 6 +++++-
doc/man/emacs.1.in | 6 +++++-
doc/man/emacsclient.1 | 6 +++++-
doc/man/etags.1 | 6 +++++-
4 files changed, 20 insertions(+), 4 deletions(-)
diff --git a/doc/man/ebrowse.1 b/doc/man/ebrowse.1
index 686658b20f..330c1ea523 100644
--- a/doc/man/ebrowse.1
+++ b/doc/man/ebrowse.1
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH EBROWSE 1
+.TH EBROWSE 1 "2008-12-14" "GNU Emacs" "GNU"
.SH NAME
ebrowse \- create a class hierarchy database
.SH SYNOPSIS
@@ -98,3 +98,7 @@ document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EBROWSE 1 \"%Y-%02m-%02d\" \"GNU Emacs\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/emacs.1.in b/doc/man/emacs.1.in
index 5a164e98cd..3a5758e1aa 100644
--- a/doc/man/emacs.1.in
+++ b/doc/man/emacs.1.in
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH EMACS 1 "2007 April 13" "GNU Emacs @version@"
+.TH EMACS 1 "2020-04-05" "GNU Emacs @version@" "GNU"
.
.
.SH NAME
@@ -673,3 +673,7 @@ document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EMACS 1 \"%Y-%02m-%02d\" \"GNU Emacs @version@\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/emacsclient.1 b/doc/man/emacsclient.1
index 3bdaafbfc5..9d14d0fe75 100644
--- a/doc/man/emacsclient.1
+++ b/doc/man/emacsclient.1
@@ -1,5 +1,5 @@
.\" See section COPYING for conditions for redistribution.
-.TH EMACSCLIENT 1
+.TH EMACSCLIENT 1 "2019-08-02" "GNU Emacs" "GNU"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other params are allowed: see man(7), man(1)
.SH NAME
@@ -114,3 +114,7 @@ This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>,
for the Debian GNU/Linux system (but may be used by others).
.SH COPYING
This manual page is in the public domain.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EMACSCLIENT 1 \"%Y-%02m-%02d\" \"GNU Emacs\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/etags.1 b/doc/man/etags.1
index e10fb840ca..8053e863fc 100644
--- a/doc/man/etags.1
+++ b/doc/man/etags.1
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
+.TH ETAGS 1 "2019-06-24" "GNU Tools" "GNU"
.de BP
.sp
.ti -.2i
@@ -296,3 +296,7 @@ Permission is granted to copy and distribute translations of this
document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH ETAGS 1 \"%Y-%02m-%02d\" \"GNU Tools\" \"GNU\"$"
+.\" End:
--
2.28.0
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: Date in emacs man-file
2020-10-11 11:49 ` Stefan Kangas
@ 2020-10-11 15:14 ` Colin Baxter
2020-10-12 19:05 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Colin Baxter @ 2020-10-11 15:14 UTC (permalink / raw)
To: emacs-devel
>>>>> Stefan Kangas <stefankangas@gmail.com> writes:
> Stefan Kangas <stefankangas@gmail.com> writes:
>> Colin Baxter <m43cap@yandex.com> writes:
>>
>>> I notice the second line of the file man/emacs.1.in has "2007
>>> April 13". Therefore "man emacs <RET>" will give this date at
>>> the foot of the manual, along side the emacs version (27.1 in
>>> the case of the latest release). Should not this date be amended
>>> to something more recent?
>>
>> "man 7 man-pages" says:
>>
>> date The date of the last nontrivial change that was made to the
>> man page. (Within the man-pages project, the necessary updates
>> to these timestamps are handled automatically by scripts, so
>> there is no need to manually update them as part of a patch.)
>> Dates should be written in the form YYYY-MM-DD.
>>
>> Perhaps we could add a local timestamp variable to update it
>> automatically? It would catch even insignificant changes, but it
>> would be up to the committer to update the timestamp or not.
> How does the attached patch look? In addition to fixing the
> dates, I added a time-stamp-pattern and updated the title lines to
> match the recommendations in "man man-pages". (I also took a look
> at the gcc man page and made sure they use the "GNU" header like I
> do here.)
I've added the patch to a test branch of my local emacs git repository
and the man pages ebrowse.1, emacs.1.in, emacsclient.1, etags.1 all look
great.
Thanks.
Best wishes,
Colin Baxter.
Colin Baxter
URL: http://www.Colin-Baxter.com
---------------------------------------------------------------------
GnuPG fingerprint: 68A8 799C 0230 16E7 BF68 2A27 BBFA 2492 91F5 41C8
---------------------------------------------------------------------
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Date in emacs man-file
2020-10-11 15:14 ` Colin Baxter
@ 2020-10-12 19:05 ` Stefan Kangas
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Kangas @ 2020-10-12 19:05 UTC (permalink / raw)
To: Colin Baxter, emacs-devel
Colin Baxter <m43cap@yandex.com> writes:
> I've added the patch to a test branch of my local emacs git repository
> and the man pages ebrowse.1, emacs.1.in, emacsclient.1, etags.1 all look
> great.
Thanks for testing. Pushed to master as commit a6c22271bc.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2020-10-12 19:05 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-13 10:50 Date in emacs man-file Colin Baxter
2020-09-13 12:12 ` Stefan Kangas
2020-09-16 11:24 ` Colin Baxter
2020-10-11 11:49 ` Stefan Kangas
2020-10-11 15:14 ` Colin Baxter
2020-10-12 19:05 ` Stefan Kangas
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).