From: michael@cadilhac.name (Michaël Cadilhac)
Cc: Stefan Monnier <monnier@iro.umontreal.ca>, emacs-devel@gnu.org
Subject: Re: defcustom and the stars.
Date: Wed, 03 Jan 2007 15:52:19 +0100 [thread overview]
Message-ID: <87mz50nows.fsf@lrde.org> (raw)
In-Reply-To: <f7ccd24b0701030557t58e0c369y87b74ea33607cfff@mail.gmail.com> (Juanma Barranquero's message of "Wed\, 3 Jan 2007 14\:57\:33 +0100")
[-- Attachment #1.1.1: Type: text/plain, Size: 490 bytes --]
"Juanma Barranquero" <lekktu@gmail.com> writes:
> On 1/3/07, Michaël Cadilhac <michael@cadilhac.name> wrote:
>
>> http://permalink.gmane.org/gmane.emacs.devel/64677
>
>> And the only reference to user variable in this doc is
>> for customizable vars (AFAICS).
>
> Then yes, perhaps a doc patch would be in order.
So let's give it a try (writing doc is always funny for me as my
English is far from good). This is to be read together with the
previous patch (if applied).
[-- Attachment #1.1.2: custom.patch --]
[-- Type: text/x-patch, Size: 3108 bytes --]
Index: man/custom.texi
===================================================================
RCS file: /sources/emacs/emacs/man/custom.texi,v
retrieving revision 1.124
diff -c -r1.124 custom.texi
*** man/custom.texi 1 Jan 2007 01:57:16 -0000 1.124
--- man/custom.texi 3 Jan 2007 14:36:31 -0000
***************
*** 807,813 ****
Display the value and documentation of variable @var{var}
(@code{describe-variable}).
@item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET}
! Change the value of variable @var{var} to @var{value}.
@end table
To examine the value of a single variable, use @kbd{C-h v}
--- 807,813 ----
Display the value and documentation of variable @var{var}
(@code{describe-variable}).
@item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET}
! Change the value of the user option variable @var{var} to @var{value}.
@end table
To examine the value of a single variable, use @kbd{C-h v}
***************
*** 832,838 ****
satisfies the predicate `integerp'.
Documentation:
! *Column beyond which automatic line-wrapping should happen.
Interactively, you can set the buffer local value using C-x f.
You can customize this variable.
--- 832,838 ----
satisfies the predicate `integerp'.
Documentation:
! Column beyond which automatic line-wrapping should happen.
Interactively, you can set the buffer local value using C-x f.
You can customize this variable.
***************
*** 840,848 ****
@noindent
The line that says you can customize the variable indicates that this
! variable is a user option. (The star also indicates this, but it is
! an obsolete indicator that may eventually disappear.) @kbd{C-h v} is
! not restricted to user options; it allows any variable name.
@findex set-variable
The most convenient way to set a specific user option variable is with
--- 840,848 ----
@noindent
The line that says you can customize the variable indicates that this
! variable is a user option, as would have indicated a line saying that
! you can change at user level the variable. @kbd{C-h v} is not
! restricted to user options; it allows any variable name.
@findex set-variable
The most convenient way to set a specific user option variable is with
Index: man/ChangeLog
===================================================================
RCS file: /sources/emacs/emacs/man/ChangeLog,v
retrieving revision 1.1177
diff -C0 -r1.1177 ChangeLog
*** man/ChangeLog 1 Jan 2007 22:20:46 -0000 1.1177
--- man/ChangeLog 3 Jan 2007 14:36:47 -0000
***************
*** 0 ****
--- 1,9 ----
+ 2007-01-03 Michaël Cadilhac <michael.cadilhac@lrde.org>
+
+ * custom.texi (Examining): Say sooner that set-variable takes only
+ user option variables.
+ Remove the leading `*' in the documentation of `fill-column' used as an
+ example. Remove the mention on the obsolescence of this star.
+ Indicate that the line `you can change at user level the variable'
+ means that the variable is a user option.
+
[-- Attachment #1.1.3: Type: text/plain, Size: 917 bytes --]
> Regarding your patch, I'm not sure. On one hand, talking about
> set-variable in the output of describe-variable can be useful, and it
> certainly isn't like we are shy about adding useful info there (try
> with an automatically buffer-local, obsolete variable alias with a
> safe-local-variable property :)
>
> On the other hand, it is already quite crowded...
At least, it will not add any line to an automatically buffer-local,
obsolete variable alias with a safe-local-variable property WHICH IS
customizable. Only to a [...] that has a "*" and is not customizable!
--
| Michaël `Micha' Cadilhac | The second-degree, |
| Epita/LRDE Promo 2007 | is kind of |
| http://michael.cadilhac.name | the semantic back slang. |
`--JID: michael.cadilhac@gmail.com--' - --'
[-- Attachment #1.2: Type: application/pgp-signature, Size: 188 bytes --]
[-- Attachment #2: Type: text/plain, Size: 142 bytes --]
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
next prev parent reply other threads:[~2007-01-03 14:52 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-01-02 22:00 defcustom and the stars Michaël Cadilhac
2007-01-03 3:56 ` Stefan Monnier
2007-01-03 11:05 ` Michaël Cadilhac
2007-01-03 12:24 ` Juanma Barranquero
2007-01-03 12:49 ` Michaël Cadilhac
2007-01-03 13:08 ` Juanma Barranquero
2007-01-03 13:18 ` Michaël Cadilhac
2007-01-03 13:29 ` Juanma Barranquero
2007-01-03 13:43 ` Michaël Cadilhac
2007-01-03 13:57 ` Juanma Barranquero
2007-01-03 14:52 ` Michaël Cadilhac [this message]
2007-01-03 18:47 ` Juanma Barranquero
2007-01-03 20:57 ` Juanma Barranquero
2007-01-03 21:21 ` Michaël Cadilhac
2007-01-03 21:26 ` Juanma Barranquero
2007-01-04 2:31 ` Richard Stallman
2007-01-04 2:31 ` Richard Stallman
2007-01-04 7:34 ` Michaël Cadilhac
2007-01-04 17:08 ` Drew Adams
2007-01-04 19:28 ` Michaël Cadilhac
2007-01-04 22:13 ` Drew Adams
2007-01-04 22:50 ` Stuart D. Herring
2007-01-04 22:58 ` Drew Adams
2007-01-08 17:51 ` Stuart D. Herring
2007-01-08 18:09 ` Michaël Cadilhac
2007-01-08 18:32 ` Drew Adams
2007-01-08 18:46 ` Michaël Cadilhac
2007-01-08 20:50 ` Chris Moore
2007-01-09 4:21 ` Drew Adams
2007-01-09 18:32 ` Chris Moore
2007-01-09 22:56 ` Drew Adams
2007-01-10 15:15 ` Chris Moore
2007-01-10 16:19 ` Drew Adams
2007-01-10 18:44 ` Chris Moore
2007-01-10 18:47 ` Drew Adams
2007-01-08 18:26 ` Drew Adams
2007-01-05 6:36 ` Michaël Cadilhac
2007-01-05 15:15 ` Drew Adams
2007-01-04 22:33 ` Richard Stallman
2007-01-03 18:17 ` Eli Zaretskii
2007-01-03 18:34 ` Juanma Barranquero
2007-01-04 2:32 ` Richard Stallman
2007-01-04 16:57 ` Drew Adams
2007-01-04 17:10 ` Juanma Barranquero
2007-01-04 17:16 ` Drew Adams
2007-01-04 17:39 ` Juanma Barranquero
2007-01-04 18:22 ` Drew Adams
2007-01-04 19:30 ` Juanma Barranquero
2007-01-04 22:32 ` Drew Adams
2007-01-04 22:49 ` Drew Adams
2007-01-04 23:12 ` Juanma Barranquero
2007-01-05 1:01 ` Drew Adams
2007-01-05 1:09 ` Juanma Barranquero
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mz50nows.fsf@lrde.org \
--to=michael@cadilhac.name \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.