[Python-modules-commits] r21692 - in packages/python-docutils/trunk/debian (4 files)

jwilk at users.alioth.debian.org jwilk at users.alioth.debian.org
Thu May 10 20:49:33 UTC 2012


    Date: Thursday, May 10, 2012 @ 20:49:32
  Author: jwilk
Revision: 21692

Rename 10_doc_debian_paths.diff to doc-debian-paths.diff; update the patch header.

Added:
  packages/python-docutils/trunk/debian/patches/doc-debian-paths.diff
    (from rev 21604, packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff)
Modified:
  packages/python-docutils/trunk/debian/changelog
  packages/python-docutils/trunk/debian/patches/series
Deleted:
  packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff

Modified: packages/python-docutils/trunk/debian/changelog
===================================================================
--- packages/python-docutils/trunk/debian/changelog	2012-05-10 20:49:16 UTC (rev 21691)
+++ packages/python-docutils/trunk/debian/changelog	2012-05-10 20:49:32 UTC (rev 21692)
@@ -17,8 +17,10 @@
   * Update move-data-to-usr-share.diff to cover the test/ directory, too.
   * Add DEP-8 tests.
   * Fix (Python 2 version of) rst-buildhtml shebang to #!/usr/bin/python.
+  * Rename 10_doc_debian_paths.diff to doc-debian-paths.diff; update the patch
+    header.
 
- -- Jakub Wilk <jwilk at debian.org>  Thu, 10 May 2012 21:58:18 +0200
+ -- Jakub Wilk <jwilk at debian.org>  Thu, 10 May 2012 22:49:07 +0200
 
 python-docutils (0.8.1-6) unstable; urgency=low
 

Deleted: packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff
===================================================================
--- packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff	2012-05-10 20:49:16 UTC (rev 21691)
+++ packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff	2012-05-10 20:49:32 UTC (rev 21692)
@@ -1,213 +0,0 @@
-From: Simon McVittie <smcv at debian.org>
-Date: Sun, 6 Dec 2009 23:42:17 +0000
-Subject: [PATCH] Change paths in documentation to match Debian's
-
-Debian policy recommends not having extensions like .py on script names,
-and buildhtml seems too generic a name.
----
- README.txt          |   21 +++++++++++++++++++--
- docs/user/emacs.txt |    3 +++
- docs/user/tools.txt |   37 ++++++++++++++++++++++++++++++-------
- 3 files changed, 52 insertions(+), 9 deletions(-)
-
---- a/README.txt
-+++ b/README.txt
-@@ -11,8 +11,19 @@
- .. contents::
- 
- 
--Quick-Start
--===========
-+Quick-Start on Debian systems
-+=============================
-+
-+The reStructuredText tools are installed in the normal system path by the
-+Debian ``python-docutils`` package. To convert reStructuredText to another
-+format, use a shell command like::
-+
-+       rst2html /usr/share/doc/python-docutils/FAQ.txt ./FAQ.html
-+
-+See Usage_ below for details.
-+
-+Quick-Start on other systems
-+============================
- 
- This is for those who want to get up & running quickly.  Read on for
- complete details.
-@@ -287,6 +298,12 @@
- the front-end tools for details on options and arguments.  See
- Docutils Front-End Tools (``docs/user/tools.txt``) for full documentation.
- 
-+On a Debian system the included tools (with the exception of quicktest.py
-+and the development tools in the dev/ directory) are installed into the
-+normal system path, so you can run ``rst2html.py`` with a command like::
-+
-+    rst2html example.txt example.html
-+
- The package modules are continually growing and evolving.  The
- ``docutils.statemachine`` module is usable independently.  It contains
- extensive inline documentation (in reStructuredText format of course).
---- a/docs/user/emacs.txt
-+++ b/docs/user/emacs.txt
-@@ -120,6 +120,9 @@
- 
-   (add-hook 'rst-adjust-hook 'rst-toc-update)
- 
-+The Debian ``python-docutils`` package automatically sets up a suitable
-+configuration.
-+
- Additional configuration variables can be customized and can be found
- by browsing the source code for ``rst.el``.
- 
---- a/docs/user/tools.txt
-+++ b/docs/user/tools.txt
-@@ -39,6 +39,10 @@
- used for the destination.  If no arguments are specified, the standard
- input (stdin) is used for the source as well.
- 
-+In Debian these tools are installed in the normal system path, without the
-+``.py`` extension, according to Debian policy. 
-+buildhtml.py_ is installed as rst-buildhtml.
-+
- 
- Getting Help
- ============
-@@ -66,13 +70,15 @@
- :Parser: reStructuredText
- :Writers: HTML, PEP/HTML
- 
-+In Debian this tool is installed under the name rst-buildhtml.
-+
- Use ``buildhtml.py`` to generate .html from all the .txt files
- (including PEPs) in each <directory> given, and their subdirectories
- too.  (Use the ``--local`` option to skip subdirectories.)
- 
- Usage::
- 
--    buildhtml.py [options] [<directory> ...]
-+    rst-buildhtml [options] [<directory> ...]
- 
- After unpacking the Docutils package, the following shell commands
- will generate HTML for all included documentation::
-@@ -103,6 +109,8 @@
- :Parser: reStructuredText
- :Writer: HTML
- 
-+In Debian this front end is installed as rst2html.
-+
- The ``rst2html.py`` front end reads standalone reStructuredText source
- files and produces HTML 4 (XHTML 1) output compatible with modern
- browsers that support cascading stylesheets (CSS).  A stylesheet is
-@@ -112,13 +120,13 @@
- For example, to process a reStructuredText file "``test.txt``" into
- HTML::
- 
--    rst2html.py test.txt test.html
-+    rst2html test.txt test.html
- 
- Now open the "``test.html``" file in your favorite browser to see the
- results.  To get a footer with a link to the source file, date & time
- of processing, and links to the Docutils project, add some options::
- 
--    rst2html.py -stg test.txt test.html
-+    rst2html -stg test.txt test.html
- 
- 
- Stylesheets
-@@ -146,6 +154,8 @@
- :Parser: reStructuredText
- :Writer: PEP/HTML
- 
-+In Debian this front end is installed as rstpep2html.
-+
- ``rstpep2html.py`` reads a new-style PEP (marked up with
- reStructuredText) and produces HTML.  It requires a template file and
- a stylesheet.  By default, it makes use of a "``pep-html-template``"
-@@ -156,7 +166,7 @@
- For example, to process a PEP into HTML::
- 
-     cd <path-to-docutils>/docs/peps
--    rstpep2html.py pep-0287.txt pep-0287.html
-+    rstpep2html pep-0287.txt pep-0287.html
- 
- 
- rst2s5.py
-@@ -166,6 +176,8 @@
- :Parser: reStructuredText
- :Writer: S5/HTML
- 
-+In Debian this is installed as rst2s5.
-+
- The ``rst2s5.py`` front end reads standalone reStructuredText source
- files and produces (X)HTML output compatible with S5_, the "Simple
- Standards-based Slide Show System" by Eric Meyer.  A theme is required
-@@ -175,7 +187,7 @@
- For example, to process a reStructuredText file "``slides.txt``" into
- S5/HTML::
- 
--    rst2s5.py slides.txt slides.html
-+    rst2s5 slides.txt slides.html
- 
- Now open the "``slides.html``" file in your favorite browser, switch
- to full-screen mode, and enjoy the results.
-@@ -193,7 +205,7 @@
- the "``--theme-url``" option (for themes anywhere).  For example, the
- "medium-black" theme can be specified as follows::
- 
--    rst2s5.py --theme medium-black slides.txt slides.html
-+    rst2s5 --theme medium-black slides.txt slides.html
- 
- The theme will be copied to the ``ui/medium-black`` directory.
- 
-@@ -276,11 +288,13 @@
- :Parser: reStructuredText
- :Writer: LaTeX2e
- 
-+In Debian this is installed as rst2latex.
-+
- The ``rst2latex.py`` front end reads standalone reStructuredText
- source files and produces LaTeX2e output. For example, to process a
- reStructuredText file "``test.txt``" into LaTeX::
- 
--    rst2latex.py test.txt test.tex
-+    rst2latex test.txt test.tex
- 
- The output file "``test.tex``" should then be processed with ``latex``
- or ``pdflatex`` to get a document in DVI, PostScript or PDF format for
-@@ -299,6 +313,8 @@
- :Parser: reStructuredText
- :Writer: XML (Docutils native)
- 
-+In Debian this is installed as rst2xml.
-+
- The ``rst2xml.py`` front end produces Docutils-native XML output.
- This can be transformed with standard XML tools such as XSLT
- processors into arbitrary final forms.
-@@ -314,6 +330,8 @@
- :Parser: reStructuredText
- :Writer: ODF/.odt
- 
-+In Debian this front end is installed as rst2odt.
-+
- The ``rst2odt.py`` front end reads standalone reStructuredText
- source files and produces ODF/.odt files that can be read, edited,
- printed, etc with OpenOffice ``oowriter``
-@@ -337,6 +355,8 @@
- :Parser: reStructuredText
- :Writer: Pseudo-XML
- 
-+In Debian this is installed as rst2pseudoxml.
-+
- ``rst2pseudoxml.py`` is used for debugging the Docutils "Reader to
- Transform to Writer" pipeline.  It produces a compact pretty-printed
- "pseudo-XML", where nesting is indicated by indentation (no end-tags).
-@@ -351,6 +371,9 @@
- :Parser: reStructuredText
- :Writer: N/A
- 
-+This tool is not currently installed by the Debian package;
-+``apt-get source python-docutils`` if you need it.
-+
- The ``quicktest.py`` tool is used for testing the reStructuredText
- parser.  It does not use a Docutils Reader or Writer or the standard
- Docutils command-line options.  Rather, it does its own I/O and calls

Copied: packages/python-docutils/trunk/debian/patches/doc-debian-paths.diff (from rev 21604, packages/python-docutils/trunk/debian/patches/10_doc_debian_paths.diff)
===================================================================
--- packages/python-docutils/trunk/debian/patches/doc-debian-paths.diff	                        (rev 0)
+++ packages/python-docutils/trunk/debian/patches/doc-debian-paths.diff	2012-05-10 20:49:32 UTC (rev 21692)
@@ -0,0 +1,209 @@
+Description: change paths in documentation to match Debian's
+ Change paths in documentation to match Debian's. Debian policy recommends not
+ having extensions like .py on script names, and buildhtml seems too generic a
+ name.
+Author: Simon McVittie <smcv at debian.org>
+Forwarded: not-needed
+Last-Update: 2012-05-10
+
+--- a/README.txt
++++ b/README.txt
+@@ -11,8 +11,19 @@
+ .. contents::
+ 
+ 
+-Quick-Start
+-===========
++Quick-Start on Debian systems
++=============================
++
++The reStructuredText tools are installed in the normal system path by the
++Debian ``python-docutils`` package. To convert reStructuredText to another
++format, use a shell command like::
++
++       rst2html /usr/share/doc/python-docutils/FAQ.txt ./FAQ.html
++
++See Usage_ below for details.
++
++Quick-Start on other systems
++============================
+ 
+ This is for those who want to get up & running quickly.  Read on for
+ complete details.
+@@ -287,6 +298,12 @@
+ the front-end tools for details on options and arguments.  See
+ Docutils Front-End Tools (``docs/user/tools.txt``) for full documentation.
+ 
++On a Debian system the included tools (with the exception of quicktest.py
++and the development tools in the dev/ directory) are installed into the
++normal system path, so you can run ``rst2html.py`` with a command like::
++
++    rst2html example.txt example.html
++
+ The package modules are continually growing and evolving.  The
+ ``docutils.statemachine`` module is usable independently.  It contains
+ extensive inline documentation (in reStructuredText format of course).
+--- a/docs/user/emacs.txt
++++ b/docs/user/emacs.txt
+@@ -120,6 +120,9 @@
+ 
+   (add-hook 'rst-adjust-hook 'rst-toc-update)
+ 
++The Debian ``python-docutils`` package automatically sets up a suitable
++configuration.
++
+ Additional configuration variables can be customized and can be found
+ by browsing the source code for ``rst.el``.
+ 
+--- a/docs/user/tools.txt
++++ b/docs/user/tools.txt
+@@ -39,6 +39,10 @@
+ used for the destination.  If no arguments are specified, the standard
+ input (stdin) is used for the source as well.
+ 
++In Debian these tools are installed in the normal system path, without the
++``.py`` extension, according to Debian policy. 
++buildhtml.py_ is installed as rst-buildhtml.
++
+ 
+ Getting Help
+ ============
+@@ -66,13 +70,15 @@
+ :Parser: reStructuredText
+ :Writers: HTML, PEP/HTML
+ 
++In Debian this tool is installed under the name rst-buildhtml.
++
+ Use ``buildhtml.py`` to generate .html from all the .txt files
+ (including PEPs) in each <directory> given, and their subdirectories
+ too.  (Use the ``--local`` option to skip subdirectories.)
+ 
+ Usage::
+ 
+-    buildhtml.py [options] [<directory> ...]
++    rst-buildhtml [options] [<directory> ...]
+ 
+ After unpacking the Docutils package, the following shell commands
+ will generate HTML for all included documentation::
+@@ -103,6 +109,8 @@
+ :Parser: reStructuredText
+ :Writer: HTML
+ 
++In Debian this front end is installed as rst2html.
++
+ The ``rst2html.py`` front end reads standalone reStructuredText source
+ files and produces HTML 4 (XHTML 1) output compatible with modern
+ browsers that support cascading stylesheets (CSS).  A stylesheet is
+@@ -112,13 +120,13 @@
+ For example, to process a reStructuredText file "``test.txt``" into
+ HTML::
+ 
+-    rst2html.py test.txt test.html
++    rst2html test.txt test.html
+ 
+ Now open the "``test.html``" file in your favorite browser to see the
+ results.  To get a footer with a link to the source file, date & time
+ of processing, and links to the Docutils project, add some options::
+ 
+-    rst2html.py -stg test.txt test.html
++    rst2html -stg test.txt test.html
+ 
+ 
+ Stylesheets
+@@ -146,6 +154,8 @@
+ :Parser: reStructuredText
+ :Writer: PEP/HTML
+ 
++In Debian this front end is installed as rstpep2html.
++
+ ``rstpep2html.py`` reads a new-style PEP (marked up with
+ reStructuredText) and produces HTML.  It requires a template file and
+ a stylesheet.  By default, it makes use of a "``pep-html-template``"
+@@ -156,7 +166,7 @@
+ For example, to process a PEP into HTML::
+ 
+     cd <path-to-docutils>/docs/peps
+-    rstpep2html.py pep-0287.txt pep-0287.html
++    rstpep2html pep-0287.txt pep-0287.html
+ 
+ 
+ rst2s5.py
+@@ -166,6 +176,8 @@
+ :Parser: reStructuredText
+ :Writer: S5/HTML
+ 
++In Debian this is installed as rst2s5.
++
+ The ``rst2s5.py`` front end reads standalone reStructuredText source
+ files and produces (X)HTML output compatible with S5_, the "Simple
+ Standards-based Slide Show System" by Eric Meyer.  A theme is required
+@@ -175,7 +187,7 @@
+ For example, to process a reStructuredText file "``slides.txt``" into
+ S5/HTML::
+ 
+-    rst2s5.py slides.txt slides.html
++    rst2s5 slides.txt slides.html
+ 
+ Now open the "``slides.html``" file in your favorite browser, switch
+ to full-screen mode, and enjoy the results.
+@@ -193,7 +205,7 @@
+ the "``--theme-url``" option (for themes anywhere).  For example, the
+ "medium-black" theme can be specified as follows::
+ 
+-    rst2s5.py --theme medium-black slides.txt slides.html
++    rst2s5 --theme medium-black slides.txt slides.html
+ 
+ The theme will be copied to the ``ui/medium-black`` directory.
+ 
+@@ -276,11 +288,13 @@
+ :Parser: reStructuredText
+ :Writer: LaTeX2e
+ 
++In Debian this is installed as rst2latex.
++
+ The ``rst2latex.py`` front end reads standalone reStructuredText
+ source files and produces LaTeX2e output. For example, to process a
+ reStructuredText file "``test.txt``" into LaTeX::
+ 
+-    rst2latex.py test.txt test.tex
++    rst2latex test.txt test.tex
+ 
+ The output file "``test.tex``" should then be processed with ``latex``
+ or ``pdflatex`` to get a document in DVI, PostScript or PDF format for
+@@ -299,6 +313,8 @@
+ :Parser: reStructuredText
+ :Writer: XML (Docutils native)
+ 
++In Debian this is installed as rst2xml.
++
+ The ``rst2xml.py`` front end produces Docutils-native XML output.
+ This can be transformed with standard XML tools such as XSLT
+ processors into arbitrary final forms.
+@@ -314,6 +330,8 @@
+ :Parser: reStructuredText
+ :Writer: ODF/.odt
+ 
++In Debian this front end is installed as rst2odt.
++
+ The ``rst2odt.py`` front end reads standalone reStructuredText
+ source files and produces ODF/.odt files that can be read, edited,
+ printed, etc with OpenOffice ``oowriter``
+@@ -337,6 +355,8 @@
+ :Parser: reStructuredText
+ :Writer: Pseudo-XML
+ 
++In Debian this is installed as rst2pseudoxml.
++
+ ``rst2pseudoxml.py`` is used for debugging the Docutils "Reader to
+ Transform to Writer" pipeline.  It produces a compact pretty-printed
+ "pseudo-XML", where nesting is indicated by indentation (no end-tags).
+@@ -351,6 +371,9 @@
+ :Parser: reStructuredText
+ :Writer: N/A
+ 
++This tool is not currently installed by the Debian package;
++``apt-get source python-docutils`` if you need it.
++
+ The ``quicktest.py`` tool is used for testing the reStructuredText
+ parser.  It does not use a Docutils Reader or Writer or the standard
+ Docutils command-line options.  Rather, it does its own I/O and calls

Modified: packages/python-docutils/trunk/debian/patches/series
===================================================================
--- packages/python-docutils/trunk/debian/patches/series	2012-05-10 20:49:16 UTC (rev 21691)
+++ packages/python-docutils/trunk/debian/patches/series	2012-05-10 20:49:32 UTC (rev 21692)
@@ -1,5 +1,5 @@
 iepngfix-license.diff
-10_doc_debian_paths.diff
+doc-debian-paths.diff
 emacs-sensible-browser.diff
 testall-no-stdout-stderr-redirect.diff
 no-test-skipping.diff




More information about the Python-modules-commits mailing list