aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc_xr.h
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-07-01 09:47:30 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-07-01 09:47:30 +0000
commitc93f1e0f2d3891330860de19b5ec3e274971a300 (patch)
tree6aa6244559b5608dfb842dda23dbc7377e0ee1ba /mandoc_xr.h
parent3aad1243de81f4fa87d3d67a5c4c6f0385bd0ac7 (diff)
downloadmandoc-c93f1e0f2d3891330860de19b5ec3e274971a300.tar.gz
mandoc-c93f1e0f2d3891330860de19b5ec3e274971a300.tar.zst
mandoc-c93f1e0f2d3891330860de19b5ec3e274971a300.zip
Basic reporting of .Xrs to manual pages that don't exist
in the base system, inspired by mdoclint(1). We are able to do this because (1) the -mdoc parser, the -Tlint validator, and the man(1) manual page lookup code are all in the same program and (2) the mandoc.db(5) database format allows fast lookup. Feedback from, previous versions tested by, and OK jmc@. A few features will be added to this in the tree, step by step.
Diffstat (limited to 'mandoc_xr.h')
-rw-r--r--mandoc_xr.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/mandoc_xr.h b/mandoc_xr.h
new file mode 100644
index 00000000..3fe2f56d
--- /dev/null
+++ b/mandoc_xr.h
@@ -0,0 +1,30 @@
+/* $Id: mandoc_xr.h,v 1.1 2017/07/01 09:47:30 schwarze Exp $ */
+/*
+ * Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+struct mandoc_xr {
+ struct mandoc_xr *next;
+ char *sec;
+ char *name;
+ int line;
+ int pos;
+ char hashkey[];
+};
+
+void mandoc_xr_reset(void);
+void mandoc_xr_add(const char *, const char *, int, int);
+struct mandoc_xr *mandoc_xr_get(void);
+void mandoc_xr_free(void);