chiark / gitweb /
documentation style: "appropriate configuration" as a mass noun
[dgit.git] / NOTES.podchecker
1 todo: maybe we wanted to run podchecker but it complains about a lot
2 of things for which we don't have good alternatives.  Eg:
3
4
5 *** WARNING: (section) in 'dgit-maint-debrebase(7)' deprecated at line 17 in file ../git-debrebase.1.pod
6
7    But this is not actually described as deprecated and how else to
8    write a manpage cross-reference ?  Maybe this warning applies
9    only to perl's own manpages.
10
11 *** WARNING: 2 unescaped <> in paragraph at line 30 in file ../git-debrebase.1.pod
12
13    I have a habit of writing things like 
14    git-debrebase [-- <git-rebase options...>]
15    which is obviously unescaped < but the E<> syntax would be awful
16
17 *** WARNING: No items in =over (at line 31) / =back list at line 42 in file ../dgit-user.7.pod
18 *** WARNING: No argument for =item at line 553 in file ../git-debrebase.1.pod
19
20    pod doesn't offer a better answer, and these render well
21
22 *** ERROR: unresolved internal link 'dgit-maint-*(7)' at line 22 in file ../dgit-user.7.pod
23
24    This is obviously needed.
25
26 At the time of writing it does not seem to detect anything which
27 generates bad rendering.  So for now I will not run it.