bug#1368: Confusing documentation for c-tab-always-indent

bug#1368: Confusing documentation for c-tab-always-indent

[Reuben Thomas]

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

bug#1368: marked as done (Confusing documentation for c-tab-always-indent)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 872 bytes --]


Your message dated Mon, 01 Dec 2008 22:38:27 -0500
with message-id <d3fxl7w8jw.fsf@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@donarmstrong.com
immediately.)


-- 
1368: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=1368
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 4072 bytes --]

From: Reuben Thomas <rrt@sc3d.org>
To: bug-emacs@gnu.org
Subject: Confusing documentation for c-tab-always-indent
Date: Tue, 18 Nov 2008 12:48:15 +0100 (CET)
Message-ID: <alpine.DEB.2.00.0811181244140.16393@drom>

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




[-- Attachment #3: Type: message/rfc822, Size: 1625 bytes --]

From: Glenn Morris <rgm@gnu.org>
To: 1368-done@emacsbugs.donarmstrong.com
Subject: Re: bug#1368: Confusing documentation for c-tab-always-indent
Date: Mon, 01 Dec 2008 22:38:27 -0500
Message-ID: <d3fxl7w8jw.fsf@fencepost.gnu.org>


2008-12-02  Glenn Morris  <rgm@gnu.org>

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