libburnia/legacy
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Changed wrong use of "resp." in docs

Browse Source
This commit is contained in:
Thomas Schmitt
2015-07-31 17:12:51 +00:00
parent 0adcb08a86
commit 5764c37b52
12 changed files with 92 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
libisoburn/trunk/libisoburn/libisoburn.h
View File

@ -53,7 +53,7 @@ Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>
Usage model
There may be an input drive and an output drive. Either of them may be missing
with the consequence that no reading resp. writing is possible.
with the consequence that no reading or no writing is possible.
Both drive roles can be fulfilled by the same drive.
Input can be a random access readable libburn drive:
@ -61,7 +61,7 @@ Input can be a random access readable libburn drive:
Output can be any writeable libburn drive:
writeable optical media in burner, writeable file objects (no directories).
libburn demands rw-permissions to drive device file resp. file object.
libburn demands rw-permissions to drive device file or file object.
If the input drive provides a suitable ISO RockRidge image, then its tree
may be loaded into memory and can then be manipulated by libisofs API calls.
@ -149,7 +149,7 @@ must provide definitions for uint32_t and uint8_t.
This can be achieved either:
- by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H
according to its ./configure tests,
- or by defining the macros HAVE_STDINT_H resp. HAVE_INTTYPES_H according
- or by defining the macros HAVE_STDINT_H or HAVE_INTTYPES_H according
to the local situation,
- or by appropriately defining uint32_t and uint8_t by other means,
e.g. by including inttypes.h before including libisofs.h and libisoburn.h
@ -389,7 +389,7 @@ int isoburn_set_msgs_submit(int (*msgs_submit)(void *handle, int error_code,
void *submit_handle, int submit_flag, int flag);
/** Acquire a target drive by its filesystem path resp. libburn persistent
/** Acquire a target drive by its filesystem path or libburn persistent
address.
Wrapper for: burn_drive_scan_and_grab()
@since 0.1.0
@ -399,7 +399,8 @@ int isoburn_set_msgs_submit(int (*msgs_submit)(void *handle, int error_code,
The returned array should be freed via burn_drive_info_free()
when the drive is no longer needed. But before this is done
one has to call isoburn_drive_release(drive_infos[0].drive).
@param adr The persistent address of the desired drive.
@param adr The persistent address of the desired drive or the path
to a file object.
@param load 1 attempt to load the disc tray. 0 no attempt,rather failure.
@return 1 = success , 0 = drive not found , <0 = other error
*/
@ -407,7 +408,7 @@ int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
char* adr, int load);
/** Acquire a target drive by its filesystem path resp. libburn persistent
/** Acquire a target drive by its filesystem path or libburn persistent
address. This is a modern successor of isoburn_drive_scan_and_grab().
Wrapper for: burn_drive_scan_and_grab()
@since 0.1.2
@ -417,7 +418,8 @@ int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
The returned array should be freed via burn_drive_info_free()
when the drive is no longer needed. But before this is done
one has to call isoburn_drive_release(drive_infos[0].drive).
@param adr The persistent address of the desired drive.
@param adr The persistent address of the desired drive or the path
to a file object.
@param flag bit0= attempt to load the disc tray.
Else: failure if not loaded.
bit1= regard overwriteable media as blank
@ -839,7 +841,7 @@ int isoburn_ropt_get_data_cache(struct isoburn_read_opts *o,
/** Which existing ISO 9660 extensions in the image to read or not to read.
Whether to read the content of an existing image at all.
The bits can be combined by | resp. inquired by &.
The bits can be combined by | and inquired by &.
@since 0.1.0
@param ext Bitfield:
bit0= norock
@ -1474,7 +1476,7 @@ int isoburn_igopt_get_effective_lba(struct isoburn_imgen_opts *o, int *lba);
int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba);
/** Set resp. get parameters "name" and "timestamp" for a scdbackup checksum
/** Set or get parameters "name" and "timestamp" for a scdbackup checksum
tag. It will be appended to the libisofs session tag if the image starts at
LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used
to verify the image by command scdbackup_verify $device -auto_end.
@ -1585,7 +1587,7 @@ int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o,
The additional volume descriptor set and trees will allow to mount the
ISO image at the start of the first partition, while it is still possible
to mount it via the normal first volume descriptor set and tree at the
start of the image resp. storage device.
start of the image or storage device.
This makes few sense on optical media. But on USB sticks it creates a
conventional partition table which makes it mountable on e.g. Linux via
/dev/sdb and /dev/sdb1 alike.
@ -1682,7 +1684,7 @@ int isoburn_igopt_detach_jte(struct isoburn_imgen_opts *opts,
void **libjte_handle);
/** Set resp. get the number of trailing zero byte blocks to be written by
/** Set or get the number of trailing zero byte blocks to be written by
libisofs. The image size counter of the emerging ISO image will include
them. Eventual checksums will take them into respect.
They will be written immediately before the eventual image checksum area
@ -1795,7 +1797,7 @@ int isoburn_igopt_set_partition_img(struct isoburn_imgen_opts *opts,
image_paths[] of the same index is not NULL.
@param image_paths
Its elements get filled with either NULL or a pointer to a string
with a file address resp. an empty text.
with a file address or an empty text.
@return
<0 = error
0 = no partition image set
@ -2336,7 +2338,7 @@ int isoburn_prepare_blind_grow(struct burn_drive *in_drive,
call described here.
If this call returns 0 or 1 then the write thread of libisofs has ended.
@since 0.1.0
@param input_drive The drive resp. in_drive which was used with the
@param input_drive The drive or in_drive which was used with the
preparation call.
@param output_drive The out_drive used with isoburn_prepare_new_image(),
NULL if none.
@ -2430,7 +2432,7 @@ int isoburn_activate_session(struct burn_drive *d);
This call is not mandatory. But without it, messages from the ending
threads might appear after the application ended its write procedure.
@since 0.1.0
@param input_drive The drive resp. in_drive which was used with the
@param input_drive The drive or in_drive which was used with the
preparation call.
@param output_drive The out_drive used with isoburn_prepare_new_image(),
NULL if none.