GNOME.org
 

Re: [gnome-love] Enhancement of the gnome-search-tool

On Fri, 2009-12-11 at 14:09 -0600, Shaun McCance wrote:

The Overview has, unfortunately, not been updated much
since I initially wrote it.  It's definitely due for an
overhaul, especially for Gnome 3.  I've been doing some
planning, but it hasn't hit the top of my todo list yet.


So for the time being, let's warn users about deprecations and outdated
parts at least. Patch attached. Okay to commit?

andre

-- 
 mailto:ak-47 gmx net | failed
 http://www.iomc.de/  | http://blogs.gnome.org/aklapper

From 05fcaf83dcf0d1d1919a1299ac75f93b5f1f87ab Mon Sep 17 00:00:00 2001

From: Andre Klapper <a9016009 gmx de>
Date: Sat, 12 Dec 2009 00:39:57 +0100
Subject: [PATCH] Mention deprecations plus minor updates.

---
 platform-overview/C/apx-modules.xml      |   48 +++++++++++++++++------------
 platform-overview/C/bindings.xml         |    2 +-
 platform-overview/C/core-tech.xml        |   19 +++++++----
 platform-overview/C/desktop-tech.xml     |   11 +++++++
 platform-overview/C/figures/graphics.svg |    2 +-
 platform-overview/C/intro.xml            |    4 +-
 platform-overview/C/ipc-network.xml      |    5 ++-
 platform-overview/C/platform.xml         |    5 ++-
 8 files changed, 62 insertions(+), 34 deletions(-)

diff --git a/platform-overview/C/apx-modules.xml b/platform-overview/C/apx-modules.xml
index 50da0b3..a9038d2 100644
--- a/platform-overview/C/apx-modules.xml
+++ b/platform-overview/C/apx-modules.xml
@@ -25,8 +25,8 @@
     </varlistentry>
     <varlistentry>
       <term>ORBit</term>
-      <listitem><para>ORBit is a fast and lightweight CORBA server.  GNOME's
-      component architecture, Bonobo, is built on top of CORBA.  CORBA is
+      <listitem><para>ORBit is a deprecated CORBA server.  GNOME's deprecated
+      omponent architecture, Bonobo, is built on top of CORBA.  CORBA is
       discussed in <xref linkend="bonobo-corba"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
@@ -41,8 +41,8 @@
       <term>gail</term>
       <listitem><para>GAIL provides an implementation of the ATK interfaces for
       GTK+ and GNOME libraries, allowing accessibility tools to interact with
-      applications written using these libraries.  Accessibility is discussed
-      in <xref linkend="a11y"/>.</para></listitem>
+      applications written using these libraries.  In 2009 GAIL was moved into
+      GTK+.  Accessibility is discussed in <xref linkend="a11y"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>gio</term>
@@ -81,39 +81,43 @@
     </varlistentry>
     <varlistentry>
       <term>libIDL</term>
-      <listitem><para>libIDL is a library for parsing Interface Definition
+      <listitem><para>libIDL is a deprecated library for parsing Interface Definition
       Language (IDL) files, which are necessary for CORBA interfaces.  libIDL
-      is used by GNOME's CORBA implementation, ORBit.  CORBA is discussed in
+      is used by GNOME's deprecated CORBA implementation, ORBit.  CORBA is discussed in
       <xref linkend="bonobo-corba"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libart_lgpl</term>
-      <listitem><para>libart is a graphics library which can render vector
-      paths.  It is used by the GnomeCanvas widget.</para></listitem>
+      <listitem><para>libart is a deprecated graphics library which can render 
+      vector paths.  It is used by the GnomeCanvas widget.  Newly written code
+      should not use libart_lgpl and instead use Cairo and/or other 
+      technologies.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libbonobo</term>
-      <listitem><para>Bonobo is a framework for creating reusable components
+      <listitem><para>Bonobo is a deprecated framework for creating reusable components
       for use in GNOME applications, built on top of CORBA.  Bonobo is
       discussed in <xref linkend="bonobo-corba"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libbonoboui</term>
-      <listitem><para>The Bonobo UI library provides a number of user interface
+      <listitem><para>The deprecated Bonobo UI library provides a number of user interface
       controls using the Bonobo component framework.  Bonobo is discussed in
       <xref linkend="bonobo-corba"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libglade</term>
-      <listitem><para>Libglade is a library for constructing user interfaces
-      dynamically from XML descriptions.  Libglade allow programmers to
+      <listitem><para>Libglade is a deprecated library for constructing user interfaces
+      dynamically from XML descriptions. Libglade has been deprecated in favor
+      of <ulink url="http://library.gnome.org/devel/gtk/stable/GtkBuilder.html";>GtkBuilder</ulink>.
+      Libglade allowed programmers to
       construct their user interfaces using a graphical interface builder
       application, and then import those interface definitions.  Libglade
       is discussed in <xref linkend="libglade"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libgnome</term>
-      <listitem><para>The libgnome library provides a number of useful routines
+      <listitem><para>The deprecated libgnome library provides a number of useful routines
       for building modern applications, including session management, activation
       of files and URIs, and displaying help.</para></listitem>
     </varlistentry>
@@ -124,7 +128,7 @@
     </varlistentry>
     <varlistentry>
       <term>libgnomeui</term>
-      <listitem><para>The libgnomeui library provides additional widgets for
+      <listitem><para>The deprecated libgnomeui library provides additional widgets for
       applications.  Many of the widgets from libgnomeui have already been
       ported to GTK+.</para></listitem>
     </varlistentry>
@@ -217,16 +221,20 @@
     </varlistentry>
     <varlistentry>
       <term>libgnomeprint</term>
-      <listitem><para>The libgnomeprint library provides an implementation of
-      the PostScript imaging model and can be used to create high-quality
-      print renderings.  The GNOME print framework is discussed in <xref
+      <listitem><para>libgnomeprint is a deprecated library that provided an 
+      implementation of the PostScript imaging model.  It is superseded by <ulink
+      url="http://library.gnome.org/devel/gtk/stable/Printing.html";>GtkPrint</ulink>.
+      Newly written code should use GtkPrint instead.
+      The GNOME print framework is discussed in <xref
       linkend="gnomeprint"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
       <term>libgnomeprintui</term>
-      <listitem><para>The libgnomeprintui library provides a standard print
-      dialog, a print preview dialog, and various other controls required for
-      printing.  The GNOME print framework is discussed in <xref
+      <listitem><para>libgnomeprintui is a deprecated library that provided a 
+      standard print dialog, a print preview dialog, and various other controls 
+      required for printing.  It is superseded by <ulink
+      url="http://library.gnome.org/devel/gtk/stable/Printing.html";>GtkPrint</ulink>.
+      The GNOME print framework is discussed in <xref
       linkend="gnomeprint"/>.</para></listitem>
     </varlistentry>
     <varlistentry>
diff --git a/platform-overview/C/bindings.xml b/platform-overview/C/bindings.xml
index 553d9ef..d05f00d 100644
--- a/platform-overview/C/bindings.xml
+++ b/platform-overview/C/bindings.xml
@@ -14,7 +14,7 @@
 <section id="cpp">
   <title>C++</title>
   <para>The C++ bindings provide complete coverage of the GNOME platform,
-  including GTK+, Glade, and GConf.  The C++ bindings wrap all objects with
+  including GTK+, Libglade, and GConf.  The C++ bindings wrap all objects with
   native C++ objects and allow programmers to provide custom widgets with
   normal C++ inheritence.  They provide a fully native API, with type-safe
   signal handlers, full use of the standard C++ library, and complete C++
diff --git a/platform-overview/C/core-tech.xml b/platform-overview/C/core-tech.xml
index 3cd84bc..f4bd52c 100644
--- a/platform-overview/C/core-tech.xml
+++ b/platform-overview/C/core-tech.xml
@@ -67,6 +67,10 @@
 
   <section id="libglade">
     <title>Libglade</title>
+    <note><para><note><para>Note that Libglade has been deprecated in favor of
+    <ulink url="http://library.gnome.org/devel/gtk/stable/GtkBuilder.html";>GtkBuilder</ulink>.
+    Newly written code should use GtkBuilder instead.</para></note></para></note>
+
     <para>Libglade is a library for constructing user interfaces dynamically
     from XML descriptions.  You can use a graphical interface builder like
     <application>Glade</application> to construct your user interface,
@@ -481,6 +485,14 @@
   <section id="gnomeprint">
     <title>GNOME Print</title>
 
+    <note><para>Note that this section is outdated and that libgnomeprint and
+    libgnomeprintui have been deprecated in favor of <ulink
+    url="http://library.gnome.org/devel/gtk/stable/Printing.html";>GtkPrint</ulink>.
+    Printing has been integrated directly into GTK+ 2.10 and later versions,
+    providing a cross-platform print API that all applications can use.
+    API and ABI stability guarantees ensures that Gnomeprint will continue to
+    be functional and supported throughout the GNOME 2 lifecycle.</para></note>
+
     <para>The GNOME print framework consists of two libraries which help
     you provide high-quality printing with a consistent interface in your
     application.  At the core of the printing framework is libgnomeprint,
@@ -488,13 +500,6 @@
     of that is libgnomeprintui, which provides standard print controls for
     your user interface.</para>
 
-    <note><para>Work is currently underway to integrate printing directly
-    into GTK+, providing a cross-platform print API that all applications
-    can use.  While the current GNOME print framework will be deprecated
-    once GTK+ supports printing, API and ABI stability guarantees ensures
-    that it will continue to be functional and supported throughout the
-    GNOME 2 lifecycle.</para></note>
-
     <para>The libgnomeprint library implements the PostScript imaging model,
     which is used by most printers.  Printers which do not support PostScript
     can still be supported through CUPS, described below.  In addition to the
diff --git a/platform-overview/C/desktop-tech.xml b/platform-overview/C/desktop-tech.xml
index b657f14..5e6130b 100644
--- a/platform-overview/C/desktop-tech.xml
+++ b/platform-overview/C/desktop-tech.xml
@@ -77,6 +77,9 @@
   context menu items to display a detailed report and to update the displayed
   information.</para>
 
+  <note><para>Note that Bonobo has been deprecated in favor of D-Bus and other
+  technologies.</para></note>
+
   <para>For more information on panel applets, see the
   <ulink url="http://library.gnome.org/devel/panel-applet/stable/";>Panel
   Applet Library</ulink>.</para>
@@ -255,6 +258,14 @@
   functionality, your application must connect to the session manager and
   save its state when the user logs out.</para>
 
+  <note><para>Note that this section is outdated as GnomeClient and 
+  Libgnomeui are deprecated. Newly written code should use <ulink 
+  url="http://live.gnome.org/SessionManagement/EggSMClient";>EggSMClient</ulink>
+  instead. Work is currently underway to integrate EggSMClient directly into
+  GTK+. API and ABI stability guarantees ensures that GnomeClient will
+  continue to be functional and supported throughout the GNOME 2 lifecycle.
+  </para></note>
+
   <para>GNOME provides a simple API for session management in the GNOME User
   Interface Library.  See the section <ulink
   url="http://library.gnome.org/devel/libgnomeui/stable/GnomeClient.html";>GnomeClient</ulink>
diff --git a/platform-overview/C/figures/graphics.svg b/platform-overview/C/figures/graphics.svg
index 753d428..27b2bb5 100644
--- a/platform-overview/C/figures/graphics.svg
+++ b/platform-overview/C/figures/graphics.svg
@@ -278,7 +278,7 @@
          id="tspan2164"
          x="19.937996"
          y="34.067631"
-         style="font-size:16px">Glade and other UI libraries</tspan></text>
+         style="font-size:16px">Libglade and other UI libraries</tspan></text>
     <rect
        
style="opacity:1;fill:url(#linearGradient22645);fill-opacity:1.0;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
        id="rect2166"
diff --git a/platform-overview/C/intro.xml b/platform-overview/C/intro.xml
index feb0807..b1ef355 100644
--- a/platform-overview/C/intro.xml
+++ b/platform-overview/C/intro.xml
@@ -92,8 +92,8 @@
       full archives of all GNOME mailing lists.</para></listitem>
     </varlistentry>
     <varlistentry>
-      <term><ulink url="http://svn.gnome.org/";>svn.gnome.org</ulink></term>
-      <listitem><para>The GNOME Subversion repository, tracking all GNOME source code
+      <term><ulink url="http://git.gnome.org/";>git.gnome.org</ulink></term>
+      <listitem><para>The GNOME Git repository, tracking all GNOME source code
       back to the inception of the project.</para></listitem>
     </varlistentry>
   </variablelist>
diff --git a/platform-overview/C/ipc-network.xml b/platform-overview/C/ipc-network.xml
index d4328dd..684ab6d 100644
--- a/platform-overview/C/ipc-network.xml
+++ b/platform-overview/C/ipc-network.xml
@@ -96,6 +96,9 @@
 <section id="bonobo-corba">
   <title>Bonobo and CORBA</title>
 
+  <note><para>Note that Bonobo, libIDL and ORBit have been deprecated in 
+  favor of D-Bus and other technologies. See above.</para></note>
+
   <para>Bonobo is a framework for creating reusable components for use
   in applications.  Built on top of the industry-standard Common Object
   Request Broker Architecture (CORBA), Bonobo provides all the common
@@ -111,7 +114,7 @@
   to communicate effectively with the panel, affording users a consistent
   interface.</para>
 
-  <para>Bonobo components are not limited to graphical controls.  Bonobo is
+  <para>Bonobo components are not limited to graphical controls.  Bonobo was
   used by Evolution, GNOME's email and groupware suite, to provide access
   to users' addressbook and calendar.  This allows users to keep all their
   information in one place, where all applications can access it.</para>
diff --git a/platform-overview/C/platform.xml b/platform-overview/C/platform.xml
index 0c7c1c9..75b7051 100644
--- a/platform-overview/C/platform.xml
+++ b/platform-overview/C/platform.xml
@@ -65,8 +65,9 @@
 
     <para>GNOME features the Bonobo component system, built on top of CORBA.
     Bonobo allows programmers to create complex embeddable components which
-    can be reused inside other programs.  Bonobo is discussed in <xref
-    linkend="bonobo-corba"/>.</para>
+    can be reused inside other programs.  Note that Bonobo has been deprecated.
+    Newly written code should use D-Bus and other technologies instead.  Bonobo
+    is discussed in <xref linkend="bonobo-corba"/>.</para>
 
     <para>To make networks more manageable for users, GNOME supports DNS
     Service Discovery.  DNS Service Discovery enables applications to find
-- 
1.6.5.2
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]