Clarified the comments about isoburn_prepare_*() calls

master
Thomas Schmitt 9 years ago
parent 71fba8a077
commit 43007e2bda
  1. 24
      libisoburn/libisoburn.h
  2. 2
      xorriso/xorriso_timestamp.h

@ -2065,13 +2065,17 @@ int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte,
int flag);
/** To choose the expansion method of Growing:
/** Start production of an ISO 9660 image using the method of Growing:
Create a disc object for writing the new session from the created or loaded
iso_volset which has been manipulated via libisofs, to the same medium from
where the image was eventually loaded. This struct burn_disc is ready for
use by a subsequent call to isoburn_disc_write().
After this asynchronous writing has ended and the drive is BURN_DRIVE_IDLE
again, the burn_disc object has to be disposed by burn_disc_free().
where the image was eventually loaded.
This call starts a libisofs thread which begins to produce the image.
It has to be revoked by isoburn_cancel_prepared_write() if for some reason
this image data stream shall not be consumed.
The returned struct burn_disc is ready for use by a subsequent call to
isoburn_disc_write(). After this asynchronous writing has ended and the
drive is BURN_DRIVE_IDLE again, the burn_disc object has to be disposed
by burn_disc_free().
@since 0.1.0
@param drive The combined source and target drive, grabbed with
isoburn_drive_scan_and_grab(). .
@ -2083,13 +2087,16 @@ int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
struct isoburn_imgen_opts *opts);
/** To choose the expansion method of Modifying:
/** Start production of an ISO 9660 image using the method of Modifying:
Create a disc object for producing a new image from a previous image
plus the changes made by user. The generated burn_disc is suitable
to be written to a grabbed drive with blank writeable medium.
But you must not use the same drive for input and output, because data
will be read from the source drive while at the same time the target
drive is already writing.
This call starts a libisofs thread which begins to produce the image.
It has to be revoked by isoburn_cancel_prepared_write() if for some reason
this image data stream shall not be consumed.
The resulting burn_disc object has to be disposed when all its writing
is done and the drive is BURN_DRIVE_IDLE again after asynchronous
burn_disc_write().
@ -2108,7 +2115,7 @@ int isoburn_prepare_new_image(struct burn_drive *in_drive,
struct burn_drive *out_drive);
/** To choose the expansion method of Blind Growing:
/** Start production of an ISO 9660 image using the method of Blind Growing:
Create a disc object for writing an add-on session from the created or
loaded IsoImage which has been manipulated via libisofs, to a different
drive than the one from where it was loaded.
@ -2122,6 +2129,9 @@ int isoburn_prepare_new_image(struct burn_drive *in_drive,
$nwa is a parameter of this call
or can be used as detected from the in_drive medium
This call starts a libisofs thread which begins to produce the image.
It has to be revoked by isoburn_cancel_prepared_write() if for some reason
this image data stream shall not be consumed.
This call waits for libisofs output to become available and then detaches
the input drive object from the data source object by which libisofs was
reading from the input drive.

@ -1 +1 @@
#define Xorriso_timestamP "2013.08.07.141130"
#define Xorriso_timestamP "2013.08.16.153701"

Loading…
Cancel
Save