]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_validate.c
When formatting man(7) documents that do not contain .SH macros
[mandoc.git] / man_validate.c
index 812e77435b49a2c155b1a47931a105a7441a5af9..d6c51af5255ce3370ac8f6514c3bfb8f75e5c8d7 100644 (file)
@@ -1,7 +1,7 @@
 /*     $OpenBSD$ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2012-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2018 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
@@ -47,11 +47,12 @@ static      void      check_text(CHKARGS);
 
 static void      post_AT(CHKARGS);
 static void      post_IP(CHKARGS);
-static void      post_vs(CHKARGS);
 static void      post_OP(CHKARGS);
 static void      post_TH(CHKARGS);
 static void      post_UC(CHKARGS);
 static void      post_UR(CHKARGS);
+static void      post_in(CHKARGS);
+static void      post_vs(CHKARGS);
 
 static const v_check __man_valids[MAN_MAX - MAN_TH] = {
        post_TH,    /* TH */
@@ -74,7 +75,6 @@ static        const v_check __man_valids[MAN_MAX - MAN_TH] = {
        NULL,       /* I */
        NULL,       /* IR */
        NULL,       /* RI */
-       post_vs,    /* sp */
        NULL,       /* nf */
        NULL,       /* fi */
        NULL,       /* RE */
@@ -83,13 +83,14 @@ static      const v_check __man_valids[MAN_MAX - MAN_TH] = {
        post_UC,    /* UC */
        NULL,       /* PD */
        post_AT,    /* AT */
-       NULL,       /* in */
+       post_in,    /* in */
        post_OP,    /* OP */
        NULL,       /* EX */
        NULL,       /* EE */
        post_UR,    /* UR */
        NULL,       /* UE */
-       NULL,       /* ll */
+       post_UR,    /* MT */
+       NULL,       /* ME */
 };
 static const v_check *man_valids = __man_valids - MAN_TH;
 
@@ -119,6 +120,7 @@ man_node_validate(struct roff_man *man)
        case ROFFT_ROOT:
                check_root(man, n);
                break;
+       case ROFFT_COMMENT:
        case ROFFT_EQN:
        case ROFFT_TBL:
                break;
@@ -126,6 +128,7 @@ man_node_validate(struct roff_man *man)
                if (n->tok < ROFF_MAX) {
                        switch (n->tok) {
                        case ROFF_br:
+                       case ROFF_sp:
                                post_vs(man, n);
                                break;
                        default:
@@ -147,10 +150,9 @@ man_node_validate(struct roff_man *man)
 static void
 check_root(CHKARGS)
 {
-
        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
 
-       if (NULL == man->first->child)
+       if (n->last == NULL || n->last->type == ROFFT_COMMENT)
                mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                    n->line, n->pos, NULL);
        else
@@ -168,8 +170,14 @@ check_root(CHKARGS)
                man->meta.title = mandoc_strdup("");
                man->meta.msec = mandoc_strdup("");
                man->meta.date = man->quick ? mandoc_strdup("") :
-                   mandoc_normdate(man->parse, NULL, n->line, n->pos);
+                   mandoc_normdate(man, NULL, n->line, n->pos);
        }
+
+       if (man->meta.os_e &&
+           (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
+               mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0,
+                   man->meta.os_e == MANDOC_OS_OPENBSD ?
+                   "(OpenBSD)" : "(NetBSD)");
 }
 
 static void
@@ -203,10 +211,9 @@ post_OP(CHKARGS)
 static void
 post_UR(CHKARGS)
 {
-
        if (n->type == ROFFT_HEAD && n->child == NULL)
-               mandoc_vmsg(MANDOCERR_UR_NOHEAD, man->parse,
-                   n->line, n->pos, "UR");
+               mandoc_msg(MANDOCERR_UR_NOHEAD, man->parse,
+                   n->line, n->pos, roff_name[n->tok]);
        check_part(man, n);
 }
 
@@ -324,8 +331,7 @@ post_TH(CHKARGS)
        if (n && n->string && '\0' != n->string[0]) {
                man->meta.date = man->quick ?
                    mandoc_strdup(n->string) :
-                   mandoc_normdate(man->parse, n->string,
-                       n->line, n->pos);
+                   mandoc_normdate(man, n->string, n->line, n->pos);
        } else {
                man->meta.date = mandoc_strdup("");
                mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
@@ -337,8 +343,14 @@ post_TH(CHKARGS)
 
        if (n && (n = n->next))
                man->meta.os = mandoc_strdup(n->string);
-       else if (man->defos != NULL)
-               man->meta.os = mandoc_strdup(man->defos);
+       else if (man->os_s != NULL)
+               man->meta.os = mandoc_strdup(man->os_s);
+       if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
+               if (strstr(man->meta.os, "OpenBSD") != NULL)
+                       man->meta.os_e = MANDOC_OS_OPENBSD;
+               else if (strstr(man->meta.os, "NetBSD") != NULL)
+                       man->meta.os_e = MANDOC_OS_NETBSD;
+       }
 
        /* TITLE MSEC DATE OS ->VOL<- */
        /* If missing, use the default VOL name for MSEC. */
@@ -436,6 +448,22 @@ post_AT(CHKARGS)
        man->meta.os = mandoc_strdup(p);
 }
 
+static void
+post_in(CHKARGS)
+{
+       char    *s;
+
+       if (n->parent->tok != MAN_TP ||
+           n->parent->type != ROFFT_HEAD ||
+           n->child == NULL ||
+           *n->child->string == '+' ||
+           *n->child->string == '-')
+               return;
+       mandoc_asprintf(&s, "+%s", n->child->string);
+       free(n->child->string);
+       n->child->string = s;
+}
+
 static void
 post_vs(CHKARGS)
 {
@@ -446,6 +474,9 @@ post_vs(CHKARGS)
        switch (n->parent->tok) {
        case MAN_SH:
        case MAN_SS:
+       case MAN_PP:
+       case MAN_LP:
+       case MAN_P:
                mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
                    "%s after %s", roff_name[n->tok],
                    roff_name[n->parent->tok]);