From: schwarze Date: Fri, 19 Aug 2022 12:49:36 +0000 (+0000) Subject: Up to version 1.22.4, groff_mdoc(7) only considered the first word X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=a0c8730ce5aaf571286843147f141a527c1df74a;p=openbsd Up to version 1.22.4, groff_mdoc(7) only considered the first word when comparing section headers. For example, ".Sh SEE ELSEWHERE" and ".Sh SEE Em ALSO" were considered instances of a SEE ALSO section. In groff-current, exact matches with no sub-macros are required. Adjust mandoc behaviour. While here, also fix a very minor mandoc bug, even though no detrimental effect of the bug on formatting is known. While using sub-macros in the .Sh HEAD is bad style, the parsers accept it, so setting the section attribute on the HEAD needs to act recursively. --- diff --git a/regress/usr.bin/mandoc/mdoc/Rs/break.in b/regress/usr.bin/mandoc/mdoc/Rs/break.in index 63425a862ee..b2455f688e6 100644 --- a/regress/usr.bin/mandoc/mdoc/Rs/break.in +++ b/regress/usr.bin/mandoc/mdoc/Rs/break.in @@ -1,5 +1,5 @@ -.\" $OpenBSD: break.in,v 1.5 2017/07/04 14:53:26 schwarze Exp $ -.Dd $Mdocdate: July 4 2017 $ +.\" $OpenBSD: break.in,v 1.6 2022/08/19 12:49:36 schwarze Exp $ +.Dd $Mdocdate: August 19 2022 $ .Dt RS-BREAK 1 .Os .Sh NAME @@ -20,7 +20,7 @@ reference after a blank line: .%N 42 .Re .Sh SEE Em ALSO -reference after a blank line: +reference on the same line: .Rs .%A author .%J journal diff --git a/regress/usr.bin/mandoc/mdoc/Rs/break.out_ascii b/regress/usr.bin/mandoc/mdoc/Rs/break.out_ascii index 0c9625837e4..8426cef16af 100644 --- a/regress/usr.bin/mandoc/mdoc/Rs/break.out_ascii +++ b/regress/usr.bin/mandoc/mdoc/Rs/break.out_ascii @@ -12,8 +12,6 @@ SSEEEE AALLSSOO author, _j_o_u_r_n_a_l, 42. SSEEEE _A_L_S_O - reference after a blank line: - - author, _j_o_u_r_n_a_l, 42. + reference on the same line: author, _j_o_u_r_n_a_l, 42. -OpenBSD July 4, 2017 OpenBSD +OpenBSD August 19, 2022 OpenBSD diff --git a/regress/usr.bin/mandoc/mdoc/Rs/break.out_markdown b/regress/usr.bin/mandoc/mdoc/Rs/break.out_markdown index ad6adfb3c3c..00b7d01bc76 100644 --- a/regress/usr.bin/mandoc/mdoc/Rs/break.out_markdown +++ b/regress/usr.bin/mandoc/mdoc/Rs/break.out_markdown @@ -21,10 +21,9 @@ author, # SEE *ALSO* -reference after a blank line: - +reference on the same line: author, *journal*, 42\. -OpenBSD - July 4, 2017 +OpenBSD - August 19, 2022 diff --git a/regress/usr.bin/mandoc/mdoc/Rs/break.out_utf8 b/regress/usr.bin/mandoc/mdoc/Rs/break.out_utf8 index 9cd3bb59d1d..63400749fec 100644 --- a/regress/usr.bin/mandoc/mdoc/Rs/break.out_utf8 +++ b/regress/usr.bin/mandoc/mdoc/Rs/break.out_utf8 @@ -12,8 +12,6 @@ SSEEEE AALLSSOO author, _j_o_u_r_n_a_l, 42. SSEEEE _A_L_S_O - reference after a blank line: - - author, _j_o_u_r_n_a_l, 42. + reference on the same line: author, _j_o_u_r_n_a_l, 42. -OpenBSD July 4, 2017 OpenBSD +OpenBSD August 19, 2022 OpenBSD diff --git a/usr.bin/mandoc/mdoc_state.c b/usr.bin/mandoc/mdoc_state.c index 954f7099094..7ae3ca82e5b 100644 --- a/usr.bin/mandoc/mdoc_state.c +++ b/usr.bin/mandoc/mdoc_state.c @@ -1,6 +1,6 @@ -/* $OpenBSD: mdoc_state.c,v 1.16 2020/01/19 17:59:01 schwarze Exp $ */ +/* $OpenBSD: mdoc_state.c,v 1.17 2022/08/19 12:49:36 schwarze Exp $ */ /* - * Copyright (c) 2014, 2015, 2017, 2018 Ingo Schwarze + * Copyright (c) 2014,2015,2017,2018,2022 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -32,6 +32,7 @@ typedef void (*state_handler)(STATE_ARGS); +static void setsec(struct roff_node *, enum roff_sec); static void state_bl(STATE_ARGS); static void state_sh(STATE_ARGS); static void state_sm(STATE_ARGS); @@ -203,35 +204,36 @@ state_bl(STATE_ARGS) } static void -state_sh(STATE_ARGS) +setsec(struct roff_node *n, enum roff_sec sec) { struct roff_node *nch; - char *secname; + + n->sec = sec; + for (nch = n->child; nch != NULL; nch = nch->next) + setsec(nch, sec); +} + +/* + * Set the section attribute for the BLOCK, HEAD, and HEAD children. + * For other nodes, including the .Sh BODY, this is done when allocating + * the node data structures, but for .Sh BLOCK and HEAD, the section is + * still unknown at that time. + */ +static void +state_sh(STATE_ARGS) +{ + enum roff_sec sec; if (n->type != ROFFT_HEAD) return; - if ( ! (n->flags & NODE_VALID)) { - secname = NULL; - deroff(&secname, n); - - /* - * Set the section attribute for the BLOCK, HEAD, - * and HEAD children; the latter can only be TEXT - * nodes, so no recursion is needed. For other - * nodes, including the .Sh BODY, this is done - * when allocating the node data structures, but - * for .Sh BLOCK and HEAD, the section is still - * unknown at that time. - */ - - n->sec = n->parent->sec = secname == NULL ? - SEC_CUSTOM : mdoc_a2sec(secname); - for (nch = n->child; nch != NULL; nch = nch->next) - nch->sec = n->sec; - free(secname); + if ((n->flags & NODE_VALID) == 0) { + sec = n->child != NULL && n->child->type == ROFFT_TEXT && + n->child->next == NULL ? mdoc_a2sec(n->child->string) : + SEC_CUSTOM; + n->parent->sec = sec; + setsec(n, sec); } - if ((mdoc->lastsec = n->sec) == SEC_SYNOPSIS) { roff_setreg(mdoc->roff, "nS", 1, '='); mdoc->flags |= MDOC_SYNOPSIS;