diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2017-05-31 15:31:00 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-05-31 15:31:00 +0000 |
commit | ad7197291eca5fd8e810a5cebb0f9c81a323c637 (patch) | |
tree | 34c889a1b211fb96d7bd09378c4133e42210cb2f | |
parent | 063eee07257a67309a02f330e406d49c412e95d7 (diff) | |
download | mandoc-ad7197291eca5fd8e810a5cebb0f9c81a323c637.tar.gz mandoc-ad7197291eca5fd8e810a5cebb0f9c81a323c637.tar.zst mandoc-ad7197291eca5fd8e810a5cebb0f9c81a323c637.zip |
STYLE message about missing use of Ox/Nx/Fx/Dx; OK jmc@ wiz@
-rw-r--r-- | mandoc.1 | 14 | ||||
-rw-r--r-- | mandoc.h | 3 | ||||
-rw-r--r-- | mdoc_validate.c | 34 | ||||
-rw-r--r-- | read.c | 3 |
4 files changed, 49 insertions, 5 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.190 2017/05/30 20:25:32 schwarze Exp $ +.\" $Id: mandoc.1,v 1.191 2017/05/31 15:31:00 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: May 30 2017 $ +.Dd $Mdocdate: May 31 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -753,6 +753,16 @@ or .Ic \&Ud macro was found. Simply delete it: it serves no useful purpose. +.It Sy "consider using OS macro" +.Pq mdoc +A string was found in plain text or in a +.Ic \&Bx +macro that could be represented using +.Ic \&Ox , +.Ic \&Nx , +.Ic \&Fx , +or +.Ic \&Dx . .El .Ss Warnings related to the document prologue .Bl -ohang @@ -1,4 +1,4 @@ -/* $Id: mandoc.h,v 1.217 2017/05/30 19:30:38 schwarze Exp $ */ +/* $Id: mandoc.h,v 1.218 2017/05/31 15:31:00 schwarze Exp $ */ /* * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -47,6 +47,7 @@ enum mandocerr { MANDOCERR_STYLE, /* ===== start of style suggestions ===== */ MANDOCERR_MACRO_USELESS, /* useless macro: macro */ + MANDOCERR_BX, /* consider using OS macro: macro */ MANDOCERR_WARNING, /* ===== start of warnings ===== */ diff --git a/mdoc_validate.c b/mdoc_validate.c index 6879f08f..d50e95e2 100644 --- a/mdoc_validate.c +++ b/mdoc_validate.c @@ -1,4 +1,4 @@ -/* $Id: mdoc_validate.c,v 1.328 2017/05/30 19:30:38 schwarze Exp $ */ +/* $Id: mdoc_validate.c,v 1.329 2017/05/31 15:31:00 schwarze Exp $ */ /* * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv> * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -53,6 +53,7 @@ typedef void (*v_post)(POST_ARGS); static int build_list(struct roff_man *, int); static void check_text(struct roff_man *, int, int, char *); +static void check_bsd(struct roff_man *, int, int, char *); static void check_argv(struct roff_man *, struct roff_node *, struct mdoc_argv *); static void check_args(struct roff_man *, struct roff_node *); @@ -302,6 +303,10 @@ mdoc_node_validate(struct roff_man *mdoc) if (n->sec != SEC_SYNOPSIS || (n->parent->tok != MDOC_Cd && n->parent->tok != MDOC_Fd)) check_text(mdoc, n->line, n->pos, n->string); + if (n->parent->tok == MDOC_Sh || + n->parent->tok == MDOC_Ss || + n->parent->tok == MDOC_It) + check_bsd(mdoc, n->line, n->pos, n->string); break; case ROFFT_EQN: case ROFFT_TBL: @@ -384,6 +389,25 @@ check_text(struct roff_man *mdoc, int ln, int pos, char *p) } static void +check_bsd(struct roff_man *mdoc, int ln, int pos, char *p) +{ + const char *cp; + + if ((cp = strstr(p, "OpenBSD")) != NULL) + mandoc_msg(MANDOCERR_BX, mdoc->parse, + ln, pos + (cp - p), "Ox"); + if ((cp = strstr(p, "NetBSD")) != NULL) + mandoc_msg(MANDOCERR_BX, mdoc->parse, + ln, pos + (cp - p), "Nx"); + if ((cp = strstr(p, "FreeBSD")) != NULL) + mandoc_msg(MANDOCERR_BX, mdoc->parse, + ln, pos + (cp - p), "Fx"); + if ((cp = strstr(p, "DragonFly")) != NULL) + mandoc_msg(MANDOCERR_BX, mdoc->parse, + ln, pos + (cp - p), "Dx"); +} + +static void post_bl_norm(POST_ARGS) { struct roff_node *n; @@ -2276,11 +2300,19 @@ static void post_bx(POST_ARGS) { struct roff_node *n, *nch; + const char *macro; n = mdoc->last; nch = n->child; if (nch != NULL) { + macro = !strcmp(nch->string, "Open") ? "Ox" : + !strcmp(nch->string, "Net") ? "Nx" : + !strcmp(nch->string, "Free") ? "Fx" : + !strcmp(nch->string, "DragonFly") ? "Dx" : NULL; + if (macro != NULL) + mandoc_msg(MANDOCERR_BX, mdoc->parse, + n->line, n->pos, macro); mdoc->last = nch; nch = nch->next; mdoc->next = ROFF_NEXT_SIBLING; @@ -1,4 +1,4 @@ -/* $Id: read.c,v 1.166 2017/05/30 19:30:39 schwarze Exp $ */ +/* $Id: read.c,v 1.167 2017/05/31 15:31:00 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -89,6 +89,7 @@ static const char * const mandocerrs[MANDOCERR_MAX] = { "generic style suggestion", "useless macro", + "consider using OS macro", "generic warning", |