diff options
author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-11-07 23:07:30 +0000 |
---|---|---|
committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-11-08 00:21:02 +0000 |
commit | 0fc3359d6fa6d667e974955e2e93179831c87ade (patch) | |
tree | e849a33e59fc00f60b16b33b87bfef9a63db3860 /NOTES.podchecker | |
parent | 3bdf8f285a8c50a827a6c32e63f23043a69f2cbb (diff) |
NOTES.podchecker: Document why I'm not using podchecker
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
Diffstat (limited to 'NOTES.podchecker')
-rw-r--r-- | NOTES.podchecker | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/NOTES.podchecker b/NOTES.podchecker new file mode 100644 index 0000000..57fc320 --- /dev/null +++ b/NOTES.podchecker @@ -0,0 +1,27 @@ +todo: maybe we wanted to run podchecker but it complains about a lot +of things for which we don't have good alternatives. Eg: + + +*** WARNING: (section) in 'dgit-maint-debrebase(7)' deprecated at line 17 in file ../git-debrebase.1.pod + + But this is not actually described as deprecated and how else to + write a manpage cross-reference ? Maybe this warning applies + only to perl's own manpages. + +*** WARNING: 2 unescaped <> in paragraph at line 30 in file ../git-debrebase.1.pod + + I have a habit of writing things like + git-debrebase [-- <git-rebase options...>] + which is obviously unescaped < but the E<> syntax would be awful + +*** WARNING: No items in =over (at line 31) / =back list at line 42 in file ../dgit-user.7.pod +*** WARNING: No argument for =item at line 553 in file ../git-debrebase.1.pod + + pod doesn't offer a better answer, and these render well + +*** ERROR: unresolved internal link 'dgit-maint-*(7)' at line 22 in file ../dgit-user.7.pod + + This is obviously needed. + +At the time of writing it does not seem to detect anything which +generates bad rendering. So for now I will not run it. |