* [PATCH 1/3] doc: extindex-format: make lexgrog happy
@ 2021-01-25 4:53 5% ` Eric Wong
2021-01-25 4:53 4% ` [PATCH 2/3] build: check with lexgrog(1) if available Eric Wong
1 sibling, 0 replies; 5+ results
From: Eric Wong @ 2021-01-25 4:53 UTC (permalink / raw)
To: meta
Based on commit 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55
("public-inbox-v[12]-format.pod: make lexgrog happy")
---
Documentation/public-inbox-extindex-format.pod | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/public-inbox-extindex-format.pod b/Documentation/public-inbox-extindex-format.pod
index 52eb8e85..d47e2102 100644
--- a/Documentation/public-inbox-extindex-format.pod
+++ b/Documentation/public-inbox-extindex-format.pod
@@ -2,7 +2,7 @@
=head1 NAME
-public-inbox extindex format description
+public-inbox-extindex-format - external index format description
=head1 DESCRIPTION
^ permalink raw reply related [relevance 5%]
* [PATCH 2/3] build: check with lexgrog(1) if available
2021-01-25 4:53 5% ` [PATCH 1/3] doc: extindex-format: make lexgrog happy Eric Wong
@ 2021-01-25 4:53 4% ` Eric Wong
1 sibling, 0 replies; 5+ results
From: Eric Wong @ 2021-01-25 4:53 UTC (permalink / raw)
To: meta
This will make life easier for Debian package maintainers
running lintian.
cf. commit 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55
("public-inbox-v[12]-format.pod: make lexgrog happy")
---
.gitignore | 1 +
Documentation/include.mk | 3 +++
Makefile.PL | 8 +++++++-
3 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 7f4142ba..f7e4c595 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,6 +16,7 @@
*.gz
.*.cols
.*.check
+.*.lexgrog
/NEWS.html
/NEWS.atom
/NEWS
diff --git a/Documentation/include.mk b/Documentation/include.mk
index df6c17e0..79bf460d 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -6,6 +6,7 @@ RSYNC = rsync
RSYNC_DEST = public-inbox.org:/srv/public-inbox/
AWK = awk
MAN = man
+LEXGROG = lexgrog
# this is "xml" on FreeBSD and maybe some other distros:
XMLSTARLET = xmlstarlet
@@ -56,6 +57,8 @@ check_man = $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}'\
check-man :: $(check_80)
+check-lexgrog :: $(check_lexgrog)
+
all :: $(docs)
txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@
diff --git a/Makefile.PL b/Makefile.PL
index 613a72ae..c57491eb 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -65,8 +65,12 @@ for my $i (@sections) {
$t->{".$m.cols : $m.$i"} = [
"\@echo CHECK80 $m.$i;".
"COLUMNS=80 \$(MAN) ./$m.$i | \$(check_man)" ];
+ $t->{".$m.lexgrog: $m.$i"} = [
+ "\@echo LEXGROG $m.$i;" .
+ "\$(LEXGROG) ./$m.$i >\$\@+ && mv \$\@+ \$@" ];
}
push @{$v->{check_80}}, map { ".$_.cols" } @$ary;
+ push @{$v->{check_lexgrog}}, map { ".$_.lexgrog" } @$ary;
my $manuals = $v->{"man$i"} = [ map { "$_.$i" } @$ary ];
push @{$v->{manuals}}, @$manuals;
push @{$v->{mantxt}}, map { "Documentation/$_.txt" } @$ary;
@@ -121,6 +125,8 @@ my %man3 = map {; # semi-colon tells Perl this is a BLOCK (and not EXPR)
"lib/PublicInbox/$_" => "blib/man3/PublicInbox::$mod.\$(MAN3EXT)"
} qw(Git.pm Import.pm WWW.pod SaPlugin/ListMirror.pod);
my $warn_no_pod = @no_pod ? "\n\t\@echo W: missing .pod: @no_pod\n" : '';
+chomp(my $lexgrog = `which lexgrog 2>/dev/null`);
+my $check_lexgrog = $lexgrog ? 'check-lexgrog' : '';
WriteMakefile(
NAME => 'PublicInbox', # n.b. camel-case is not our choice
@@ -184,7 +190,7 @@ $VARS
-include Documentation/include.mk
$TGTS
-check-man ::$warn_no_pod
+check-man :: $check_lexgrog$warn_no_pod
# syntax checks are currently GNU make only:
%.syntax :: %
^ permalink raw reply related [relevance 4%]
* stable 1.6.1 release? [was: [PATCH] eml: fix undefined vars on <Perl 5.28]
@ 2020-12-26 20:35 4% ` Eric Wong
0 siblings, 0 replies; 5+ results
From: Eric Wong @ 2020-12-26 20:35 UTC (permalink / raw)
To: Ali Alnubani, Konstantin Ryabitsev; +Cc: meta
Ali Alnubani <alialnu@nvidia.com> wrote:
> I no longer see the uninitialized value warnings or the test
> failure on Debian 9 with both patches applied on master. Do
> you plan on creating a new release tag soon with these fixes?
Thanks, pushed to master and I've started a stable-1.6 branch
to https://80x24.org/public-inbox.git with 29 commits
cherry-picked from master which I hope are suitable.
There's two more I'm tempted to cherry-pick, though they
introduce behavior changes:
fe01d7b117c8b1e1 import: drop X-Status in addition to Status
1bf653ad139bf7bb nntp+www: drop List-* and Archived-At headers
Konstantin: thoughts on 1bf653ad139bf7bb being suitable for 1.6.1?
Anyways, here's what I have so far:
fdbd73069af6eed9 eml: fix undefined vars on <Perl 5.28
e16e09b239b4d8bf t/config: test --get-urlmatch for git <2.26
933fce93167eba86 inboxidle: avoid needless syscalls on refresh
a0b470cbaf01c699 inboxidle: clue users into resolving ENOSPC from inotify
b782533a0413578d inbox: name variable for values loop iterator
4f1a683dc895a7bd public-inbox-v[12]-format.pod: make lexgrog happy
7a92c24157953dc6 manifest.js.gz: fix per-inbox /$INBOX/manifest.js.gz
78e81ae914ad24df Fix manpage section of perl module documentation
a4a1a74a2f60ec58 t/psgi_v2: ignore warnings on missing P::M::ReverseProxy
1cbb6243533fc2d4 daemon: support --daemonize without Net::Server::Daemonize
734daa9b165e248c doc: v2-format: drop repeated word
b63c27f36a44d8de over: ensure old, merged {tid} is really gone
c39ed01a3a4c6c46 wwwattach: prevent deep-linking via Referer match
0366c73f20b436d4 t/eml.t: workaround newer Email::MIME* behavior
bf14a3670da72358 nntp: attempt RFC 5536 3.1.5-conformant Path: headers
2fcf2b14a9ce3336 nntp: delimit Newsgroup: header with commas
31f9b61a318f4daf tls: epollbit: account for miscellaneous OpenSSL errors
5efbbd5e3e45ff3a scripts/dupe-finder: restore $dbh variable
59cc88bb5bc5ce3e searchidx: index lower-case List-Id value
4ccff6f9122da89c ds: add missing label for systems w/o EPOLLEXCLUSIVE
f9c3b3746445219b imap: avoid raising exception if client disconnects
e578a012532cd91f idxstack: fix comment about file_char
d94b6dd634381748 mda: match List-Id insensitively
c6ca576baf1700a8 mid: drop repeated ';' in mid_escape() regular expression
8e9d4f877730dbdf doc: post-1.6 updates, start 1.7
d6d442866106248e config: warn on multiple values for some fields
64f7ab3a571b9db0 doc: txt2pre: more manpage URLs
915e01b9cd771a84 doc: flow: include -imapd
dec02da946b6bb29 t/indexlevels-mirror: fix improperly skipped test
Thoughts?
Fwiw, I consider these two the most important and was
considering a 1.6.1 release even before the recent fixes:
7a92c24157953dc6 manifest.js.gz: fix per-inbox /$INBOX/manifest.js.gz
b63c27f36a44d8de over: ensure old, merged {tid} is really gone
^ permalink raw reply [relevance 4%]
* Re: [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy
2020-12-22 17:18 6% [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy Uwe Kleine-König
@ 2020-12-22 23:01 7% ` Eric Wong
0 siblings, 0 replies; 5+ results
From: Eric Wong @ 2020-12-22 23:01 UTC (permalink / raw)
To: Uwe Kleine-König; +Cc: meta
Applied and pushed as commit 1350f5ab09f72c75ac2cd6c88f6a2b9e198fef55
Thanks.
^ permalink raw reply [relevance 7%]
* [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy
@ 2020-12-22 17:18 6% Uwe Kleine-König
2020-12-22 23:01 7% ` Eric Wong
0 siblings, 1 reply; 5+ results
From: Uwe Kleine-König @ 2020-12-22 17:18 UTC (permalink / raw)
To: meta
The Debian package linter (lintian) emits the following warning:
W: bad-whatis-entry
N:
N: A manual page should start with a NAME section, which lists the
N: program name and a brief description. The NAME section is used to
N: generate a database that can be queried by commands like apropos and
N: whatis. You are seeing this tag because lexgrog was unable to parse
N: the NAME section.
N:
N: Manual pages for multiple programs, functions, or files should list
N: each separated by a comma and a space, followed by \- and a common
N: description.
N:
N: Listed items may not contain any spaces. A manual page for a two-level
N: command such as fs listacl must look like fs_listacl so the list is
N: read correctly.
N:
N: Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and
N: the groff_mdoc(7) manual page for details.
N:
N: Severity: warning
N:
N: Check: documentation/manual
N:
N: Renamed from: manpage-has-bad-whatis-entry
N:
for public-inbox-v1-format and public-inbox-v2-format.
Adapt the descriptions to make lexgrog and so lintian happy.
---
Documentation/public-inbox-v1-format.pod | 2 +-
Documentation/public-inbox-v2-format.pod | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/public-inbox-v1-format.pod b/Documentation/public-inbox-v1-format.pod
index e5b1dd06732e..da19d2c973b4 100644
--- a/Documentation/public-inbox-v1-format.pod
+++ b/Documentation/public-inbox-v1-format.pod
@@ -2,7 +2,7 @@
=head1 NAME
-public-inbox v1 git repository and tree description (aka "ssoma")
+public-inbox-v1-format - git repository and tree description (aka "ssoma")
=head1 DESCRIPTION
diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod
index d6282cb4b884..3c89f13e92ff 100644
--- a/Documentation/public-inbox-v2-format.pod
+++ b/Documentation/public-inbox-v2-format.pod
@@ -2,7 +2,7 @@
=head1 NAME
-public-inbox v2 format description
+public-inbox-v2-format - structure of public inbox v2 archives
=head1 DESCRIPTION
--
2.29.2
^ permalink raw reply related [relevance 6%]
Results 1-5 of 5 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2020-12-22 17:18 6% [PATCH] public-inbox-v[12]-format.pod: make lexgrog happy Uwe Kleine-König
2020-12-22 23:01 7% ` Eric Wong
2020-12-26 11:27 [Debian 9][Perl 5.24] uninitialized value errors in Encode/MIME/Header.pm Ali Alnubani
2020-12-26 12:25 ` [PATCH] eml: fix undefined vars on <Perl 5.28 Eric Wong
2020-12-26 14:10 ` Ali Alnubani
2020-12-26 20:35 4% ` stable 1.6.1 release? [was: [PATCH] eml: fix undefined vars on <Perl 5.28] Eric Wong
2021-01-25 4:53 [PATCH 0/3] doc: some extindex updates Eric Wong
2021-01-25 4:53 5% ` [PATCH 1/3] doc: extindex-format: make lexgrog happy Eric Wong
2021-01-25 4:53 4% ` [PATCH 2/3] build: check with lexgrog(1) if available Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.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).