bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Francesco Potortì]

Contrary to the docs, auto-fill-mode called programmatically is enabled
with arg 1 and disabled with arg 0.



In GNU Emacs 25.1.1 (x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2016-10-24, modified by Debian built on trouble
Windowing system distributor 'The X.Org Foundation', version 11.0.11900000
System Description:	Debian GNU/Linux testing (stretch)

Configured using:
 'configure --build x86_64-linux-gnu --prefix=/usr
 --sharedstatedir=/var/lib --libexecdir=/usr/lib
 --localstatedir=/var/lib --infodir=/usr/share/info
 --mandir=/usr/share/man --with-pop=yes
 --enable-locallisppath=/etc/emacs25:/etc/emacs:/usr/local/share/emacs/25.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/25.1/site-lisp:/usr/share/emacs/site-lisp
 --with-sound=alsa --build x86_64-linux-gnu --prefix=/usr
 --sharedstatedir=/var/lib --libexecdir=/usr/lib
 --localstatedir=/var/lib --infodir=/usr/share/info
 --mandir=/usr/share/man --with-pop=yes
 --enable-locallisppath=/etc/emacs25:/etc/emacs:/usr/local/share/emacs/25.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/25.1/site-lisp:/usr/share/emacs/site-lisp
 --with-sound=alsa --with-x=yes --with-x-toolkit=lucid
 --with-toolkit-scroll-bars --without-gconf --without-gsettings
 'CFLAGS=-g -O2
 -fdebug-prefix-map=/build/emacs25-25.1+1=. -fstack-protector-strong
 -Wformat -Werror=format-security -Wall' 'CPPFLAGS=-Wdate-time
 -D_FORTIFY_SOURCE=2' LDFLAGS=-Wl,-z,relro'

Configured features:
XAW3D XPM JPEG TIFF GIF PNG RSVG IMAGEMAGICK SOUND GPM DBUS NOTIFY ACL
LIBSELINUX GNUTLS LIBXML2 FREETYPE M17N_FLT LIBOTF XFT ZLIB
TOOLKIT_SCROLL_BARS LUCID X11

Important settings:
  value of $LC_COLLATE: it_IT.UTF-8
  value of $LC_CTYPE: it_IT.UTF-8
  value of $LC_NUMERIC: C
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Emacs-Lisp

Minor modes in effect:
  global-visual-fill-column-mode: t
  diff-auto-refine-mode: t
  TeX-PDF-mode: t
  desktop-save-mode: t
  epa-global-mail-mode: t
  shell-dirtrack-mode: t
  openwith-mode: t
  xterm-mouse-mode: t
  display-time-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  column-number-mode: t
  line-number-mode: t
  auto-fill-function: do-auto-fill

Recent messages:
Modification-flag cleared
Counting messages...done
Showing message 63...done
Showing message 63...done
Showing message 62...done
Showing message 61...done
Showing message 60...done
Showing message 63...done
Mark set
Making completion list...

Load-path shadows:
~/elisp/bhl hides /usr/share/emacs/site-lisp/bhl
/usr/share/emacs25/site-lisp/flim/md4 hides /usr/share/emacs/25.1/lisp/md4
/usr/share/emacs25/site-lisp/flim/hex-util hides /usr/share/emacs/25.1/lisp/hex-util
/usr/share/emacs/site-lisp/rst hides /usr/share/emacs/25.1/lisp/textmodes/rst
~/elisp/bibtex hides /usr/share/emacs/25.1/lisp/textmodes/bibtex
/usr/share/emacs25/site-lisp/flim/ntlm hides /usr/share/emacs/25.1/lisp/net/ntlm
/usr/share/emacs25/site-lisp/flim/hmac-md5 hides /usr/share/emacs/25.1/lisp/net/hmac-md5
/usr/share/emacs25/site-lisp/flim/sasl-ntlm hides /usr/share/emacs/25.1/lisp/net/sasl-ntlm
/usr/share/emacs25/site-lisp/flim/sasl-digest hides /usr/share/emacs/25.1/lisp/net/sasl-digest
/usr/share/emacs25/site-lisp/flim/sasl hides /usr/share/emacs/25.1/lisp/net/sasl
/usr/share/emacs25/site-lisp/flim/sasl-cram hides /usr/share/emacs/25.1/lisp/net/sasl-cram
/usr/share/emacs25/site-lisp/flim/hmac-def hides /usr/share/emacs/25.1/lisp/net/hmac-def
/usr/share/emacs25/site-lisp/auctex/tex-fold hides /usr/share/emacs/site-lisp/auctex/tex-fold
/usr/share/emacs25/site-lisp/auctex/context-en hides /usr/share/emacs/site-lisp/auctex/context-en
/usr/share/emacs25/site-lisp/auctex/tex-info hides /usr/share/emacs/site-lisp/auctex/tex-info
/usr/share/emacs25/site-lisp/auctex/plain-tex hides /usr/share/emacs/site-lisp/auctex/plain-tex
/usr/share/emacs25/site-lisp/auctex/tex-mik hides /usr/share/emacs/site-lisp/auctex/tex-mik
/usr/share/emacs25/site-lisp/auctex/texmathp hides /usr/share/emacs/site-lisp/auctex/texmathp
/usr/share/emacs25/site-lisp/auctex/context-nl hides /usr/share/emacs/site-lisp/auctex/context-nl
/usr/share/emacs25/site-lisp/auctex/toolbar-x hides /usr/share/emacs/site-lisp/auctex/toolbar-x
/usr/share/emacs25/site-lisp/auctex/tex hides /usr/share/emacs/site-lisp/auctex/tex
/usr/share/emacs25/site-lisp/auctex/tex-jp hides /usr/share/emacs/site-lisp/auctex/tex-jp
/usr/share/emacs25/site-lisp/auctex/bib-cite hides /usr/share/emacs/site-lisp/auctex/bib-cite
/usr/share/emacs25/site-lisp/auctex/multi-prompt hides /usr/share/emacs/site-lisp/auctex/multi-prompt
/usr/share/emacs25/site-lisp/auctex/font-latex hides /usr/share/emacs/site-lisp/auctex/font-latex
/usr/share/emacs25/site-lisp/auctex/prv-emacs hides /usr/share/emacs/site-lisp/auctex/prv-emacs
/usr/share/emacs25/site-lisp/auctex/tex-style hides /usr/share/emacs/site-lisp/auctex/tex-style
/usr/share/emacs25/site-lisp/auctex/context hides /usr/share/emacs/site-lisp/auctex/context
/usr/share/emacs25/site-lisp/auctex/preview hides /usr/share/emacs/site-lisp/auctex/preview
/usr/share/emacs25/site-lisp/auctex/tex-font hides /usr/share/emacs/site-lisp/auctex/tex-font
/usr/share/emacs25/site-lisp/auctex/tex-bar hides /usr/share/emacs/site-lisp/auctex/tex-bar
/usr/share/emacs25/site-lisp/auctex/latex hides /usr/share/emacs/site-lisp/auctex/latex
/usr/share/emacs25/site-lisp/auctex/tex-buf hides /usr/share/emacs/site-lisp/auctex/tex-buf
~/elisp/bhl hides /usr/share/emacs25/site-lisp/bhl
/usr/share/emacs/site-lisp/debian-startup hides /usr/share/emacs25/site-lisp/debian-startup

Features:
(ruler-mode cal-x debug two-column iso-transl apropos pcmpl-gnu
pcmpl-linux macros python tramp-sh tar-mode anything-config anything
woman mailcap undigest cal-move smerge-mode diff doc-view vc-cvs
pcmpl-unix json-mode rx cus-edit wid-edit cus-start cus-load rmailedit
tabify man vc-dir ewoc tramp-cache shadow emacsbug reporter debian-bug
mail-extr texmathp nxml-uchnm rng-xsd xsd-regexp rng-cmpct rng-nxml
rng-valid rng-loc rng-uri rng-parse nxml-parse rng-match rng-dt rng-util
rng-pttrn nxml-ns nxml-mode nxml-outln nxml-rap nxml-util nxml-glyph
nxml-enc xmltok tmm ido etags xref project ediff-merg ediff-wind
ediff-diff ediff-mult ediff-help ediff-init ediff-util ediff js json map
imenu ispell log-view pp visual-fill-column locate dired-aux eieio-opt
speedbar sb-image ezimage dframe find-func timezone rmailsort face-remap
url-handlers nero cl rect log-edit pcvs-util add-log grep dabbrev
diff-mode vc rmailkwd mailalias rmailout shr-color color time-stamp
misearch multi-isearch server parse-time unrmail qp url-util shr dom
subr-x browse-url jka-compr cc-mode cc-fonts cc-guess cc-menus cc-cmds
cc-styles cc-align cc-engine cc-vars cc-defs bibtex info sh-script
executable sgml-mode vc-filewise vc-rcs image-mode view conf-mode
generic octave smie latexenc plain-tex vc-dispatcher vc-svn preview
prv-emacs tex-bar tex-buf toolbar-x noutline outline font-latex latex
easy-mmode edmacro kmacro tex-style tex dbus xml crm tex-mode compile
rmailmm message rfc822 mml mml-sec mm-decode mm-bodies mm-encode
mailabbrev gmm-utils mailheader mail-parse rfc2231 desktop frameset
term/xterm xterm pot skeleton rmailsum rmail warnings sendmail rfc2047
rfc2045 ietf-drums mime-compose epa-mail mail-utils epa derived epg
cal-china lunar solar cal-dst cal-bahai cal-islam cal-hebrew holidays
hol-loaddefs vc-hg appt diary-lib diary-loaddefs cal-menu calendar
cal-loaddefs tramp tramp-compat tramp-loaddefs trampver ucs-normalize
shell pcomplete comint ring format-spec bhl switch-to-shell openwith
hi-lock xt-mouse ffap thingatpt url-parse auth-source cl-seq eieio
eieio-core cl-macs gnus-util time-date mm-util help-fns mail-prsvr
password-cache url-vars scroll-in-place filladapt ansi-color advice time
quail dired-x dired generic-x disp-table finder-inf package epg-config
seq byte-opt gv bytecomp byte-compile cl-extra help-mode easymenu cconv
cl-loaddefs pcase cl-lib debian-el debian-el-loaddefs w3m-load
vm-autoload vm-autoloads vm-version vm-vars vm-init preview-latex
tex-site auto-loads mule-util tooltip eldoc electric uniquify ediff-hook
vc-hooks lisp-float-type mwheel x-win term/common-win x-dnd tool-bar dnd
fontset image regexp-opt fringe tabulated-list newcomment elisp-mode
lisp-mode prog-mode register page menu-bar rfn-eshadow timer select
scroll-bar mouse jit-lock font-lock syntax facemenu font-core 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 charscript
case-table epa-hook jka-cmpr-hook help simple abbrev 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 dbusbind inotify
dynamic-setting font-render-setting x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 1176401 152830)
 (symbols 48 60421 2)
 (miscs 40 8567 6832)
 (strings 32 175183 30285)
 (string-bytes 1 6034750)
 (vectors 16 86801)
 (vector-slots 8 2197329 87565)
 (floats 8 1420 1360)
 (intervals 56 170521 2615)
 (buffers 976 232))

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Andreas Schwab]

On Jan 13 2017, Francesco Potortì <pot@gnu.org> wrote:

> Contrary to the docs, auto-fill-mode called programmatically is enabled
> with arg 1 and disabled with arg 0.

In which way is that contradicting the docs?  The only case that is
missing is that 'toggle toggles.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Francesco Potortì]

>On Jan 13 2017, Francesco Potortì <pot@gnu.org> wrote:
>> Contrary to the docs, auto-fill-mode called programmatically is enabled
>> with arg 1 and disabled with arg 0.
>
>In which way is that contradicting the docs?  The only case that is
>missing is that 'toggle toggles.

In the help string, I read:

--
With a prefix argument ARG, enable Auto Fill mode if ARG is
positive, and disable it otherwise.  If called from Lisp, enable
the mode if ARG is omitted or nil.
--

I read it as meaning that

(auto-fill-mode)	; turns the mode on
(auto-fill-mode nil)	; turns the mode on

while everything else turns it off, but

(auto-fill-mode 'off)	; does not turn it off

If the behaviour is the intended one, then probably the doc string
should be amended to add the word "Additionally" at the beginning of the
second sentence, like this:

With a prefix argument ARG, enable Auto Fill mode if ARG is positive,
and disable it otherwise.  Additionally, if called from Lisp, enable the
mode if ARG is omitted or nil.

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Glenn Morris]

Francesco Potortì wrote:

> If the behaviour is the intended one, then probably the doc string
> should be amended to add the word "Additionally" at the beginning of the
> second sentence, like this:

Surely common sense tells you that is the intended meaning?

There are about 130 instances of this form in Emacs.
There are 4 instances of ", also enable", maybe you prefer that?

Feel feel to correct them all, I guess, if it bothers you that much. :)

See also #13926, and #10754. An automatic solution like 10754 seems best to me.

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Francesco Potortì]

Date: 13 Jan 2017 21:08:33 +0100

>> If the behaviour is the intended one, then probably the doc string
>> should be amended to add the word "Additionally" at the beginning of the
>> second sentence, like this:
>
>Surely common sense tells you that is the intended meaning?

Well, when reading specifications, I tend to put common sense apart and
look at the literal meaning :)

I think that the way it is worded it may sound ambguous.  in fact, it
has sounded wrong for me.  So, why not add a single word to clarify
things?

>There are about 130 instances of this form in Emacs.
>There are 4 instances of ", also enable", maybe you prefer that?

I suppose you mean something like:

--
With a prefix argument ARG, enable Auto Fill mode if ARG is positive,
and disable it otherwise.  If called from Lisp, also enable the mode if
ARG is omitted or nil.

Yes, maybe it is even clearer and simpler than what I proposed.

>Feel feel to correct them all, I guess, if it bothers you that much. :)

Ok, that amounts to probably never.  In the last years I have barely the
time to report bugs and follow up on them.  Not even always.  Thanks
anyway.

>See also #13926, and #10754. An automatic solution like 10754 seems
>best to me.

This is a special week, when I have little workload and am trying to
shorten my backlog.  Maybe one day I will find the time and energy to
look at those.  Maybe tomorrow, maybe never, who knows :)

bug#25435: 25.1; auto-fill-mode is enabled with 1, disabled with 0

[Eli Zaretskii]

> Date: Fri, 13 Jan 2017 12:43:02 +0100
> From: Francesco Potortì <pot@gnu.org>
> 
> Contrary to the docs, auto-fill-mode called programmatically is enabled
> with arg 1 and disabled with arg 0.

Thanks.

If you mean the doc string, then I see nothing there that contradicts
what you say.  (I could agree that the doc string doesn't tell the
whole story, though.)  If you mean some other documentation, please
tell which one.