Officially rename archive_{read,write}_open_file() to
archive_{read,write}_open_filename(): * Update Makefile to build the files using the new name. * Update docs to document the new names, mentioning the old ones as "deprecated synonyms." * The old filenames will be reconnected to the build soon; I'll soon recyce those files for a slightly different purpose.
This commit is contained in:
parent
fc9c165a41
commit
af6513d3ea
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=164448
@ -54,7 +54,7 @@ SRCS= archive.h \
|
||||
archive_read_data_into_fd.c \
|
||||
archive_read_extract.c \
|
||||
archive_read_open_fd.c \
|
||||
archive_read_open_file.c \
|
||||
archive_read_open_filename.c \
|
||||
archive_read_support_compression_all.c \
|
||||
archive_read_support_compression_bzip2.c \
|
||||
archive_read_support_compression_compress.c \
|
||||
@ -70,7 +70,7 @@ SRCS= archive.h \
|
||||
archive_util.c \
|
||||
archive_write.c \
|
||||
archive_write_open_fd.c \
|
||||
archive_write_open_file.c \
|
||||
archive_write_open_filename.c \
|
||||
archive_write_set_compression_bzip2.c \
|
||||
archive_write_set_compression_gzip.c \
|
||||
archive_write_set_compression_none.c \
|
||||
@ -159,6 +159,7 @@ MLINKS+= archive_read.3 archive_read_open.3
|
||||
MLINKS+= archive_read.3 archive_read_open2.3
|
||||
MLINKS+= archive_read.3 archive_read_open_fd.3
|
||||
MLINKS+= archive_read.3 archive_read_open_file.3
|
||||
MLINKS+= archive_read.3 archive_read_open_filename.3
|
||||
MLINKS+= archive_read.3 archive_read_set_bytes_per_block.3
|
||||
MLINKS+= archive_read.3 archive_read_support_compression_all.3
|
||||
MLINKS+= archive_read.3 archive_read_support_compression_bzip2.3
|
||||
@ -184,6 +185,7 @@ MLINKS+= archive_write.3 archive_write_new.3
|
||||
MLINKS+= archive_write.3 archive_write_open.3
|
||||
MLINKS+= archive_write.3 archive_write_open_fd.3
|
||||
MLINKS+= archive_write.3 archive_write_open_file.3
|
||||
MLINKS+= archive_write.3 archive_write_open_filename.3
|
||||
MLINKS+= archive_write.3 archive_write_set_bytes_per_block.3
|
||||
MLINKS+= archive_write.3 archive_write_set_bytes_in_last_block.3
|
||||
MLINKS+= archive_write.3 archive_write_set_callbacks.3
|
||||
|
@ -43,7 +43,7 @@
|
||||
.Nm archive_read_open ,
|
||||
.Nm archive_read_open2 ,
|
||||
.Nm archive_read_open_fd ,
|
||||
.Nm archive_read_open_file ,
|
||||
.Nm archive_read_open_filename ,
|
||||
.Nm archive_read_next_header ,
|
||||
.Nm archive_read_data ,
|
||||
.Nm archive_read_data_block ,
|
||||
@ -88,7 +88,7 @@
|
||||
.Ft int
|
||||
.Fn archive_read_open_fd "struct archive *" "int fd" "size_t block_size"
|
||||
.Ft int
|
||||
.Fn archive_read_open_file "struct archive *" "const char *filename" "size_t block_size"
|
||||
.Fn archive_read_open_filename "struct archive *" "const char *filename" "size_t block_size"
|
||||
.Ft int
|
||||
.Fn archive_read_next_header "struct archive *" "struct archive_entry **"
|
||||
.Ft ssize_t
|
||||
@ -158,7 +158,7 @@ Freeze the settings, open the archive, and prepare for reading entries.
|
||||
This is the most generic version of this call, which accepts
|
||||
four callback functions.
|
||||
Most clients will want to use
|
||||
.Fn archive_read_open_file
|
||||
.Fn archive_read_open_filename
|
||||
or
|
||||
.Fn archive_read_open_fd
|
||||
instead.
|
||||
@ -173,6 +173,9 @@ Note that the file descriptor will not be automatically closed at
|
||||
end-of-archive.
|
||||
This function is safe for use with tape drives or other blocked devices.
|
||||
.It Fn archive_read_open_file
|
||||
This is a deprecated synonym for
|
||||
.Fn archive_read_open_filename .
|
||||
.It Fn archive_read_open_filename
|
||||
Like
|
||||
.Fn archive_read_open ,
|
||||
except that it accepts a simple filename and a block size.
|
||||
|
@ -41,7 +41,7 @@
|
||||
.Nm archive_write_set_compressor_bzip2 ,
|
||||
.Nm archive_write_open ,
|
||||
.Nm archive_write_open_fd ,
|
||||
.Nm archive_write_open_file ,
|
||||
.Nm archive_write_open_filename ,
|
||||
.Nm archive_write_header ,
|
||||
.Nm archive_write_data ,
|
||||
.Nm archive_write_close ,
|
||||
@ -76,7 +76,7 @@
|
||||
.Ft int
|
||||
.Fn archive_write_open_fd "struct archive *" "int fd"
|
||||
.Ft int
|
||||
.Fn archive_write_open_file "struct archive *" "const char *filename"
|
||||
.Fn archive_write_open_filename "struct archive *" "const char *filename"
|
||||
.Ft int
|
||||
.Fn archive_write_header "struct archive *" "struct archive_entry *"
|
||||
.Ft int
|
||||
@ -118,7 +118,7 @@ For compressed output, any padding generated by this option
|
||||
is applied only after the compression.
|
||||
The uncompressed data is always unpadded.
|
||||
The default is to pad the last block to the full block size (note that
|
||||
.Fn archive_write_open_file
|
||||
.Fn archive_write_open_filename
|
||||
will set this based on the file type).
|
||||
Unlike the other
|
||||
.Dq set
|
||||
@ -165,6 +165,9 @@ A convenience form of
|
||||
.Fn archive_write_open
|
||||
that accepts a file descriptor.
|
||||
.It Fn archive_write_open_file
|
||||
A deprecated synonym for
|
||||
.Fn archive_write_open_filename .
|
||||
.It Fn archive_write_open_filename
|
||||
A convenience form of
|
||||
.Fn archive_write_open
|
||||
that accepts a filename.
|
||||
@ -175,7 +178,7 @@ will open a file with that name.
|
||||
If you have not invoked
|
||||
.Fn archive_write_set_bytes_in_last_block ,
|
||||
then
|
||||
.Fn archive_write_open_file
|
||||
.Fn archive_write_open_filename
|
||||
will adjust the last-block padding depending on the file:
|
||||
it will enable padding when writing to standard output or
|
||||
to a character or block device node, it will disable padding otherwise.
|
||||
|
Loading…
Reference in New Issue
Block a user