GNU bug report logs - #1368
Confusing documentation for c-tab-always-indent

Previous Next

Packages: emacs, cc-mode;

Reported by: Reuben Thomas <rrt <at> sc3d.org>

Date: Tue, 18 Nov 2008 11:55:03 UTC

Severity: normal

Done: Glenn Morris <rgm <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (Emacs bug Tracking System)
To: Glenn Morris <rgm <at> gnu.org>
Subject: bug#1368: marked as done (Confusing documentation for 
 c-tab-always-indent)
[Message part 1 (text/plain, inline)]
Your message dated Mon, 01 Dec 2008 22:38:27 -0500
with message-id <d3fxl7w8jw.fsf <at> fencepost.gnu.org>
and subject line Re: bug#1368: Confusing documentation for c-tab-always-indent
has caused the Emacs bug report #1368,
regarding Confusing documentation for c-tab-always-indent
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don <at> donarmstrong.com
immediately.)


-- 
1368: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=1368
Emacs Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Reuben Thomas <rrt <at> sc3d.org>
To: bug-emacs <at> gnu.org
Subject: Confusing documentation for c-tab-always-indent
Date: Tue, 18 Nov 2008 12:48:15 +0100 (CET)
The docstring says:

 Note: The value of `indent-tabs-mode' will determine whether a real
 tab character will be inserted, or the equivalent number of spaces.
 When inserting a tab, actually the function stored in the variable
 `c-insert-tab-function' is called.

But this is not quite true. As far as I can tell from the code, 
indent-tabs-mode is not tested before calling c-insert-tab-function. What 
the documentation seems to mean is that if c-insert-tab-function has its 
default definition, insert-tab, then the first sentence applies. I suggest 
therefore the following paragraph in place of the above:

 The function stored in the variable `c-insert-tab-function' is called
 when a tab is to be inserted.  By default, this function is `insert-tab',
 which uses the value of `indent-tabs-mode' to determine whether a real
 tab character will be inserted, or the equivalent number of spaces.

-- 
http://rrt.sc3d.org/ | fantasize, a.  the largest you can imagine



[Message part 3 (message/rfc822, inline)]
From: Glenn Morris <rgm <at> gnu.org>
To: 1368-done <at> debbugs.gnu.org
Subject: Re: bug#1368: Confusing documentation for c-tab-always-indent
Date: Mon, 01 Dec 2008 22:38:27 -0500
2008-12-02  Glenn Morris  <rgm <at> gnu.org>

  * progmodes/cc-vars.el (c-tab-always-indent, c-insert-tab-function):
  Doc fix.  (Bug#1368)


This bug report was last modified 16 years and 228 days ago.

Previous Next


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