[Emacs-diffs] trunk r116352: Doc for subword, superword modes

[Glenn Morris]

------------------------------------------------------------
revno: 116352
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Sat 2014-02-08 18:08:17 -0800
message:
  Doc for subword, superword modes
  
  * doc/emacs/programs.texi (MixedCase Words): Rename node from "Glasses".
  Move Subword mode here from "Other C Commands" node.
  (Misc for Programs): Mention Superword mode.
  
  * doc/emacs/emacs.texi: Update menu.
  
  * etc/NEWS: Related markup.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/emacs.texi           emacs.texi-20091113204419-o5vbwnq5f7feedwu-6246
  doc/emacs/programs.texi        
programs.texi-20091113204419-o5vbwnq5f7feedwu-6272
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-02-08 13:04:39 +0000
+++ b/doc/emacs/ChangeLog       2014-02-09 02:08:17 +0000
@@ -1,3 +1,10 @@
+2014-02-09  Glenn Morris  <address@hidden>
+
+       * programs.texi (MixedCase Words): Rename node from "Glasses".
+       Move Subword mode here from "Other C Commands" node.
+       (Misc for Programs): Mention Superword mode.
+       * emacs.texi: Update menu.
+
 2014-02-08  Lars Ingebrigtsen  <address@hidden>
 
        * regs.texi (File Registers): Clarify metasyntactical variables

=== modified file 'doc/emacs/emacs.texi'
--- a/doc/emacs/emacs.texi      2014-01-13 22:21:32 +0000
+++ b/doc/emacs/emacs.texi      2014-02-09 02:08:17 +0000
@@ -668,7 +668,7 @@
 * Documentation::       Getting documentation of functions you plan to call.
 * Hideshow::            Displaying blocks selectively.
 * Symbol Completion::   Completion on symbol names of your program or language.
-* Glasses::             Making identifiersLikeThis more readable.
+* MixedCase Words::     Dealing with identifiersLikeThis.
 * Semantic::            Suite of editing tools based on source code parsing.
 * Misc for Programs::   Other Emacs features useful for editing programs.
 * C Modes::             Special commands of C, C++, Objective-C,

=== modified file 'doc/emacs/programs.texi'
--- a/doc/emacs/programs.texi   2014-01-26 03:39:34 +0000
+++ b/doc/emacs/programs.texi   2014-02-09 02:08:17 +0000
@@ -1,3 +1,4 @@
address@hidden -*- coding: utf-8 -*-
 @c This is part of the Emacs manual.
 @c Copyright (C) 1985-1987, 1993-1995, 1997, 1999-2014 Free Software
 @c Foundation, Inc.
@@ -35,7 +36,7 @@
 * Documentation::       Getting documentation of functions you plan to call.
 * Hideshow::            Displaying blocks selectively.
 * Symbol Completion::   Completion on symbol names of your program or language.
-* Glasses::             Making identifiersLikeThis more readable.
+* MixedCase Words::     Dealing with identifiersLikeThis.
 * Semantic::            Suite of editing tools based on source code parsing.
 * Misc for Programs::   Other Emacs features useful for editing programs.
 * C Modes::             Special commands of C, C++, Objective-C, Java,
@@ -1335,24 +1336,37 @@
   In Text mode and related modes, @address@hidden completes words
 based on the spell-checker's dictionary.  @xref{Spelling}.
 
address@hidden Glasses
address@hidden Glasses minor mode
address@hidden MixedCase Words
address@hidden MixedCase Words
address@hidden camel case
+
+  Some programming styles make use of mixed-case (or ``CamelCase'')
+symbols like @samp{unReadableSymbol}.  (In the GNU project, we recommend
+using underscores to separate words within an identifier, rather than
+using case distinctions.)  Emacs has various features to make it easier
+to deal with such symbols.
+
 @cindex Glasses mode
address@hidden camel case
 @findex mode, Glasses
-
-  Glasses mode is a buffer-local minor mode that makes it easier to
-read mixed-case (or ``CamelCase'') symbols like
address@hidden, by altering how they are displayed.  By
-default, it displays extra underscores between each lower-case letter
-and the following capital letter.  This does not alter the buffer
-text, only how it is displayed.
+  Glasses mode is a buffer-local minor mode that makes it easier to read
+such symbols, by altering how they are displayed.  By default, it
+displays extra underscores between each lower-case letter and the
+following capital letter.  This does not alter the buffer text, only how
+it is displayed.
 
   To toggle Glasses mode, type @kbd{M-x glasses-mode} (@pxref{Minor
 Modes}).  When Glasses mode is enabled, the minor mode indicator
 @samp{o^o} appears in the mode line.  For more information about
 Glasses mode, type @kbd{C-h P glasses @key{RET}}.
 
address@hidden Subword mode
address@hidden subword-mode
+  Subword mode is another buffer-local minor mode.  In subword mode,
+Emacs's word commands recognize upper case letters in
address@hidden as word boundaries.  When Subword mode is
+enabled, the minor mode indicator @samp{,} appears in the mode line.
+See also the similar @code{superword-mode} (@pxref{Misc for Programs}).
+
 @node Semantic
 @section Semantic
 @cindex Semantic package
@@ -1438,6 +1452,19 @@
 programming language major mode, indents the new lines which it
 creates.
 
address@hidden superword-mode
+ Superword mode is a buffer-local minor mode that causes editing and
+motion commands to treat symbols (e.g., @samp{this_is_a_symbol}) as words.
+When Subword mode is enabled, the minor mode indicator
address@hidden
address@hidden@math{^2}}
address@hidden iftex
address@hidden
address@hidden
address@hidden ifnottex
+appears in the mode line.  See also the similar @code{subword-mode}
+(@pxref{MixedCase Words}).
+
 @findex electric-layout-mode
   Electric Layout mode (@kbd{M-x electric-layout-mode}) is a global
 minor mode that automatically inserts newlines when you type certain
@@ -1650,19 +1677,6 @@
 @subsection Other Commands for C Mode
 
 @table @kbd
address@hidden C-c C-w
address@hidden M-x subword-mode
address@hidden subword-mode
-Enable (or disable) @dfn{subword mode}.  In subword mode, Emacs's word
-commands recognize upper case letters in
address@hidden as word boundaries.  This is indicated by
-the flag @samp{/w} on the mode line after the mode name
-(e.g., @samp{C/law}).  You can even use @kbd{M-x subword-mode} in
-non-CC Mode buffers.
-
-In the GNU project, we recommend using underscores to separate words
-within an identifier in C or C++, rather than using case distinctions.
-
 @item M-x c-context-line-break
 @findex c-context-line-break
 This command inserts a line break and indents the new line in a manner

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-02-07 07:18:02 +0000
+++ b/etc/NEWS  2014-02-09 02:08:17 +0000
@@ -937,6 +937,7 @@
 ** New package `eww' is a built-in web browser.
 It is only available if Emacs is compiled with libxml2 support.
 
++++
 ** New minor mode `superword-mode'.
 This overrides the default word motion commands to treat "symbol_words"
 as a single word, similar to what `subword-mode' does.