summaryrefslogtreecommitdiffstats
path: root/tags/i/info-document-missing-image-file.tag
diff options
context:
space:
mode:
Diffstat (limited to 'tags/i/info-document-missing-image-file.tag')
-rw-r--r--tags/i/info-document-missing-image-file.tag19
1 files changed, 19 insertions, 0 deletions
diff --git a/tags/i/info-document-missing-image-file.tag b/tags/i/info-document-missing-image-file.tag
new file mode 100644
index 0000000..469a67a
--- /dev/null
+++ b/tags/i/info-document-missing-image-file.tag
@@ -0,0 +1,19 @@
+Tag: info-document-missing-image-file
+Severity: warning
+Check: documentation/texinfo
+Explanation: This info document contains an "[image]" but the image file it
+ specifies is missing. Texinfo <code>@image{}</code> becomes
+ .
+ [image src="filename.png"]
+ .
+ in the <code>.info</code>. Emacs 22 and up info
+ mode can display this in a GUI if filename.png is in
+ <code>/usr/share/info</code> or if the src gives a path to the file
+ elsewhere.
+ .
+ If you put an image file in <code>/usr/share/info</code> then please name
+ it like the document so as to avoid name clashes. Eg. foo.info might
+ call an image foo-example1.png. If upstream does not do this already
+ then it may be easier to <code>sed</code> the <code>src=""</code> to a path
+ elsewhere, perhaps to share with an HTML rendition under say
+ <code>/usr/share/doc/foo/html/</code>.