GNU bug report logs - #27764
26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 27764 in the body.
You can then email your comments to 27764 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Wed, 19 Jul 2017 11:20:11 +0200

The docstring of `ediff-files' doesn't document the STARTUP-HOOKS
argument.  Please amend the docstring.


In GNU Emacs 26.0.50 (build 9, x86_64-pc-linux-gnu, GTK+ Version 3.10.8)
 of 2017-07-19 built on localhost
Repository revision: 47429dcb4afd502e5bff9d37a09b030c0b7e0eb0
Windowing system distributor 'The X.Org Foundation', version 11.0.11803000
System Description:	'Ubuntu 14.04 LTS'

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.

Configured using:
 'configure --enable-gcc-warnings --without-pop --with-mailutils
 --enable-checking --enable-check-lisp-object-type --with-modules
 'CFLAGS=-O0 -ggdb3''

Configured features:
XPM JPEG TIFF GIF PNG SOUND GSETTINGS NOTIFY GNUTLS FREETYPE XFT ZLIB
TOOLKIT_SCROLL_BARS GTK3 X11 MODULES

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message subr-x puny seq byte-opt gv
bytecomp byte-compile cconv cl-loaddefs cl-lib dired dired-loaddefs
format-spec rfc822 mml easymenu mml-sec password-cache epa derived epg
epg-config gnus-util rmail rmail-loaddefs mm-decode mm-bodies mm-encode
mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047
rfc2045 ietf-drums mm-util mail-prsvr mail-utils time-date mule-util
tooltip eldoc electric uniquify ediff-hook vc-hooks lisp-float-type
mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image
regexp-opt fringe tabulated-list replace newcomment text-mode elisp-mode
lisp-mode prog-mode register page menu-bar rfn-eshadow isearch timer
select scroll-bar mouse jit-lock font-lock syntax facemenu font-core
term/tty-colors frame cl-generic cham georgian utf-8-lang misc-lang
vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932
hebrew greek romanian slovak czech european ethiopic indian cyrillic
chinese composite charscript charprop case-table epa-hook jka-cmpr-hook
help simple abbrev obarray minibuffer cl-preloaded nadvice loaddefs
button faces cus-face macroexp files text-properties overlay sha1 md5
base64 format env code-pages mule custom widget hashtable-print-readable
backquote inotify dynamic-setting system-font-setting
font-render-setting move-toolbar gtk x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 94899 7621)
 (symbols 48 20234 1)
 (miscs 40 39 120)
 (strings 32 28620 1543)
 (string-bytes 1 766344)
 (vectors 16 13972)
 (vector-slots 8 492162 8202)
 (floats 8 48 68)
 (intervals 56 222 0)
 (buffers 992 12)
 (heap 1024 28062 1067))

-- 
Google Germany GmbH
Erika-Mann-Straße 33
80636 München

Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg
Geschäftsführer: Matthew Scott Sucherman, Paul Terence Manicle

Diese E-Mail ist vertraulich.  Wenn Sie nicht der richtige Adressat sind,
leiten Sie diese bitte nicht weiter, informieren Sie den Absender und löschen
Sie die E-Mail und alle Anhänge.  Vielen Dank.

This e-mail is confidential.  If you are not the right addressee please do not
forward it, please inform the sender, and please erase this e-mail including
any attachments.  Thanks.

Message #8 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: 27764 <at> debbugs.gnu.org
Subject: Re: 26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sat, 23 Sep 2017 18:46:57 +0000

[Message part 1 (text/plain, inline)]

Philipp Stephani <p.stephani2 <at> gmail.com> schrieb am Mi., 19. Juli 2017 um
11:20 Uhr:

>
> The docstring of `ediff-files' doesn't document the STARTUP-HOOKS
> argument.  Please amend the docstring.
>
>
>
Here's a patch that adds some missing documentation to ediff.el.

[Message part 2 (text/html, inline)]

[0001-Ediff-add-some-missing-documentation.txt (text/plain, attachment)]

Message #11 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sat, 23 Sep 2017 21:59:48 +0300

> From: Philipp Stephani <p.stephani2 <at> gmail.com>
> Date: Sat, 23 Sep 2017 18:46:57 +0000
> 
> Here's a patch that adds some missing documentation to ediff.el. 

Thanks.

>  ;;;###autoload
>  (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
> -  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
> +  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B.
> +STARTUP-HOOKS is a list of functions that Emacs calls without
> +arguments after setting up the Ediff buffers.  JOB-NAME is a
> +symbol describing the Ediff job type; it defaults to
> +`ediff-buffers'."

Here and elsewhere where JOB-NAME is mentioned, it would be good to
have a full list of supported symbols, not just the default one.

Otherwise, the patch looks good to me.  Thanks for taking good care of
this.

Message #14 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sun, 24 Sep 2017 08:00:53 +0000

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> schrieb am Sa., 23. Sep. 2017 um 21:00 Uhr:

> > From: Philipp Stephani <p.stephani2 <at> gmail.com>
> > Date: Sat, 23 Sep 2017 18:46:57 +0000
> >
> > Here's a patch that adds some missing documentation to ediff.el.
>
> Thanks.
>
> >  ;;;###autoload
> >  (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks
> job-name)
> > -  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
> > +  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B.
> > +STARTUP-HOOKS is a list of functions that Emacs calls without
> > +arguments after setting up the Ediff buffers.  JOB-NAME is a
> > +symbol describing the Ediff job type; it defaults to
> > +`ediff-buffers'."
>
> Here and elsewhere where JOB-NAME is mentioned, it would be good to
> have a full list of supported symbols, not just the default one.
>
>
I've added some generic text to the docstrings. I have no idea what the
full list of supported symbols are and what the point of this argument is
in the first place.

[Message part 2 (text/html, inline)]

[0001-Ediff-add-some-missing-documentation.txt (text/plain, attachment)]

Message #17 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Fri, 29 Sep 2017 10:17:49 +0300

> From: Philipp Stephani <p.stephani2 <at> gmail.com>
> Date: Sun, 24 Sep 2017 08:00:53 +0000
> Cc: 27764 <at> debbugs.gnu.org
> 
>  > (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
>  > - "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
>  > + "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B.
>  > +STARTUP-HOOKS is a list of functions that Emacs calls without
>  > +arguments after setting up the Ediff buffers. JOB-NAME is a
>  > +symbol describing the Ediff job type; it defaults to
>  > +`ediff-buffers'."
> 
>  Here and elsewhere where JOB-NAME is mentioned, it would be good to
>  have a full list of supported symbols, not just the default one.
> 
> I've added some generic text to the docstrings. I have no idea what the full list of supported symbols are and
> what the point of this argument is in the first place. 

Can we have there at least the list of the symbols that are seen in
the sources:  I see these:

 ediff-merge-files-with-ancestor, ediff-last-dir-ancestor,
 ediff-last-dir-C, ediff-buffers, ediff-buffers3, ediff-merge-buffers,
 ediff-merge-buffers-with-ancestor

If this list is too long to be repeated in each doc string, we could
have it once, and reference that place from the other do strings.  I
think either way would be much better than using some generic text.

OK?

Thanks.

Message #20 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sun, 05 Nov 2017 16:29:35 +0000

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> schrieb am Fr., 29. Sep. 2017 um 09:18 Uhr:

> > From: Philipp Stephani <p.stephani2 <at> gmail.com>
> > Date: Sun, 24 Sep 2017 08:00:53 +0000
> > Cc: 27764 <at> debbugs.gnu.org
> >
> >  > (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks
> job-name)
> >  > - "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
> >  > + "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B.
> >  > +STARTUP-HOOKS is a list of functions that Emacs calls without
> >  > +arguments after setting up the Ediff buffers. JOB-NAME is a
> >  > +symbol describing the Ediff job type; it defaults to
> >  > +`ediff-buffers'."
> >
> >  Here and elsewhere where JOB-NAME is mentioned, it would be good to
> >  have a full list of supported symbols, not just the default one.
> >
> > I've added some generic text to the docstrings. I have no idea what the
> full list of supported symbols are and
> > what the point of this argument is in the first place.
>
> Can we have there at least the list of the symbols that are seen in
> the sources:  I see these:
>
>  ediff-merge-files-with-ancestor, ediff-last-dir-ancestor,
>  ediff-last-dir-C, ediff-buffers, ediff-buffers3, ediff-merge-buffers,
>  ediff-merge-buffers-with-ancestor
>
> If this list is too long to be repeated in each doc string, we could
> have it once, and reference that place from the other do strings.  I
> think either way would be much better than using some generic text.
>
>
Here's a new version of the patch.

[Message part 2 (text/html, inline)]

[0001-Ediff-add-some-missing-documentation.txt (text/plain, attachment)]

Message #23 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sun, 05 Nov 2017 18:51:47 +0200

> From: Philipp Stephani <p.stephani2 <at> gmail.com>
> Date: Sun, 05 Nov 2017 16:29:35 +0000
> Cc: 27764 <at> debbugs.gnu.org
> 
>  Can we have there at least the list of the symbols that are seen in
>  the sources:  I see these:
> 
>   ediff-merge-files-with-ancestor, ediff-last-dir-ancestor,
>   ediff-last-dir-C, ediff-buffers, ediff-buffers3, ediff-merge-buffers,
>   ediff-merge-buffers-with-ancestor
> 
>  If this list is too long to be repeated in each doc string, we could
>  have it once, and reference that place from the other do strings.  I
>  think either way would be much better than using some generic text.
> 
> Here's a new version of the patch. 

Thanks, this is fine.

Message #26 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>, 27764-done <at> debbugs.gnu.org
Cc: "27764 <at> debbugs.gnu.org" <27764 <at> debbugs.gnu.org>
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sun, 05 Nov 2017 17:54:47 +0000

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> schrieb am So., 5. Nov. 2017 um 17:51 Uhr:

> > From: Philipp Stephani <p.stephani2 <at> gmail.com>
> > Date: Sun, 05 Nov 2017 16:29:35 +0000
> > Cc: 27764 <at> debbugs.gnu.org
> >
> >  Can we have there at least the list of the symbols that are seen in
> >  the sources:  I see these:
> >
> >   ediff-merge-files-with-ancestor, ediff-last-dir-ancestor,
> >   ediff-last-dir-C, ediff-buffers, ediff-buffers3, ediff-merge-buffers,
> >   ediff-merge-buffers-with-ancestor
> >
> >  If this list is too long to be repeated in each doc string, we could
> >  have it once, and reference that place from the other do strings.  I
> >  think either way would be much better than using some generic text.
> >
> > Here's a new version of the patch.
>
> Thanks, this is fine.
>

Thanks, pushed as 72d07d1950 to the release branch.

[Message part 2 (text/html, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.