[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xre
From: |
Eli Zaretskii |
Subject: |
Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref" |
Date: |
Thu, 23 Jan 2025 16:53:19 +0200 |
> Date: Thu, 23 Jan 2025 12:28:32 +0000
> From: Pip Cet <pipcet@protonmail.com>
> Cc: Stefan Kangas <stefankangas@gmail.com>, luangruo@yahoo.com,
> emacs-devel@gnu.org
>
> So we need to check that @xref and @ref, except in comment lines, are
> followed by optional whitespace, a balanced sexp, optional whitespace,
> and a punctuation character? If texinfo really cannot do this, can this?
Maybe it can, but why bother? I've seen many times that people don't
even run "make" after they install documentation changes, or don't
look at messages when they do (because when I run it, I see warning
and error messages), so why should we assume someone will run some
Lisp in addition to that?
> As a general remark, I'm (very slowly) thinking about how we might
> add pre-push checks that catch such things but don't slow down
> development too much. However, at least until then, we can also fix the
> two specific cases that have caused trouble: pdumper hashes and texinfo
> files.
Errors in making documentation are not fatal, they just leave the Info
manuals outdated. By contrast, Git commit hooks are a pest when they
fire due to false positives. So I wouldn't bother.
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Po Lu, 2025/01/18
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Stefan Kangas, 2025/01/18
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Eli Zaretskii, 2025/01/19
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Pip Cet, 2025/01/23
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref",
Eli Zaretskii <=
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Stefan Kangas, 2025/01/23
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Eli Zaretskii, 2025/01/23
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Robert Pluim, 2025/01/24
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Eli Zaretskii, 2025/01/24
- Re: master e54b94c28cd: Use @xref more consistently; "See @ref" -> "@xref", Robert Pluim, 2025/01/24
- Avoid double spaces around abbrevations in Texinfo, Stefan Kangas, 2025/01/24
- Re: Avoid double spaces around abbrevations in Texinfo, Robert Pluim, 2025/01/24
- Re: Avoid double spaces around abbrevations in Texinfo, Stefan Kangas, 2025/01/24
- Re: Avoid double spaces around abbrevations in Texinfo, Robert Pluim, 2025/01/24
- Re: Avoid double spaces around abbrevations in Texinfo, Stefan Kangas, 2025/01/24