summaryrefslogtreecommitdiffstats
path: root/tags/i/info-document-missing-dir-entry.tag
diff options
context:
space:
mode:
Diffstat (limited to 'tags/i/info-document-missing-dir-entry.tag')
-rw-r--r--tags/i/info-document-missing-dir-entry.tag16
1 files changed, 16 insertions, 0 deletions
diff --git a/tags/i/info-document-missing-dir-entry.tag b/tags/i/info-document-missing-dir-entry.tag
new file mode 100644
index 0000000..62115e3
--- /dev/null
+++ b/tags/i/info-document-missing-dir-entry.tag
@@ -0,0 +1,16 @@
+Tag: info-document-missing-dir-entry
+Severity: error
+Check: documentation/texinfo
+Explanation: This info document has no directory entry. This is text between
+ START-INFO-DIR-ENTRY and END-INFO-DIR-ENTRY lines which is copied into
+ the <code>dir</code> file in <code>/usr/share/info</code> by
+ <code>install-info</code>. The best solution is to add lines like:
+ .
+ @dircategory Software development
+ @direntry
+ &ast; foo: (foo). Foo creator and editor
+ @end direntry
+ .
+ to the texinfo source so that the generated info file will contain an
+ appropriate entry. You will have to ensure that the build process builds
+ new info files rather than using ones built by upstream.