diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-15 16:24:37 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-15 16:24:37 +0000 |
commit | 2f01ab1363bf6ab718b3fb6370fc6735e3e8bc02 (patch) | |
tree | c8023c62b35846d97b0c170d0fc13e02159140a7 | |
parent | 6e9d908aceac4cb4aaf9a8d2bdeab9efea064b7b (diff) | |
download | mandoc-2f01ab1363bf6ab718b3fb6370fc6735e3e8bc02.tar.gz |
LIBRARY can also occur in section 9.
All manual sections (unknown, 3p, 3f, etc.) correctly handled by -mdoc.
Useful warning printed if unknown manual section.
Checking for manual sections (e.g., LIBRARY) checks only first character, so 3p, 3f, etc. are free.
-rw-r--r-- | libmdoc.h | 2 | ||||
-rw-r--r-- | mdoc.7 | 4 | ||||
-rw-r--r-- | mdoc.c | 4 | ||||
-rw-r--r-- | mdoc.h | 2 | ||||
-rw-r--r-- | mdoc.template | 2 | ||||
-rw-r--r-- | mdoc_action.c | 36 | ||||
-rw-r--r-- | mdoc_html.c | 4 | ||||
-rw-r--r-- | mdoc_term.c | 2 | ||||
-rw-r--r-- | mdoc_validate.c | 17 |
9 files changed, 36 insertions, 37 deletions
@@ -80,7 +80,7 @@ enum merr { ENOLINE, EPROLOOO, EPROLREP, - EBADSEC, + EBADMSEC, EFONT, EBADDATE, ENUMFMT, @@ -347,7 +347,7 @@ file: \&.Sh NAME \&.Nm foo \&.Nd a description goes here -\&.\e\*q The next is for sections 2 & 3 only. +\&.\e\*q The next is for sections 2, 3, & 9 only. \&.\e\*q .Sh LIBRARY \&. \&.Sh SYNOPSIS @@ -409,7 +409,7 @@ and .Sx \&Nd . .It Em LIBRARY The name of the library containing the documented material, which is -assumed to be a function in a section 2 or 3 manual. +assumed to be a function in a section 2, 3, or 9 manual. The syntax for this is as follows: .Bd -literal -offset indent \&.Lb libarm @@ -68,7 +68,7 @@ const char *const __mdoc_merrnames[MERRMAX] = { "line arguments discouraged", /* ENOLINE */ "prologue macro out of conventional order", /* EPROLOOO */ "prologue macro repeated", /* EPROLREP */ - "invalid section", /* EBADSEC */ + "invalid manual section", /* EBADMSEC */ "invalid font mode", /* EFONT */ "invalid date syntax", /* EBADDATE */ "invalid number format", /* ENUMFMT */ @@ -190,6 +190,8 @@ mdoc_free1(struct mdoc *mdoc) free(mdoc->meta.arch); if (mdoc->meta.vol) free(mdoc->meta.vol); + if (mdoc->meta.msec) + free(mdoc->meta.msec); } @@ -223,7 +223,7 @@ enum mdoc_sec { /* Information from prologue. */ struct mdoc_meta { - int msec; + char *msec; char *vol; char *arch; time_t date; diff --git a/mdoc.template b/mdoc.template index f26a83e6..1edac2ec 100644 --- a/mdoc.template +++ b/mdoc.template @@ -14,7 +14,7 @@ .Sh NAME .Nm name .Nd short description -.\" The next is for sections 2 & 3 only. +.\" The next is for sections 2, 3, & 9 only. .\" .Sh LIBRARY .Sh SYNOPSIS .Sh DESCRIPTION diff --git a/mdoc_action.c b/mdoc_action.c index 9d2a3420..cb949df6 100644 --- a/mdoc_action.c +++ b/mdoc_action.c @@ -446,17 +446,14 @@ post_sh(POST_ARGS) case (SEC_RETURN_VALUES): /* FALLTHROUGH */ case (SEC_ERRORS): - switch (m->meta.msec) { - case (2): - /* FALLTHROUGH */ - case (3): - /* FALLTHROUGH */ - case (9): + assert(m->meta.msec); + if (*m->meta.msec == '2') break; - default: - return(mdoc_nwarn(m, n, EBADSEC)); - } - break; + if (*m->meta.msec == '3') + break; + if (*m->meta.msec == '9') + break; + return(mdoc_nwarn(m, n, EWRONGMSEC)); default: break; } @@ -473,8 +470,6 @@ post_dt(POST_ARGS) { struct mdoc_node *nn; const char *cp; - char *ep; - long lval; if (m->meta.title) free(m->meta.title); @@ -484,16 +479,16 @@ post_dt(POST_ARGS) free(m->meta.arch); m->meta.title = m->meta.vol = m->meta.arch = NULL; - m->meta.msec = 0; - /* Handles: `.Dt' * --> title = unknown, volume = local, msec = 0, arch = NULL */ if (NULL == (nn = n->child)) { /* XXX: make these macro values. */ + /* FIXME: warn about missing values. */ m->meta.title = mandoc_strdup("unknown"); m->meta.vol = mandoc_strdup("local"); + m->meta.msec = mandoc_strdup("1"); return(post_prol(m, n)); } @@ -504,8 +499,10 @@ post_dt(POST_ARGS) m->meta.title = mandoc_strdup(nn->string); if (NULL == (nn = nn->next)) { + /* FIXME: warn about missing msec. */ /* XXX: make this a macro value. */ m->meta.vol = mandoc_strdup("local"); + m->meta.msec = mandoc_strdup("1"); return(post_prol(m, n)); } @@ -518,13 +515,13 @@ post_dt(POST_ARGS) cp = mdoc_a2msec(nn->string); if (cp) { - /* FIXME: where is strtonum!? */ m->meta.vol = mandoc_strdup(cp); - lval = strtol(nn->string, &ep, 10); - if (nn->string[0] != '\0' && *ep == '\0') - m->meta.msec = (int)lval; - } else + m->meta.msec = mandoc_strdup(nn->string); + } else if (mdoc_nwarn(m, n, EBADMSEC)) { m->meta.vol = mandoc_strdup(nn->string); + m->meta.msec = mandoc_strdup(nn->string); + } else + return(0); if (NULL == (nn = nn->next)) return(post_prol(m, n)); @@ -541,6 +538,7 @@ post_dt(POST_ARGS) free(m->meta.vol); m->meta.vol = mandoc_strdup(cp); } else { + /* FIXME: warn about bad arch. */ cp = mdoc_a2arch(nn->string); if (NULL == cp) { free(m->meta.vol); diff --git a/mdoc_html.c b/mdoc_html.c index bb109efa..f1eb6ce5 100644 --- a/mdoc_html.c +++ b/mdoc_html.c @@ -387,7 +387,7 @@ print_mdoc_head(MDOC_ARGS) print_gen_head(h); bufinit(h); - buffmt(h, "%s(%d)", m->title, m->msec); + buffmt(h, "%s(%s)", m->title, m->msec); if (m->arch) { bufcat(h, " ("); @@ -509,7 +509,7 @@ mdoc_root_pre(MDOC_ARGS) } (void)snprintf(title, BUFSIZ - 1, - "%s(%d)", m->title, m->msec); + "%s(%s)", m->title, m->msec); /* XXX: see note in mdoc_root_post() about divs. */ diff --git a/mdoc_term.c b/mdoc_term.c index 5cbcef77..fe43bd58 100644 --- a/mdoc_term.c +++ b/mdoc_term.c @@ -425,7 +425,7 @@ print_mdoc_head(DECL_ARGS) strlcat(buf, ")", BUFSIZ); } - snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec); + snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec); p->offset = 0; p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; diff --git a/mdoc_validate.c b/mdoc_validate.c index e79796e9..0b3bf0f4 100644 --- a/mdoc_validate.c +++ b/mdoc_validate.c @@ -1240,20 +1240,19 @@ post_sh_head(POST_ARGS) /* * Check particular section/manual conventions. LIBRARY can - * only occur in msec 2, 3 (TODO: are there more of these?). + * only occur in manual section 2, 3, and 9. */ switch (sec) { case (SEC_LIBRARY): - switch (mdoc->meta.msec) { - case (2): - /* FALLTHROUGH */ - case (3): + assert(mdoc->meta.msec); + if (*mdoc->meta.msec == '2') break; - default: - return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC)); - } - break; + if (*mdoc->meta.msec == '3') + break; + if (*mdoc->meta.msec == '9') + break; + return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC)); default: break; } |