[Emacs-diffs] trunk r116628: Document zlib-decompress-region

[Glenn Morris]

------------------------------------------------------------
revno: 116628
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Sat 2014-03-01 19:34:36 -0800
message:
  Document zlib-decompress-region
  
  * doc/lispref/text.texi (Decompression): New node.
  
  * doc/lispref/elisp.texi (Top): Update detailed menu.
  
  * etc/NEWS: Related markup.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/elisp.texi         elisp.texi-20091113204419-o5vbwnq5f7feedwu-6176
  doc/lispref/text.texi          text.texi-20091113204419-o5vbwnq5f7feedwu-6215
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-03-01 02:54:08 +0000
+++ b/doc/lispref/ChangeLog     2014-03-02 03:34:36 +0000
@@ -1,3 +1,8 @@
+2014-03-02  Glenn Morris  <address@hidden>
+
+       * text.texi (Decompression): New node.
+       * elisp.texi (Top): Update detailed menu.
+
 2014-03-01  Glenn Morris  <address@hidden>
 
        * display.texi (Forcing Redisplay): Mention pre-redisplay-function.

=== modified file 'doc/lispref/elisp.texi'
--- a/doc/lispref/elisp.texi    2014-02-28 01:49:25 +0000
+++ b/doc/lispref/elisp.texi    2014-03-02 03:34:36 +0000
@@ -1138,6 +1138,7 @@
 * Registers::               How registers are implemented.  Accessing
                               the text or position stored in a register.
 * Transposition::           Swapping two portions of a buffer.
+* Decompression::           Dealing with compressed data.
 * Base 64::                 Conversion to or from base 64 encoding.
 * Checksum/Hash::           Computing cryptographic hashes.
 * Parsing HTML/XML::        Parsing HTML and XML.

=== modified file 'doc/lispref/text.texi'
--- a/doc/lispref/text.texi     2014-02-27 11:59:35 +0000
+++ b/doc/lispref/text.texi     2014-03-02 03:34:36 +0000
@@ -54,6 +54,7 @@
 * Registers::        How registers are implemented.  Accessing the text or
                        position stored in a register.
 * Transposition::    Swapping two portions of a buffer.
+* Decompression::    Dealing with compressed data.
 * Base 64::          Conversion to or from base 64 encoding.
 * Checksum/Hash::    Computing cryptographic hashes.
 * Parsing HTML/XML:: Parsing HTML and XML.
@@ -4132,6 +4133,35 @@
 all markers unrelocated.
 @end defun
 
address@hidden Decompression
address@hidden Dealing With Compressed Data
+
+When @code{auto-compression-mode} is enabled, Emacs automatically
+uncompresses compressed files when you visit them, and automatically
+recompresses them if you alter and save them.  @xref{Compressed
+Files,,, emacs, The GNU Emacs Manual}.
+
+The above feature works by calling an external executable (e.g.,
address@hidden).  Emacs can also be compiled with support for built-in
+decompression using the zlib library, which is faster than calling an
+external program.
+
address@hidden zlib-available-p
+This function returns address@hidden if built-in zlib decompression is
+available.
address@hidden defun
+
address@hidden zlib-decompress-region start end
+This function decompresses the region between @var{start} and
address@hidden, using built-in zlib decompression.  The region should
+contain data that were compressed with gzip or zlib.  On success, the
+function replaces the contents of the region with the decompressed
+data.  On failure, the function leaves the region unchanged and
+returns @code{nil}.  This function can be called only in unibyte
+buffers.
address@hidden defun
+
+
 @node Base 64
 @section Base 64 Encoding
 @cindex base 64 encoding

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-03-01 03:54:47 +0000
+++ b/etc/NEWS  2014-03-02 03:34:36 +0000
@@ -91,6 +91,7 @@
 
 * Changes in Emacs 24.4
 
++++
 ** New function `zlib-decompress-region', which decompresses gzip- and
 zlib-format compressed data using built-in zlib support, if available.