user/dev discussion of public-inbox itself
 help / color / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH 1/5] doc: avoid needless rebuilds of NEWS
Date: Fri, 24 Jan 2020 22:09:29 +0000
Message-ID: <20200124220933.11970-2-e@yhbt.net> (raw)
In-Reply-To: <20200124220933.11970-1-e@yhbt.net>

Repeatedly rebuilding `NEWS' because the mtime of `NEWS'
is synched to the latest release .eml is a bit annoying,
but necessary to save bandwidth for the website.

So we'll also update the mtime of the source .eml file when
reading them.  It's kinda gross to be setting mtimes of source
.eml files in Documentation/RelNotes/, but I can't think of
anything better at the moment...
---
 Documentation/include.mk  |  7 +------
 Documentation/mknews.perl | 16 ++++++++++++----
 Makefile.PL               |  3 +++
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 0229bf40..3d88fcec 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -62,12 +62,7 @@ Documentation/standards.txt : Documentation/standards.perl
 	touch -r Documentation/standards.perl $@+
 	mv $@+ $@
 
-RELEASES =
-RELEASES += v1.2.0
-RELEASES += v1.1.0-pre1
-RELEASES += v1.0.0
-
-NEWS NEWS.atom NEWS.html : Documentation/include.mk
+NEWS NEWS.atom NEWS.html : $(news_deps)
 	$(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 
 # check for internal API changes:
diff --git a/Documentation/mknews.perl b/Documentation/mknews.perl
index 3efabdb5..71b1a996 100755
--- a/Documentation/mknews.perl
+++ b/Documentation/mknews.perl
@@ -21,8 +21,8 @@ my $atom_url = 'https://public-inbox.org/NEWS.atom';
 my $addr = 'meta@public-inbox.org';
 
 my $latest = shift(@releases) or die 'no releases?';
-my $mime_latest = release2mime($latest);
-my $mtime = msg_datestamp($mime_latest->header_obj);
+my $mtime;
+my $mime_latest = release2mime($latest, \$mtime);
 my $tmp = "$dst+";
 my $out;
 if ($dst eq 'NEWS') {
@@ -73,9 +73,17 @@ rename($tmp, $dst) or die;
 exit 0;
 
 sub release2mime {
-	my $f = "$dir/$_[0].eml";
+	my ($release, $mtime_ref) = @_;
+	my $f = "$dir/$release.eml";
 	open(my $fh, '<', $f) or die "open($f): $!";
-	PublicInbox::MIME->new(do { local $/; <$fh> });
+	my $mime = PublicInbox::MIME->new(do { local $/; <$fh> });
+	# Documentation/include.mk relies on mtimes of each .eml file
+	# to trigger rebuild, so make sure we sync the mtime to the Date:
+	# header in the .eml
+	my $mtime = msg_datestamp($mime->header_obj);
+	utime($mtime, $mtime, $fh) or warn "futimes $f: $!";
+	$$mtime_ref = $mtime if $mtime_ref;
+	$mime;
 }
 
 sub mime2txt {
diff --git a/Makefile.PL b/Makefile.PL
index 94ec16c6..2b3c7fd0 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -8,6 +8,8 @@ chomp(my @manifest = (<$m>));
 my @EXE_FILES = grep(m!^script/!, @manifest);
 my $v = {};
 my $t = {};
+my @RELEASES = qw(v1.2.0 v1.1.0-pre1 v1.0.0); # do not sort
+$v->{news_deps} = [ map { "Documentation/RelNotes/$_.eml" } @RELEASES ];
 $v->{txt} = [ qw(INSTALL README COPYING TODO HACKING) ];
 my @dtxt = grep(m!\ADocumentation/.*\.txt\z!, @manifest);
 push @dtxt, 'Documentation/standards.txt';
@@ -91,6 +93,7 @@ my $VARS = join("\n", map {;
 	my $varname = $_;
 	join('', map { "$varname += $_\n" } sort @{$v->{$varname}});
 } grep(!/^-/, sort keys %$v));
+$VARS .= "\nRELEASES = ".join(' ', @RELEASES)."\n";
 
 # Don't waste user's disk space by installing some pods from
 # imported code or internal use only

  reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-24 22:09 [PATCH 0/5] build, website, and speling updates Eric Wong
2020-01-24 22:09 ` Eric Wong [this message]
2020-01-24 22:09 ` [PATCH 2/5] website: re-add top-level files Eric Wong
2020-01-24 22:09 ` [PATCH 3/5] doc: INSTALL describe required deps for released versions Eric Wong
2020-01-24 22:09 ` [PATCH 4/5] website: omit technical/ and other subdirs Eric Wong
2020-01-24 22:09 ` [PATCH 5/5] spelling: favor `publicly' over `publically' Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200124220933.11970-2-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git