doc fixups

This commit is contained in:
John Cupitt 2014-06-19 12:14:41 +01:00
parent 415b6d08be
commit 3797c1824a
3 changed files with 20 additions and 31 deletions

19
TODO
View File

@ -6,27 +6,20 @@
on set_progress(FALSE) vips_sink_disc() should stop calling
vips_image_preeval()
- shouldn't
progress reporting should be done by vips.c, not by libvips?
$ vips invert --help
produce help for invert? or did that get removed?
- threadpool recyling might be useful for dzsave?
- can we call affine from nip2 vips_call? do we need a double array?
- the docs reference vips__temp_name() several times, but we don't doc it
where should we discuss the temporary directory? vips_image_new_temp_file()
I guess. What about vips_system()?
- check and fix up docs
index items should all be links

View File

@ -2056,9 +2056,13 @@ vips_image_set_delete_on_close( VipsImage *image, gboolean delete_on_close )
* Make a "w" disc #VipsImage which will be automatically unlinked when it is
* destroyed. @format is something like "%s.v" for a vips file.
*
* The file is created in the temporary directory, see vips__temp_name().
* The file is created in the temporary directory. This is set with the
* environment variable TMPDIR. If this is not set, then on Unix systems, vips
* will default to /tmp. On Windows, vips uses GetTempPath() to find the
* temporary directory.
*
* See also: vips__temp_name().
* vips uses g_mkstemp() to make the temporary filename. They generally look
* something like "vips-12-EJKJFGH.v".
*
* Returns: the new #VipsImage, or %NULL on error.
*/

View File

@ -314,27 +314,19 @@ vips_system_init( VipsSystem *system )
* vips_system() runs a command, optionally passing a set of images in and
* optionally getting an image back. The command's stdout is returned in @log.
*
* First, if @in is set, the array of images are written to files. The
* filenames are formed by substituting something like "vips-49857-1" for
* the first %%s in @in_format, then prepending "/tmp". If the environment
* variable TMPDIR is defined, it can be used to set a different temporary
* directory.
*
* On Windows, if the environment variable TMPDIR is not defined, VIPS calls
* GetTempPath() to get the user's preferred temporary area. If that fails, it
* defaults to C:\temp.
*
* First, if @in is set, the array of images are written to files. See
* vips_image_new_temp_file() to see how temporary files are created.
* If @in_format is
* something like "%%s.png", the file will be written in PNG format. By
* default, @in_format is "%%s.tif".
* something like %s.png, the file will be written in PNG format. By
* default, @in_format is %s.tif.
*
* If @out_format is set, an output filename is formed in the same way.
*
* The command string to run is made by substituting the first set of %%s
* The command string to run is made by substituting the first set of %s
* in @cmd_format for the names of the input files, if @in is set, and then
* the next %%s for the output filename, if @out_format is set.
* You can put a number between the %% and the s to change the order in which
* the substitution occurs.
* the next %s for the output filename, if @out_format is set.
* You can put a number between the % and the s to change the order
* in which the substitution occurs.
*
* The command is executed with popen() and the output captured in @log.
*