[Erp5-report] r42663 nicolas - in /erp5/trunk/utils/erp5diff: CHANGES.txt README setup.py

[nobody at svn.erp5.org]

Author: nicolas
Date: Tue Jan 25 16:35:24 2011
New Revision: 42663

URL: http://svn.erp5.org?rev=42663&view=rev
Log:
Bug fix release (add missing egg's namespace declaration)
improve README

Modified:
    erp5/trunk/utils/erp5diff/CHANGES.txt
    erp5/trunk/utils/erp5diff/README
    erp5/trunk/utils/erp5diff/setup.py

Modified: erp5/trunk/utils/erp5diff/CHANGES.txt
URL: http://svn.erp5.org/erp5/trunk/utils/erp5diff/CHANGES.txt?rev=42663&r1=42662&r2=42663&view=diff
==============================================================================
--- erp5/trunk/utils/erp5diff/CHANGES.txt [utf8] (original)
+++ erp5/trunk/utils/erp5diff/CHANGES.txt [utf8] Tue Jan 25 16:35:24 2011
@@ -1,21 +1,26 @@
-0.8.1.3 (unreleased)
-------------------
+0.8.1.4 (unreleased)
+--------------------
+
+0.8.1.3 (2011/01/25)
+--------------------
+ * add long_description, improve README
+ * add missing namespace declaration of egg
 
 0.8.1.2 (2011/01/25)
-------------------
+--------------------
  * [fix] installation of egg
 
 0.8.1.1 (2011/01/25)
-------------------
+--------------------
  * [Fix] position starts to 1
   [Nicolas Delaby]
 
 version 0.8.1 Nicolas Delaby
-==========================
+============================
 Bug Fix
 --------
 * Some nodes stay orphans if they are replaced by another one and followed
-by a modification (test 30)
+  by a modification (test 30)
 * Exclude comments or processing instruction as sibling node
 
 version 0.8 Nicolas Delaby

Modified: erp5/trunk/utils/erp5diff/README
URL: http://svn.erp5.org/erp5/trunk/utils/erp5diff/README?rev=42663&r1=42662&r2=42663&view=diff
==============================================================================
--- erp5/trunk/utils/erp5diff/README [utf8] (original)
+++ erp5/trunk/utils/erp5diff/README [utf8] Tue Jan 25 16:35:24 2011
@@ -1,16 +1,69 @@
-This is a XUpdate Generator for ERP5.
+Introduction
+============
+This is a XUpdate Generator to compare any XML document.
 
 See <http://xmldb-org.sourceforge.net/xupdate/> for information on
 XUpdate.
 
-See <http://erp5.org/> for information on ERP5.
+Installation
+============
+python setup install
+
+Test
+====
+python setup test
+
+Usage
+=====
+Once you have installed erp5diff, you can use "erp5diff" in a shell::
+
+  erp5diff old.xml new.xml
+
+
+Or in a python console::
+
+  from ERP5Diff import ERP5Diff
+  erp5diff = ERP5Diff()
+  old_xml = """
+  <ul>
+    <li>1</li>
+    <li>2</li>
+    <li>3</li>
+    <li>4</li>
+    <li>5</li>
+    <li>6</li>
+    <li>7</li>
+    <li>8</li>
+    <li>9</li>
+  </ul>
+  """
+  new_xml = """
+  <ul>
+    <li>5</li>
+    <li>6</li>
+    <li>1</li>
+    <li>2</li>
+    <li>3</li>
+    <li>4</li>
+    <li>7</li>
+    <li>8</li>
+    <li>9</li>
+  </ul>
+  """
+  erp5diff.compare(old_xml, new_xml)
+  erp5diff.output()
+  <xupdate:modifications xmlns:xupdate="http://www.xmldb.org/xupdate" version="1.0">
+    <xupdate:remove select="/ul/li[5]"/>
+    <xupdate:remove select="/ul/li[6]"/>
+    <xupdate:append child="first()">
+      <xupdate:element name="li">5</xupdate:element>
+      <xupdate:element name="li">6</xupdate:element>
+    </xupdate:append>
+  </xupdate:modifications>
 
-For the installation, do "python setup.py install".
 
-Once you have installed erp5diff, you can use "erp5diff" in a shell:
-$ erp5diff old.xml new.xml
-See the manpage erp5diff(1) or "erp5diff --help" for more information.
 
 
 - 2003-12-04, Yoshinori OKUJI <yo at nexedi.com>
 - 2009-09-15, Tatuya Kamada <tatuya at nexedi.com>
+- 2009-2011, Nicolas Delaby <nicolas at nexedi.com>

Modified: erp5/trunk/utils/erp5diff/setup.py
URL: http://svn.erp5.org/erp5/trunk/utils/erp5diff/setup.py?rev=42663&r1=42662&r2=42663&view=diff
==============================================================================
--- erp5/trunk/utils/erp5diff/setup.py [utf8] (original)
+++ erp5/trunk/utils/erp5diff/setup.py [utf8] Tue Jan 25 16:35:24 2011
@@ -9,10 +9,19 @@ api_version = re.search(r'\s*__version__
 revision = 3
 version = '%s.%s' % (api_version.replace("'", ''), revision)
 
+def read(name):
+  return open(name).read()
+
+long_description=(
+        read('README')
+        + '\n' +
+        read('CHANGES.txt')
+    )
 
 setup(name="erp5diff",
       version=version,
       description="XUpdate Generator for ERP5",
+      long_description=long_description,
       author="Yoshinori OKUJI",
       author_email="yo at nexedi.com",
       url="http://www.erp5.org/",