Re: master ed2b0bd: New faces in xref (bug#23179)

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Robert Pluim
>>>>> On Sat, 13 Apr 2019 17:54:22 -0400 (EDT), [hidden email] (Juri Linkov) said:

    Juri> branch: master commit
    Juri> ed2b0bdfe24551d6a2f0497601f58faa17f24e3d Author: Juri Linkov
    Juri> <[hidden email]> Commit: Juri Linkov <[hidden email]>

    Juri>     New faces in xref (bug#23179)
   
I think these new faces warrant at least an entry in NEWS and a
mention in the manual.

Robert

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Juri Linkov-2
> I think these new faces warrant at least an entry in NEWS and a
> mention in the manual.

I see no other related faces (compilation/grep) mentioned
neither in NEWS nor in the manual.

But I could add new faces to NEWS if Eli decides to do so.

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Robert Pluim
>>>>> On Sun, 14 Apr 2019 23:05:38 +0300, Juri Linkov <[hidden email]> said:

    >> I think these new faces warrant at least an entry in NEWS and a
    >> mention in the manual.

    Juri> I see no other related faces (compilation/grep) mentioned
    Juri> neither in NEWS nor in the manual.

True. Thatʼs arguably a deficiency in the manual.

    Juri> But I could add new faces to NEWS if Eli decides to do so.

It would be a useful addition, I think.

Robert

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Eli Zaretskii
> From: Robert Pluim <[hidden email]>
> Date: Mon, 15 Apr 2019 10:27:45 +0200
> Cc: [hidden email]
>
>     Juri> I see no other related faces (compilation/grep) mentioned
>     Juri> neither in NEWS nor in the manual.
>
> True. Thatʼs arguably a deficiency in the manual.

I tend to agree.  Feel free to document at least the more important
ones ('error', 'warning').

>     Juri> But I could add new faces to NEWS if Eli decides to do so.
>
> It would be a useful addition, I think.

I think we do call out new faces in NEWS, so I think these new ones
should be mentioned.

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Robert Pluim
>>>>> On Mon, 15 Apr 2019 17:34:13 +0300, Eli Zaretskii <[hidden email]> said:

    >> From: Robert Pluim <[hidden email]> Date: Mon, 15 Apr 2019
    >> 10:27:45 +0200 Cc: [hidden email]
    >>
    Juri> I see no other related faces (compilation/grep) mentioned
    Juri> neither in NEWS nor in the manual.
    >>
    >> True. Thatʼs arguably a deficiency in the manual.

    Eli> I tend to agree.  Feel free to document at least the more
    Eli> important ones ('error', 'warning').

grep doesnʼt have any faces that can be customized (at least not for
the output of grep. How about the following for compilation-mode:

diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index 78d07b8d39..fa4c7f0e20 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -151,6 +151,23 @@ Compilation Mode
 the error message in a separate window.  The locus is the specific
 position in a file where that error occurred.
 
+@cindex compilation mode faces
+@cindex compilation mode appearance
+@vindex compilation-error-face
+@vindex compilation-error
+@vindex compilation-warning-face
+@vindex compilation-warning
+  The appearance of the @file{*compilation*} buffer can be controlled
+by customizing the faces which are used to highlight parts of the
+@file{*compilation*} buffer, e.g. @code{compilation-error} or
+@code{compilation-warning}, for error and warning messages
+respectively.  Note that since those faces inherit from the
+@code{error} and @code{warning} faces, it is also possible to
+customize the parent face directly instead.
+
+  Use @w{@kbd{M-x customize-group RET compilation}} to see the entire
+list of customization variables and faces.
+
 @findex compile-goto-error
 @vindex compilation-auto-jump-to-first-error
   If you change the variable

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Eli Zaretskii
> From: Robert Pluim <[hidden email]>
> Cc: [hidden email]
> Date: Tue, 16 Apr 2019 16:02:36 +0200
>
> +@cindex compilation mode faces
> +@cindex compilation mode appearance
> +@vindex compilation-error-face
> +@vindex compilation-error
> +@vindex compilation-warning-face
> +@vindex compilation-warning

It is generally not useful to have several index entries which start
with the same text and point to the same place.  So I would leave the
odd-numbered entries above and delete the even-numbered.

> +  The appearance of the @file{*compilation*} buffer can be controlled
> +by customizing the faces which are used to highlight parts of the
> +@file{*compilation*} buffer, e.g. @code{compilation-error} or

Either "e.g.,", or "e.g.@:", so that TeX doesn't by chance consider
this end of sentence.

Otherwise LGTM, thanks.

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Robert Pluim
>>>>> On Tue, 16 Apr 2019 18:07:40 +0300, Eli Zaretskii <[hidden email]> said:

    >> From: Robert Pluim <[hidden email]> Cc: [hidden email]
    >> Date: Tue, 16 Apr 2019 16:02:36 +0200
    >>
    >> +@cindex compilation mode faces +@cindex compilation mode
    >> appearance +@vindex compilation-error-face +@vindex
    >> compilation-error +@vindex compilation-warning-face +@vindex
    >> compilation-warning

    Eli> It is generally not useful to have several index entries
    Eli> which start with the same text and point to the same place.
    Eli> So I would leave the odd-numbered entries above and delete
    Eli> the even-numbered.

I did it slightly differently. The name of the face is
'compilation-error', and 'compilation-error-face' holds the name of
the face to use. customize-face uses the former, so I left that one.

    >> + The appearance of the @file{*compilation*} buffer can be
    >> controlled +by customizing the faces which are used to
    >> highlight parts of the +@file{*compilation*} buffer,
    >> e.g. @code{compilation-error} or

    Eli> Either "e.g.,", or "e.g.@:", so that TeX doesn't by chance
    Eli> consider this end of sentence.

The former seems vastly preferred, so I went with it.

    Eli> Otherwise LGTM, thanks.

emacs-26, I imagine.

diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index 78d07b8d39..518d157e4e 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -151,6 +151,20 @@ Compilation Mode
 the error message in a separate window.  The locus is the specific
 position in a file where that error occurred.
 
+@cindex compilation mode faces
+@vindex compilation-error
+@vindex compilation-warning
+  The appearance of the @file{*compilation*} buffer can be controlled
+by customizing the faces which are used to highlight parts of the
+@file{*compilation*} buffer, e.g., @code{compilation-error} or
+@code{compilation-warning}, for error and warning messages
+respectively.  Note that since those faces inherit from the
+@code{error} and @code{warning} faces, it is also possible to
+customize the parent face directly instead.
+
+  Use @w{@kbd{M-x customize-group RET compilation}} to see the entire
+list of customization variables and faces.
+
 @findex compile-goto-error
 @vindex compilation-auto-jump-to-first-error
   If you change the variable

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Eli Zaretskii
> From: Robert Pluim <[hidden email]>
> Cc: [hidden email]
> Date: Tue, 16 Apr 2019 17:20:02 +0200
>
>     Eli> Otherwise LGTM, thanks.
>
> emacs-26, I imagine.

Right.

Reply | Threaded
Open this post in threaded view
|

Re: master ed2b0bd: New faces in xref (bug#23179)

Robert Pluim
>>>>> On Tue, 16 Apr 2019 19:01:55 +0300, Eli Zaretskii <[hidden email]> said:

    >> From: Robert Pluim <[hidden email]> Cc: [hidden email]
    >>
    >> emacs-26, I imagine.

    Eli> Right.

Done as d0f745f67a