[Emacs-diffs] trunk r115996: Update EIEIO documentation because of namespace cleanup.

[David Engster]

------------------------------------------------------------
revno: 115996
revision-id: address@hidden
parent: address@hidden
committer: David Engster <address@hidden>
branch nick: trunk
timestamp: Sun 2014-01-12 17:50:54 +0100
message:
  Update EIEIO documentation because of namespace cleanup.
  
  * eieio.texi (Introduction): `class-of' is obsolete.
  (Predicates, Basic Methods): Adapt function names to namespace
  cleanup.
  * NEWS: Add missing renames to EIEIO section.  Also, no functions
  were removed but only made obsolete.  Class field accessors were
  always purely internal, so remove that remark.  Add markup.
modified:
  doc/misc/ChangeLog             changelog-20091113204419-o5vbwnq5f7feedwu-6331
  doc/misc/eieio.texi            
eieio.texi-20091113204419-o5vbwnq5f7feedwu-11397
  etc/ChangeLog                  changelog-20091113204419-o5vbwnq5f7feedwu-1485
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2014-01-12 15:19:07 +0000
+++ b/doc/misc/ChangeLog        2014-01-12 16:50:54 +0000
@@ -4,6 +4,12 @@
        Use "file name" instead of "filename" or "path".  Use "host"
        instead of "machine".
 
+2014-01-12  David Engster  <address@hidden>
+
+       * eieio.texi (Introduction): `class-of' is obsolete.
+       (Predicates, Basic Methods): Adapt function names to namespace
+       cleanup.
+
 2014-01-12  Xue Fuqiao  <address@hidden>
 
        * eww.texi (Basics): Use "directory" instead of "path" (Bug#16419).

=== modified file 'doc/misc/eieio.texi'
--- a/doc/misc/eieio.texi       2014-01-06 05:25:46 +0000
+++ b/doc/misc/eieio.texi       2014-01-12 16:50:54 +0000
@@ -223,10 +223,9 @@
 @item Support for metaclasses
 There is just one default metaclass, @code{eieio-default-superclass},
 and you cannot define your own.  The @code{:metaclass} tag in
address@hidden is ignored.  Also, functions like `class-of' and
-`find-class', which should return instances of the metaclass, behave
-differently in @eieio{} in that they return symbols or plain structures
-instead.
address@hidden is ignored.  Also, functions like `find-class', which
+should return instances of the metaclass, behave differently in
address@hidden in that they return symbols or plain structures instead.
 
 @item EQL specialization
 EIEIO does not support it.
@@ -1065,7 +1064,7 @@
 @var{object} can be an instance or a class.
 @end defun
 
address@hidden class-name class
address@hidden eieio-class-name class
 Return a string of the form @samp{#<class myclassname>} which should look
 similar to other Lisp objects like buffers and processes.  Printing a
 class results only in a symbol.
@@ -1089,7 +1088,7 @@
 without knowing what it is.  This is not a part of CLOS.
 @end defun
 
address@hidden object-name obj
address@hidden eieio-object-name obj
 Return a string of the form @samp{#<object-class myobjname>} for @var{obj}.
 This should look like Lisp symbols from other parts of Emacs such as
 buffers and processes, and is shorter and cleaner than printing the
@@ -1098,43 +1097,39 @@
 information into the symbol.
 @end defun
 
address@hidden object-class obj
address@hidden eieio-object-class obj
 Returns the class symbol from @var{obj}.
 @end defun
 
address@hidden class-of obj
-CLOS symbol which does the same thing as @code{object-class}
address@hidden defun
-
address@hidden object-class-fast obj
-Same as @code{object-class} except this is a macro, and no
address@hidden eieio--object-class obj
+Same as @code{eieio-object-class} except this is a macro, and no
 type-checking is performed.
 @end defun
 
address@hidden object-class-name obj
address@hidden eieio-object-class-name obj
 Returns the symbol of @var{obj}'s class.
 @end defun
 
address@hidden class-parents class
address@hidden eieio-class-parents class
 Returns the direct parents class of @var{class}.  Returns @code{nil} if
 it is a superclass.
 @end defun
 
address@hidden class-parents-fast class
-Just like @code{class-parent} except it is a macro and no type checking
address@hidden eieio-class-parents-fast class
+Just like @code{eieio-class-parents} except it is a macro and no type checking
 is performed.
 @end defun
 
address@hidden class-parent class
address@hidden eieio-class-parent class
 Deprecated function which returns the first parent of @var{class}.
 @end defun
 
address@hidden class-children class
address@hidden eieio-class-children class
 Return the list of classes inheriting from @var{class}.
 @end defun
 
address@hidden class-children-fast class
-Just like @code{class-children}, but with no checks.
address@hidden eieio-class-children-fast class
+Just like @code{eieio-class-children}, but with no checks.
 @end defun
 
 @defun same-class-p obj class
@@ -1676,9 +1671,9 @@
 
 @defun object-print this &rest strings
 @anchor{object-print}
-Pretty printer for object @var{this}.  Call function @dfn{object-name} with 
@var{strings}.
+Pretty printer for object @var{this}.  Call function @dfn{eieio-object-name} 
with @var{strings}.
 The default method for printing object @var{this} is to use the
-function @dfn{object-name}.
+function @dfn{eieio-object-name}.
 
 It is sometimes useful to put a summary of the object into the
 default #<notation> string when using eieio browsing tools.

=== modified file 'etc/ChangeLog'
--- a/etc/ChangeLog     2014-01-12 01:35:51 +0000
+++ b/etc/ChangeLog     2014-01-12 16:50:54 +0000
@@ -1,3 +1,9 @@
+2014-01-12  David Engster  <address@hidden>
+
+       * NEWS: Add missing renames to EIEIO section.  Also, no functions
+       were removed but only made obsolete.  Class field accessors were
+       always purely internal, so remove that remark.  Add markup.
+
 2014-01-11  Eric S. Raymond  <address@hidden>
 
        * celibacy.1, sex.6, condom.1, echo.msg: Deleted at RMS's

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-01-12 01:28:40 +0000
+++ b/etc/NEWS  2014-01-12 16:50:54 +0000
@@ -1230,25 +1230,25 @@
 
 ** EIEIO
 
++++
 *** Namespace cleanup by obsolete-aliasing functions to use `eieio-' prefix.
 **** object-name -> eieio-object-name
 **** object-class -> eieio-object-class
 **** object-class-fast -> eieio--object-class
+**** object-class-name -> eieio-object-class-name
 **** object-name-string -> eieio-object-name-string
 **** object-num-slots -> eieio--object-num-slots
 **** object-set-name-string -> eieio-object-set-name-string
+**** class-of -> eieio-object-class
+**** class-name -> eieio-class-name
 **** class-parent -> eieio-class-parent
 **** class-parents -> eieio-class-parents
+**** class-parents-fast -> eieio-class-parents-fast
 **** class-children -> eieio-class-children
 **** class-num-slots -> eieio--class-num-slots
 **** class-precedence-list -> eieio-class-precedence-list
-**** All generated class-* and object-* field accessors are now
-prefixed with `eieio-' as well.
-
-*** Obsoleted functions:
-**** class-of
-**** class-direct-subclasses
-**** class-direct-superclasses
+**** class-direct-subclasses -> eieio-class-children
+**** class-direct-superclasses -> eieio-class-parents
 
 ** Changes in encoding and decoding of text