Re: [PATCH] maint.mk: catch "see @xref{}"

[Jim Meyering]

Akim Demaille wrote:
> FWIW, it does catch things in Bison's documentation:
>
> texinfo_see_xref
> 8008:@option{--verbose} are specified, see @xref{Invocation, , Invoking
> 10255:See @pxref{Java Action Features}.
> 10271:left-hand side of assignments. See @pxref{Java Semantic Values} and
> 10288:that implements the appropriate interface (see @pxref{Java Scanner
> maint.mk: found use of "See @xref{}"
> gmake: *** [sc_texinfo_see_xref] Error 1
...
> +# Avoid double "see" when contributed by @xref.
> +sc_texinfo_see_xref:
> +     @prohibit='[Ss]ee  address@hidden'                                      
> \
> +     in_vc_files='$(texinfo_suffix_re_)'                             \
> +     halt='found use of "See @xref{}"'                               \
> +       $(_sc_search_regexp)
> +

Good one.
I prefer to use " +" rather than "  *",
and suppose someone might say "See also ...", too,
so added the (also +)? term.

Do you think it's worth worrying about "Also see @xref...", too?


diff --git a/top/maint.mk b/top/maint.mk
index 2228a37..700dd1c 100644
--- a/top/maint.mk
+++ b/top/maint.mk
@@ -838,6 +838,13 @@ sc_texinfo_acronym:
        halt='found use of Texinfo @acronym{}'                          \
          $(_sc_search_regexp)

+# Avoid double "see" when contributed by @xref.
+sc_texinfo_see_xref:
+       @prohibit='[Ss]ee +(also +)address@hidden'                              
\
+       in_vc_files='$(texinfo_suffix_re_)'                             \
+       halt='found use of "See @xref{}"'                               \
+         $(_sc_search_regexp)
+
 cvs_keywords = \
   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State