bug#25528: 25.1; doc string for gui--selection-value-internal is out of place

bug#25528: 25.1; doc string for gui--selection-value-internal is out of place

[Francesco Potortì]

In select.el, docs for gui--selection-value-internal are there, but they
are in form of a comment preceding the defun.  It would be more useful
if they were moved inside the defun as a doc string.


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 9.0 (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
  buffer-read-only: t
  column-number-mode: t
  line-number-mode: t
  auto-fill-function: do-auto-fill

Recent messages:
Auto-saving...done
<C-return> is undefined
Auto-saving...done
Make carbon copy before sending? (y or n) y
Unfrobbing selective-display...
Sending...
Added to /home/pot/Mail/personali/goegc
Added to /home/pot/Mail/backup/SMAIL
Sending...done
Quit

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:
(tramp-cmds make-mode autoconf autoconf-mode autorevert filenotify
find-dired loadhist novice wdired animate misc 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 1254581 249971)
 (symbols 48 61077 35)
 (miscs 40 8648 6552)
 (strings 32 178386 35390)
 (string-bytes 1 5345612)
 (vectors 16 88768)
 (vector-slots 8 2209034 90862)
 (floats 8 1252 1361)
 (intervals 56 204854 4846)
 (buffers 976 247))

bug#25528: 25.1; doc string for gui--selection-value-internal is out of place

[Glenn Morris]

Francesco Potortì wrote:

> In select.el, docs for gui--selection-value-internal are there, but they
> are in form of a comment preceding the defun.  It would be more useful
> if they were moved inside the defun as a doc string.

Please feel free to just do things like this without making a report.

bug#25528: 25.1; doc string for gui--selection-value-internal is out of place

[Francesco Potortì]

>> In select.el, docs for gui--selection-value-internal are there, but they
>> are in form of a comment preceding the defun.  It would be more useful
>> if they were moved inside the defun as a doc string.
>
>Please feel free to just do things like this without making a report.

There was a time when I had a working copy of the Emacs source on my box
and applied changes by myself.  I even helped creating distributions.
Much time has passed since then, and (if I am not wrong) Emacs has
changed version control systems twice.  Moreover, nowadays I program
more and more rarely.  In fact, I have not the tools needed to do that,
and I do not have the time to install themn and learn how to use them.
That may change in the future or not.  In the meantime, I think it's
best to provide a report than waiting for that future :)

Thank you and everyone else for your great work.

bug#25528: 25.1; doc string for gui--selection-value-internal is out of place

[Stefan Kangas]

tags 25528 fixed
close 25528 27.1
quit

Glenn Morris <rgm@gnu.org> writes:

> Francesco Potortì wrote:
>
>> In select.el, docs for gui--selection-value-internal are there, but they
>> are in form of a comment preceding the defun.  It would be more useful
>> if they were moved inside the defun as a doc string.
>
> Please feel free to just do things like this without making a report.

This is now fixed on master in commit 897540069f.

Best regards,
Stefan Kangas