* bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu
@ 2012-08-29 22:57 Drew Adams
2012-09-16 23:32 ` bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matchesmenu Drew Adams
` (3 more replies)
0 siblings, 4 replies; 7+ messages in thread
From: Drew Adams @ 2012-08-29 22:57 UTC (permalink / raw)
To: 12309
The doc strings of these variables speak of values t, nil, `never', and
(for `bookmark-version-control) `nospecial'.
The Value Menu for `version-control' shows "Never", "If existing",
"Always". At least you can see the correspondence, because the same
words are used - you can tell that "Always" corresponds to "always" in
the doc string, which corresponds to value `t'.
The Value Menu for `bookmark-version-control' shows "nil", "never",
"nospecial", and "Other". It is "Other" that is problematic for a user
- it doesn't correspond to anything in the doc string (except by process
of elimination).
Please use :tag to make things clearer. In particular, use something
besides "Other" (the default name) for `t' (i.e., for any other non-nil value
than `never' and `nospecial').
In GNU Emacs 24.2.50.1 (i386-mingw-nt5.1.2600)
of 2012-08-26 on MARVIN
Bzr revision: 109788 dmantipov@yandex.ru-20120827041533-3cy7pdjdqz14o90c
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
`configure --with-gcc (4.6) --no-opt --enable-checking --cflags
-ID:/devel/emacs/libs/libXpm-3.5.8/include
-ID:/devel/emacs/libs/libXpm-3.5.8/src
-ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
-ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
-ID:/devel/emacs/libs/giflib-4.1.4-1/include
-ID:/devel/emacs/libs/jpeg-6b-4/include
-ID:/devel/emacs/libs/tiff-3.8.2-1/include
-ID:/devel/emacs/libs/gnutls-3.0.9/include
-ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
-ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
^ permalink raw reply [flat|nested] 7+ messages in thread* bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matchesmenu
2012-08-29 22:57 bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu Drew Adams
@ 2012-09-16 23:32 ` Drew Adams
2012-10-01 3:47 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
` (2 subsequent siblings)
3 siblings, 0 replies; 7+ messages in thread
From: Drew Adams @ 2012-09-16 23:32 UTC (permalink / raw)
To: 12309
ping
^ permalink raw reply [flat|nested] 7+ messages in thread* bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu
2012-08-29 22:57 bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu Drew Adams
2012-09-16 23:32 ` bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matchesmenu Drew Adams
@ 2012-10-01 3:47 ` Karl Fogel
2012-10-01 9:41 ` Andreas Schwab
2012-10-01 4:17 ` bug#12309: Improved wording Karl Fogel
2012-10-01 4:37 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
3 siblings, 1 reply; 7+ messages in thread
From: Karl Fogel @ 2012-10-01 3:47 UTC (permalink / raw)
To: 12309-done
Fixed (see below), but please review.
I don't fully understand the whole customization system because I never
use it myself (I just read doc strings and set variables directly in
Elisp), so I don't quite get what `other' mean if used instead of
`const', and I didn't fully understand the last paragraph of the
original bug report. I looked in the Info pages, but they didn't
clarify much about this.
-Karl
Revision info:
revno: 110305
revision-id: kfogel@red-bean.com-20121001033206-5eja4ztyhs1sjm7q
parent: cyd@gnu.org-20121001031702-2mei04wuzv2pk1e7
committer: Karl Fogel <kfogel@red-bean.com>
branch nick: trunk
timestamp: Sun 2012-09-30 22:32:06 -0500
message:
* lisp/bookmark.el (bookmark-version-control): Give tags in the
:type choices (Bug#12309), and improve doc string.
Diff:
=== modified file 'lisp/ChangeLog'
--- lisp/ChangeLog 2012-10-01 02:07:14 +0000
+++ lisp/ChangeLog 2012-10-01 03:31:41 +0000
@@ -1,3 +1,8 @@
+2012-10-01 Karl Fogel <kfogel@red-bean.com>
+
+ * bookmark.el (bookmark-version-control): Give tags in the
+ :type choices (Bug#12309), and improve doc string.
+
2012-10-01 Paul Eggert <eggert@cs.ucla.edu>
Revert the FOLLOW-SYMLINKS change for file-attributes.
=== modified file 'lisp/bookmark.el'
--- lisp/bookmark.el 2012-09-25 04:13:02 +0000
+++ lisp/bookmark.el 2012-10-01 03:32:18 +0000
@@ -99,12 +99,14 @@
(defcustom bookmark-version-control 'nospecial
"Whether or not to make numbered backups of the bookmark file.
-It can have four values: t, nil, `never', and `nospecial'.
+It can have four values: t, nil, `never', or `nospecial'.
The first three have the same meaning that they do for the
-variable `version-control', and the final value `nospecial' means just
-use the value of `version-control'."
- :type '(choice (const nil) (const never) (const nospecial)
- (other t))
+variable `version-control'; the value `nospecial' (the default) means
+just use the value of `version-control'."
+ :type '(choice (const :tag "If existing" nil)
+ (const :tag "Never" never)
+ (const :tag "Use the value of `version-control'" nospecial)
+ (const :tag "Always" t))
:group 'bookmark)
^ permalink raw reply [flat|nested] 7+ messages in thread* bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu
2012-10-01 3:47 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
@ 2012-10-01 9:41 ` Andreas Schwab
2012-10-01 21:25 ` Karl Fogel
0 siblings, 1 reply; 7+ messages in thread
From: Andreas Schwab @ 2012-10-01 9:41 UTC (permalink / raw)
To: Karl Fogel; +Cc: 12309-done
Karl Fogel <kfogel@openitp.org> writes:
> I don't fully understand the whole customization system because I never
> use it myself (I just read doc strings and set variables directly in
> Elisp), so I don't quite get what `other' mean if used instead of
> `const', and I didn't fully understand the last paragraph of the
> original bug report. I looked in the Info pages, but they didn't
> clarify much about this.
const only matches the specified value, other matches any value, but
uses the specified value when setting. Thus setting the variable
manually to 'foo won't get a mismatch. You can see the documentation of
each widget with widget-browse.
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."
^ permalink raw reply [flat|nested] 7+ messages in thread
* bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu
2012-10-01 9:41 ` Andreas Schwab
@ 2012-10-01 21:25 ` Karl Fogel
0 siblings, 0 replies; 7+ messages in thread
From: Karl Fogel @ 2012-10-01 21:25 UTC (permalink / raw)
To: Andreas Schwab; +Cc: 12309-done
Andreas Schwab <schwab@linux-m68k.org> writes:
>const only matches the specified value, other matches any value, but
>uses the specified value when setting. Thus setting the variable
>manually to 'foo won't get a mismatch. You can see the documentation of
>each widget with widget-browse.
Thanks, Andreas. Looks like having `other' on `t' is the right thing,
then.
-K
^ permalink raw reply [flat|nested] 7+ messages in thread
* bug#12309: Improved wording.
2012-08-29 22:57 bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu Drew Adams
2012-09-16 23:32 ` bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matchesmenu Drew Adams
2012-10-01 3:47 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
@ 2012-10-01 4:17 ` Karl Fogel
2012-10-01 4:37 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
3 siblings, 0 replies; 7+ messages in thread
From: Karl Fogel @ 2012-10-01 4:17 UTC (permalink / raw)
To: 12309
Drew, thanks for your comment [1]. I tweaked the variable to use your
somewhat better choices.
Karl
[1] http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12507#102 because I
misfired my original control mail and put it in 12507 instead of
here in 12309.
^ permalink raw reply [flat|nested] 7+ messages in thread* bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu
2012-08-29 22:57 bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu Drew Adams
` (2 preceding siblings ...)
2012-10-01 4:17 ` bug#12309: Improved wording Karl Fogel
@ 2012-10-01 4:37 ` Karl Fogel
3 siblings, 0 replies; 7+ messages in thread
From: Karl Fogel @ 2012-10-01 4:37 UTC (permalink / raw)
To: 12309-done
Fixed (see below), but please review.
I don't fully understand the whole customization system because I never
use it myself (I just read doc strings and set variables directly in
Elisp), so I don't quite get what `other' mean if used instead of
`const', and I didn't fully understand the last paragraph of the
original bug report. I looked in the Info pages, but they didn't
clarify much about this.
-Karl
Revision info:
revno: 110305
revision-id: kfogel@red-bean.com-20121001033206-5eja4ztyhs1sjm7q
parent: cyd@gnu.org-20121001031702-2mei04wuzv2pk1e7
committer: Karl Fogel <kfogel@red-bean.com>
branch nick: trunk
timestamp: Sun 2012-09-30 22:32:06 -0500
message:
* lisp/bookmark.el (bookmark-version-control): Give tags in the
:type choices (Bug#12309), and improve doc string.
Diff:
=== modified file 'lisp/ChangeLog'
--- lisp/ChangeLog 2012-10-01 02:07:14 +0000
+++ lisp/ChangeLog 2012-10-01 03:31:41 +0000
@@ -1,3 +1,8 @@
+2012-10-01 Karl Fogel <kfogel@red-bean.com>
+
+ * bookmark.el (bookmark-version-control): Give tags in the
+ :type choices (Bug#12309), and improve doc string.
+
2012-10-01 Paul Eggert <eggert@cs.ucla.edu>
Revert the FOLLOW-SYMLINKS change for file-attributes.
=== modified file 'lisp/bookmark.el'
--- lisp/bookmark.el 2012-09-25 04:13:02 +0000
+++ lisp/bookmark.el 2012-10-01 03:32:18 +0000
@@ -99,12 +99,14 @@
(defcustom bookmark-version-control 'nospecial
"Whether or not to make numbered backups of the bookmark file.
-It can have four values: t, nil, `never', and `nospecial'.
+It can have four values: t, nil, `never', or `nospecial'.
The first three have the same meaning that they do for the
-variable `version-control', and the final value `nospecial' means just
-use the value of `version-control'."
- :type '(choice (const nil) (const never) (const nospecial)
- (other t))
+variable `version-control'; the value `nospecial' (the default) means
+just use the value of `version-control'."
+ :type '(choice (const :tag "If existing" nil)
+ (const :tag "Never" never)
+ (const :tag "Use the value of `version-control'" nospecial)
+ (const :tag "Always" t))
:group 'bookmark)
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2012-10-01 21:25 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-08-29 22:57 bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matches menu Drew Adams
2012-09-16 23:32 ` bug#12309: 24.2.50; Option `(bookmark-)version-control': Use :tag so doc string matchesmenu Drew Adams
2012-10-01 3:47 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
2012-10-01 9:41 ` Andreas Schwab
2012-10-01 21:25 ` Karl Fogel
2012-10-01 4:17 ` bug#12309: Improved wording Karl Fogel
2012-10-01 4:37 ` bug#12309: Option `(bookmark-)version-control': Use :tag so doc string matches menu Karl Fogel
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).