summaryrefslogtreecommitdiff
path: root/admin
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2022-09-15 06:30:40 +0200
committerStefan Kangas <stefankangas@gmail.com>2022-09-15 06:30:40 +0200
commit41551ccbf63df589ed50129e92fa8dfe457617d0 (patch)
tree393122ad365a8cae044174554b4ed53951c32414 /admin
parentb8e9239b47391c6628d94a4e2e91320c5366d27b (diff)
parent5543aea1b2b8c68481ae0ce2bb501d8484ef7f7c (diff)
downloademacs-41551ccbf63df589ed50129e92fa8dfe457617d0.tar.gz
Merge from origin/emacs-28
5543aea1b2 Automate exporting etc/NEWS to HTML 23a91163ed * Makefile.in (uninstall): Remove the *.eln files. (Bug#5...
Diffstat (limited to 'admin')
-rw-r--r--admin/admin.el130
1 files changed, 130 insertions, 0 deletions
diff --git a/admin/admin.el b/admin/admin.el
index fececc86a4b..07a66c419df 100644
--- a/admin/admin.el
+++ b/admin/admin.el
@@ -778,6 +778,136 @@ Optional argument TYPE is type of output (nil means all)."
(if (member type (list nil m))
(make-manuals-dist--1 root m))))
+(defun make-news-html-file (root version)
+ "Convert the NEWS file into an HTML file."
+ (interactive (let ((root
+ (if noninteractive
+ (or (pop command-line-args-left)
+ default-directory)
+ (read-directory-name "Emacs root directory: "
+ source-directory nil t))))
+ (list root
+ (read-string "Version number: " emacs-version))))
+ (unless (file-exists-p (expand-file-name "src/emacs.c" root))
+ (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
+ (let* ((dir (make-temp-file "emacs-news-file" t))
+ (orig (expand-file-name "etc/NEWS" root))
+ (new (expand-file-name (format "NEWS.%s.org" version) dir))
+ (html-file (format "%s.html" (file-name-base new)))
+ (copyright-years (format-time-string "%Y")))
+ (unwind-protect
+ (progn
+ (copy-file orig new)
+ (find-file new)
+
+ ;; Find the copyright range:
+ (goto-char (point-min))
+ (re-search-forward "^Copyright (C) \\([0-9-]+\\) Free Software Foundation, Inc.")
+ (setq copyright-years (match-string 1))
+
+ ;; Get rid of some unnecessary stuff:
+ (replace-regexp-in-region "^---$" "" (point-min) (point-max))
+ (replace-regexp-in-region "^\\+\\+\\+$" "" (point-min) (point-max))
+ (dolist (str '(" \n"
+ "GNU Emacs NEWS -- history of user-visible changes."
+ "Temporary note:"
+ "+++ indicates that all relevant manuals in doc/ have been updated."
+ "--- means no change in the manuals is needed."
+ "When you add a new item, use the appropriate mark if you are sure it"
+ "applies, and please also update docstrings as needed."
+ "You can narrow news to a specific version by calling 'view-emacs-news'"
+ "with a prefix argument or by typing 'C-u C-h C-n'."))
+ (replace-string-in-region str "" (point-min) (point-max)))
+
+ ;; Use Org-mode markers for <code>.
+ (replace-regexp-in-region
+ ;; This could probably be improved quite a bit...
+ (rx "'" (group (+ (not (any "'\n")))) "'")
+ "~\\1~" (point-min) (point-max))
+
+ ;; Format Emacs Lisp.
+ (while (re-search-forward "^ " nil t)
+ (backward-paragraph)
+ (insert "\n#+begin_src emacs-lisp")
+ (forward-paragraph)
+ (insert "#+end_src\n"))
+
+ ;; Insert Org-mode export headers.
+ (goto-char (point-min))
+ (insert (format
+ "\
+#+title: GNU Emacs %s NEWS -- history of user-visible changes
+#+author:
+#+options: author:nil creator:nil toc:1 num:2 *:nil \\n:nil
+#+language: en
+#+HTML_LINK_HOME: https://www.gnu.org/software/emacs
+#+html_head_extra: <link rel=\"stylesheet\" type=\"text/css\" href=\"/mini.css\" media=\"handheld\" />
+#+html_head_extra: <link rel=\"stylesheet\" type=\"text/css\" href=\"/layout.min.css\" media=\"screen\" />
+#+html_head_extra: <link rel=\"stylesheet\" type=\"text/css\" href=\"/print.min.css\" media=\"print\" />
+
+#+BEGIN_EXPORT html
+<div style=\"float:right;margin-left:1em;padding:3px;border:0px solid;text-align:center\">
+<a href=\"/graphics/gnu-head.jpg\">
+<img src=\"/graphics/gnu-head-sm.jpg\" alt=\" [image of the head
+of a GNU] \" width=\"129\" height=\"122\"/>
+</a>
+</div>
+#+END_EXPORT\n\n"
+ version))
+ (org-mode)
+ (let ((org-html-postamble
+ (format
+ "
+<p>
+Return to the <a href=\"/software/emacs/emacs.html\">GNU Emacs home page</a>.
+</p>
+
+<div id=\"footer\">
+<div class=\"unprintable\">
+
+<p>
+Please send FSF &amp; GNU inquiries to
+<a href=\"mailto:gnu@gnu.org\">&lt;gnu@gnu.org&gt;</a>.
+There are also <a href=\"/contact/\">other ways to contact</a>
+the FSF.
+Broken links and other corrections or suggestions can be sent to
+<a href=\"mailto:bug-gnu-emacs@gnu.org\">&lt;bug-gnu-emacs@gnu.org&gt;</a>.
+</p>
+</div>
+
+<p>
+ Copyright &copy; %s Free Software Foundation, Inc.
+</p>
+
+<p>This page is licensed under
+a <a href=\"https://creativecommons.org/licenses/by-sa/4.0\">CC-BY-SA</a>
+license.</p>
+
+<!--#include virtual=\"/server/bottom-notes.html\" -->
+
+<p class=\"unprintable\">
+Updated:
+<!-- timestamp start -->
+$Date: %s $
+<!-- timestamp end -->
+</p>
+</div>
+</div>"
+ copyright-years
+ ;; e.g. "2022/09/13 09:13:13"
+ (format-time-string "%Y/%M/%y %H:%m:%S"))))
+ ;; Actually export.
+ (org-html-export-to-html)
+ ;; Kill the .org buffer.
+ (kill-buffer (current-buffer))
+ ;; Move file into place.
+ (let ((old (expand-file-name html-file dir))
+ (new (expand-file-name html-file (expand-file-name "etc" root))))
+ (delete-file new)
+ (copy-file old new)
+ (find-file new))))
+ (delete-directory dir t))))
+
;; Stuff to check new `defcustom's got :version tags.
;; Adapted from check-declare.el.