summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2014-09-07 23:25:01 +0000
committerIngo Schwarze <schwarze@openbsd.org>2014-09-07 23:25:01 +0000
commite7f17cff677b94787cb26fd21afbbc4ecc6a91f0 (patch)
tree37015ae9e64abd25db44772cfc5c0a67fd42de2a
parent6a8ae4913857a065ca7564e19473146c144d3c29 (diff)
downloadmandoc-e7f17cff677b94787cb26fd21afbbc4ecc6a91f0.tar.gz
warn about AUTHORS sections without .An macros, inspired by mdoclint(1)
-rw-r--r--mandoc.16
-rw-r--r--mandoc.h1
-rw-r--r--mdoc_validate.c47
-rw-r--r--read.c1
4 files changed, 47 insertions, 8 deletions
diff --git a/mandoc.1 b/mandoc.1
index 063ea13f..d8a936f8 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -766,6 +766,12 @@ The same standard section title occurs more than once.
.Pq mdoc
A standard section header occurs in a section of the manual
where it normally isn't useful.
+.It Sy "AUTHORS section without An macro"
+.Pq mdoc
+An AUTHORS sections contains no
+.Ic \&An
+macros, or only empty ones.
+Probably, there are author names lacking markup.
.El
.Ss "Warnings related to macros and nesting"
.Bl -ohang
diff --git a/mandoc.h b/mandoc.h
index 0be1feec..cc500a94 100644
--- a/mandoc.h
+++ b/mandoc.h
@@ -72,6 +72,7 @@ enum mandocerr {
MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
+ MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
/* related to macros and nesting */
MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
diff --git a/mdoc_validate.c b/mdoc_validate.c
index 943b466f..68d469b2 100644
--- a/mdoc_validate.c
+++ b/mdoc_validate.c
@@ -67,6 +67,7 @@ static void check_text(struct mdoc *, int, int, char *);
static void check_argv(struct mdoc *,
struct mdoc_node *, struct mdoc_argv *);
static void check_args(struct mdoc *, struct mdoc_node *);
+static int child_an(const struct mdoc_node *);
static enum mdoc_sec a2sec(const char *);
static size_t macro2len(enum mdoct);
@@ -114,8 +115,9 @@ static int post_par(POST_ARGS);
static int post_root(POST_ARGS);
static int post_rs(POST_ARGS);
static int post_sh(POST_ARGS);
-static int post_sh_body(POST_ARGS);
static int post_sh_head(POST_ARGS);
+static int post_sh_name(POST_ARGS);
+static int post_sh_authors(POST_ARGS);
static int post_st(POST_ARGS);
static int post_vt(POST_ARGS);
static int pre_an(PRE_ARGS);
@@ -1847,22 +1849,31 @@ post_sh(POST_ARGS)
post_ignpar(mdoc);
- if (MDOC_HEAD == mdoc->last->type)
+ switch (mdoc->last->type) {
+ case MDOC_HEAD:
return(post_sh_head(mdoc));
- if (MDOC_BODY == mdoc->last->type)
- return(post_sh_body(mdoc));
+ case MDOC_BODY:
+ switch (mdoc->lastsec) {
+ case SEC_NAME:
+ return(post_sh_name(mdoc));
+ case SEC_AUTHORS:
+ return(post_sh_authors(mdoc));
+ default:
+ break;
+ }
+ break;
+ default:
+ break;
+ }
return(1);
}
static int
-post_sh_body(POST_ARGS)
+post_sh_name(POST_ARGS)
{
struct mdoc_node *n;
- if (SEC_NAME != mdoc->lastsec)
- return(1);
-
/*
* Warn if the NAME section doesn't contain the `Nm' and `Nd'
* macros (can have multiple `Nm' and one `Nd'). Note that the
@@ -1894,6 +1905,26 @@ post_sh_body(POST_ARGS)
}
static int
+child_an(const struct mdoc_node *n)
+{
+
+ for (n = n->child; n != NULL; n = n->next)
+ if ((n->tok == MDOC_An && n->nchild) || child_an(n))
+ return(1);
+ return(0);
+}
+
+static int
+post_sh_authors(POST_ARGS)
+{
+
+ if ( ! child_an(mdoc->last))
+ mandoc_msg(MANDOCERR_AN_MISSING, mdoc->parse,
+ mdoc->last->line, mdoc->last->pos, NULL);
+ return(1);
+}
+
+static int
post_sh_head(POST_ARGS)
{
struct mdoc_node *n;
diff --git a/read.c b/read.c
index bcb2e0b3..2b39d57b 100644
--- a/read.c
+++ b/read.c
@@ -117,6 +117,7 @@ static const char * const mandocerrs[MANDOCERR_MAX] = {
"sections out of conventional order",
"duplicate section title",
"unexpected section",
+ "AUTHORS section without An macro",
/* related to macros and nesting */
"obsolete macro",