[git] GPGME - branch, master, updated. gpgme-1.12.0-126-g1e26572

by Ben McGinnes cvs at cvs.gnupg.org
Sun Jan 27 05:00:10 CET 2019 

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GnuPG Made Easy".

The branch, master has been updated
       via  1e265723653042bc1010b457537b69a2011b43b7 (commit)
      from  ed81892917f47dddc23aa99d88733e3f8f344256 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 1e265723653042bc1010b457537b69a2011b43b7
Author: Ben McGinnes <ben at adversary.org>
Date:   Sun Jan 27 14:57:53 2019 +1100

    python: post installer docs fix script
    
    * Moved post_installer.py into the examples/howto/ directory.
    * Added instructions for its use to the Python Bindings HOWTO.
    * Ran it as intended from the lang/python/ directory in order to both
      prove it works and quickly and easily get the updated howto
      replicated.  Also to fix all those .texi files.
    
    Tested-by: Ben McGinnes <ben at adversary.org>
    Signed-off-by: Ben McGinnes <ben at adversary.org>

diff --git a/lang/python/doc/rst/gpgme-python-howto.rst b/lang/python/doc/rst/gpgme-python-howto.rst
index 4146e37..5f8bcd5 100644
--- a/lang/python/doc/rst/gpgme-python-howto.rst
+++ b/lang/python/doc/rst/gpgme-python-howto.rst
@@ -683,6 +683,21 @@ on the system and version of Python in use. Another option is to run the
 command ``python3 -m virtualenv /path/to/install/virtual/thingy``
 instead.
 
+.. _snafu-docs:
+
+Post installation
+~~~~~~~~~~~~~~~~~
+
+Following installation it is recommended to move the
+``post_installer.py`` script from the ``lang/python/examples/howto/``
+directory to the ``lang/python/`` directory and run it. This will fix or
+restore files needed by Sphinx which may be removed during a
+distribution build for release. It will also generate reST files from
+Org mode files with Pandoc and generate Texinfo files from Org mode
+files with GNU Emacs and Org mode (in batch mode). Additionally it will
+fix the UTF-8 declaration line in the Texinfo files (Emacs expects
+\"UTF-8\" to be \"utf-8\").
+
 .. _howto-fund-a-mental:
 
 Fundamentals
diff --git a/lang/python/doc/rst/index.rst b/lang/python/doc/rst/index.rst
index 9c4f0f7..3ff34fc 100644
--- a/lang/python/doc/rst/index.rst
+++ b/lang/python/doc/rst/index.rst
@@ -7,7 +7,7 @@ GPGME Python Bindings
 =====================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
 Contents
@@ -20,11 +20,3 @@ Contents
 
 -  `What Was New <what-was-new>`__
 -  `GPGME Python Bindings HOWTO <gpgme-python-howto>`__
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/lang/python/doc/src/gpgme-python-howto b/lang/python/doc/src/gpgme-python-howto
index 6569806..c63191b 100644
--- a/lang/python/doc/src/gpgme-python-howto
+++ b/lang/python/doc/src/gpgme-python-howto
@@ -705,6 +705,22 @@ the command =python3 -m virtualenv /path/to/install/virtual/thingy=
 instead.
 
 
+*** Post installation
+    :PROPERTIES:
+    :CUSTOM_ID: snafu-docs
+    :END:
+
+Following installation it is recommended to move the
+=post_installer.py= script from the =lang/python/examples/howto/=
+directory to the =lang/python/= directory and run it.  This will fix
+or restore files needed by Sphinx which may be removed during a
+distribution build for release.  It will also generate reST files from
+Org mode files with Pandoc and generate Texinfo files from Org mode
+files with GNU Emacs and Org mode (in batch mode).  Additionally it
+will fix the UTF-8 declaration line in the Texinfo files (Emacs
+expects "UTF-8" to be "utf-8").
+
+
 * Fundamentals
   :PROPERTIES:
   :CUSTOM_ID: howto-fund-a-mental
diff --git a/lang/python/doc/texinfo/gpgme-python-howto.texi b/lang/python/doc/texinfo/gpgme-python-howto.texi
index fac0056..9f53aa5 100644
--- a/lang/python/doc/texinfo/gpgme-python-howto.texi
+++ b/lang/python/doc/texinfo/gpgme-python-howto.texi
@@ -81,6 +81,7 @@ Known Issues
 * Won't Work With Windows::
 * CFFI is the Best™ and GPGME should use it instead of SWIG::
 * Virtualised Environments::
+* Post installation::
 
 Fundamentals
 
@@ -511,6 +512,7 @@ they be encountered.
 * Won't Work With Windows::
 * CFFI is the Best™ and GPGME should use it instead of SWIG::
 * Virtualised Environments::
+* Post installation::
 @end menu
 
 @node Breaking Builds
@@ -883,6 +885,19 @@ on the system and version of Python in use.  Another option is to run
 the command @samp{python3 -m virtualenv /path/to/install/virtual/thingy}
 instead.
 
+ at node Post installation
+ at subsection Post installation
+
+Following installation it is recommended to move the
+ at samp{post_installer.py} script from the @samp{lang/python/examples/howto/}
+directory to the @samp{lang/python/} directory and run it.  This will fix
+or restore files needed by Sphinx which may be removed during a
+distribution build for release.  It will also generate reST files from
+Org mode files with Pandoc and generate Texinfo files from Org mode
+files with GNU Emacs and Org mode (in batch mode).  Additionally it
+will fix the UTF-8 declaration line in the Texinfo files (Emacs
+expects "UTF-8" to be "utf-8").
+
 @node Fundamentals
 @chapter Fundamentals
 
@@ -3465,4 +3480,4 @@ WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/doc/texinfo/index.texi b/lang/python/doc/texinfo/index.texi
index 0f4863c..95c27c2 100644
--- a/lang/python/doc/texinfo/index.texi
+++ b/lang/python/doc/texinfo/index.texi
@@ -57,4 +57,4 @@ GPGME Python Bindings
 @uref{gpgme-python-howto, GPGME Python Bindings HOWTO}
 @end itemize
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/doc/texinfo/maintenance-mode.texi b/lang/python/doc/texinfo/maintenance-mode.texi
index d38875b..9245719 100644
--- a/lang/python/doc/texinfo/maintenance-mode.texi
+++ b/lang/python/doc/texinfo/maintenance-mode.texi
@@ -166,4 +166,4 @@ already be done when converting Org to reStructuredText or Org to
 Texinfo.  As a certain amount of work would be required to get it
 done, there would need to be clear demand for that work to be done.
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/doc/texinfo/short-history.texi b/lang/python/doc/texinfo/short-history.texi
index cbb13f3..d27f68d 100644
--- a/lang/python/doc/texinfo/short-history.texi
+++ b/lang/python/doc/texinfo/short-history.texi
@@ -221,4 +221,4 @@ For those using Python 2, there is essentially no harm in using
 this module, but it may lack a number of more recent features
 added to GPGME.
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/doc/texinfo/what-is-new.texi b/lang/python/doc/texinfo/what-is-new.texi
index 5abc87a..406ab2f 100644
--- a/lang/python/doc/texinfo/what-is-new.texi
+++ b/lang/python/doc/texinfo/what-is-new.texi
@@ -91,4 +91,4 @@ repetition if a key includes a user ID matching the hexadecimal
 value of a key ID.
 @end itemize
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/doc/texinfo/what-was-new.texi b/lang/python/doc/texinfo/what-was-new.texi
index 29ea847..3f0ad9d 100644
--- a/lang/python/doc/texinfo/what-was-new.texi
+++ b/lang/python/doc/texinfo/what-was-new.texi
@@ -157,4 +157,4 @@ the time).
 Cleaned up a lot of things under the hood.
 @end itemize
 
- at bye
+ at bye
\ No newline at end of file
diff --git a/lang/python/post_installer.py b/lang/python/examples/howto/post_installer.py
similarity index 100%
rename from lang/python/post_installer.py
rename to lang/python/examples/howto/post_installer.py

-----------------------------------------------------------------------

Summary of changes:
 lang/python/doc/rst/gpgme-python-howto.rst         | 15 +++++++++++++++
 lang/python/doc/rst/index.rst                      | 10 +---------
 lang/python/doc/src/gpgme-python-howto             | 16 ++++++++++++++++
 lang/python/doc/texinfo/gpgme-python-howto.texi    | 17 ++++++++++++++++-
 lang/python/doc/texinfo/index.texi                 |  2 +-
 lang/python/doc/texinfo/maintenance-mode.texi      |  2 +-
 lang/python/doc/texinfo/short-history.texi         |  2 +-
 lang/python/doc/texinfo/what-is-new.texi           |  2 +-
 lang/python/doc/texinfo/what-was-new.texi          |  2 +-
 lang/python/{ => examples/howto}/post_installer.py |  0
 10 files changed, 53 insertions(+), 15 deletions(-)
 rename lang/python/{ => examples/howto}/post_installer.py (100%)


hooks/post-receive
-- 
GnuPG Made Easy
http://git.gnupg.org

More information about the Gnupg-commits mailing list