emacs-devel
[Top][All Lists]
Advanced

[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: Sun, 19 Jan 2025 08:44:46 +0200

> From: Stefan Kangas <stefankangas@gmail.com>
> Date: Sat, 18 Jan 2025 21:08:41 -0600
> 
> Po Lu <luangruo@yahoo.com> writes:
> 
> > Stefan Kangas <stefankangas@gmail.com> writes:
> >
> >> branch: master
> >> commit e54b94c28cdf9699009e7691f7c8ffa5b2c7b741
> >> Author: Stefan Kangas <stefankangas@gmail.com>
> >> Commit: Stefan Kangas <stefankangas@gmail.com>
> >>
> >>     Use @xref more consistently; "See @ref" -> "@xref"
> >>
> > This is not appropriate, as "@xref" is supposed only to be used before a
> > punctuation character, either a period or a comma.  I will revert this
> > build-breaking change.
> >
> >        Caution: A period or comma must follow the closing brace of an
> >        @xref.  It is required to terminate the cross reference.  This
> >        period or comma will appear in the output, both in the Info file
> >        and in the printed manual.
> 
> If a revert is appropriate, the polite thing to do is to ask the person
> who made the change to revert it.  Please do that in the future.
> 
> My Texinfo documentation doesn't have the above warning, and the build
> didn't break here.  Please tell which version of makeinfo you are using,
> and what are the errors you see.  Thanks.

This requirement was removed in recent versions of makeinfo, but we
need to have punctuation after each cross-reference command (with the
sole exception of @pxref, which does this automatically) to support
such old versions.

I've added the missing punctuation after reverting the revert.

In a nutshell, the change you made to use @xref revealed bugs we had
before, whereby @ref didn't have punctuation after it.  So this is a
good change for more than one reason.  Thanks.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]