[Getdata-commits] SF.net SVN: getdata:[894] trunk/defile
Scientific Database Format
Brought to you by:
ketiltrout
Menu
▾
▴
[Getdata-commits] SF.net SVN: getdata:[894] trunk/defile
|
From: <ket...@us...> - 2014-05-03 00:06:52
|
Revision: 894
http://sourceforge.net/p/getdata/code/894
Author: ketiltrout
Date: 2014-05-03 00:06:48 +0000 (Sat, 03 May 2014)
Log Message:
-----------
Preliminary Getdata-0.9 support. Miscellaneous doc updates.
Modified Paths:
--------------
trunk/defile/Makefile.am
trunk/defile/bin/net.c
trunk/defile/bin/rc.c
trunk/defile/doc/Makefile.am
trunk/defile/doc/defile-ascii.1
trunk/defile/doc/defile-dirfile.1
trunk/defile/doc/defile-input.7
trunk/defile/doc/defile.1.in
trunk/defile/doc/df_add_entry.3
trunk/defile/doc/df_add_fragment.3
trunk/defile/doc/df_add_framedef.3
trunk/defile/doc/df_add_lut.3
trunk/defile/doc/df_init.3
trunk/defile/doc/df_push_frame.3
trunk/defile/doc/df_ready.3
trunk/defile/doc/df_shell_expand.3
trunk/defile/lib/internal.h
Added Paths:
-----------
trunk/defile/doc/df_field_in_output.3
Removed Paths:
-------------
trunk/defile/doc/df_field_in_input.3
Modified: trunk/defile/Makefile.am
===================================================================
--- trunk/defile/Makefile.am 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/Makefile.am 2014-05-03 00:06:48 UTC (rev 894)
@@ -18,7 +18,7 @@
# along with GetData; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
-AUTOMAKE_OPTIONS = foreign dist-bzip2 check-news 1.10
+AUTOMAKE_OPTIONS = foreign dist-bzip2 check-news 1.11
ACLOCAL_AMFLAGS = -I m4
Modified: trunk/defile/bin/net.c
===================================================================
--- trunk/defile/bin/net.c 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/bin/net.c 2014-05-03 00:06:48 UTC (rev 894)
@@ -468,7 +468,7 @@
}
break;
case DF_RPC_ADD_ENTRY:
- E.comp_scal = 1;
+ DF_SET_COMP_SCAL(E);
switch (pos) {
case 0:
DF_GET_SDATUM(E.field);
Modified: trunk/defile/bin/rc.c
===================================================================
--- trunk/defile/bin/rc.c 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/bin/rc.c 2014-05-03 00:06:48 UTC (rev 894)
@@ -360,8 +360,13 @@
if (rcd->name)
df_iprintf(DF_PRN_CLEAR, DF_PRN_NOTE, "defile-%s input plugin v%s\n",
rcd->name, rcd->version);
- else
+ else {
df_iprintf(DF_PRN_CLEAR, DF_PRN_NOTE, "%s\n", PACKAGE_STRING);
+#ifdef GD_GETDATA_VERSION
+ df_iprintf(DF_PRN_CLEAR, DF_PRN_NOTE, "using GetData %s\n",
+ GD_GETDATA_VERSION);
+#endif
+ }
if (rcd->copyright)
df_iprintf(DF_PRN_CLEAR, DF_PRN_NOTE, "%s\n\n", rcd->copyright);
Modified: trunk/defile/doc/Makefile.am
===================================================================
--- trunk/defile/doc/Makefile.am 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/Makefile.am 2014-05-03 00:06:48 UTC (rev 894)
@@ -25,7 +25,7 @@
man1_MANS = defile-ascii.1 defile-dirfile.1
man7_MANS = defile-input.7
man3_MANS = df_add_alias.3 df_add_entry.3 df_add_fragment.3 df_add_framedef.3 \
- df_add_lut.3 df_check_abort.3 df_exit.3 df_field_in_input.3 \
+ df_add_lut.3 df_check_abort.3 df_exit.3 df_field_in_output.3 \
df_hide.3 df_get_offset.3 df_include.3 df_init.3 df_input_name.3 \
df_mode.3 df_nframes_allowed.3 df_on_abort.3 df_push_frame.3 \
df_puts.3 df_ready.3 df_set_const.3 df_shell_expand.3 \
Modified: trunk/defile/doc/defile-ascii.1
===================================================================
--- trunk/defile/doc/defile-ascii.1 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/defile-ascii.1 2014-05-03 00:06:48 UTC (rev 894)
@@ -112,7 +112,7 @@
.BR strtod (3))
separated by a semicolon
.RI ( ; ),
-with no intervening whitespace. This is the GetData convension; see
+with no intervening whitespace. This is the Dirfile convension; see
dirfile-format(5). The first floating-point number is the value of the real
part of the complex number and the second is the value of the imaginary part.
@@ -131,7 +131,7 @@
.BR \-\-const\-row
and
.BR \-\-string\-row ,
-which are treated in the order they are presented to defile-ascii. For each
+which are handled in the order they are presented to defile-ascii. For each
header line, including the field names, the line is parsed in the same manner as
the rest of the data: either as fixed-width columns, or else with the same
delimiters specified. By default, these header data may appear as comment lines
Modified: trunk/defile/doc/defile-dirfile.1
===================================================================
--- trunk/defile/doc/defile-dirfile.1 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/defile-dirfile.1 2014-05-03 00:06:48 UTC (rev 894)
@@ -119,7 +119,7 @@
in the subdirectory
.I DIR
under the output dirfile base directory, instead of the default "<ext>". The
-directory specified must be relative. (Directive:
+directory may not be an absolute path. (Directive:
.BR ExtDir )
.TP
.BR \-f ", " \-\-flatten
@@ -164,7 +164,7 @@
in the subdirectory
.I DIR
under the output dirfile base directory, instead of the default "<lut>". The
-directory specified must be relative. (Directive:
+directory may not be an absolute path. (Directive:
.BR LUTDir )
.TP
.BR \-X ", " \-\-link\-extern\-frags
Modified: trunk/defile/doc/defile-input.7
===================================================================
--- trunk/defile/doc/defile-input.7 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/defile-input.7 2014-05-03 00:06:48 UTC (rev 894)
@@ -38,7 +38,7 @@
can be extended easily, without having to modify defile itself.
Defile provides a C API for input plugins. Functions provided by the API are
-described in individual manual pages in section 3 of the manual. A list of
+described in individual manual pages in section 3 of this Manual. A list of
these is given below in the
.B API REFERENCE
section. The API is defined in the C header file <defile.h>. This document
@@ -48,14 +48,13 @@
.B DEFILE OPERATION
below.
-An input plugin is a dynamically-loaded shared library which asynchronously
-reads data from a data source and passes it on to defile for output as a
-dirfile. Each input plugin is identified by it's type name. The type name
-identifies the type of data the input plugin is capable of reading. The type
-name should consist of one or more lower case letters, numbers, or the
-underscore (_) character. The type name must be unique among all defile input
-plugins: defile will only ever consider the first input plugin with a given type
-name that it finds.
+An input plugin is a dynamically-loaded library which asynchronously reads data
+from a data source and passes it on to defile for output as a dirfile. Each
+input plugin is identified by it's type name. The type name identifies the type
+of data the input plugin is capable of reading. The type name should consist of
+one or more lower case letters, numbers, or the underscore (_) character. The
+type name must be unique among all defile input plugins: defile will only ever
+consider the first input plugin with a given type name that it finds.
The name of the shared library must be of the form:
.IP
@@ -66,7 +65,7 @@
where
.I anything
is optional and may contain any valid filename characters (the host platform
-may require a certain prefix for native dynamically loadable modules),
+may require a certain prefix for native dynamically-loadable modules),
.B defile-
is literaly "defile" followed by a dash,
.I type
@@ -74,7 +73,7 @@
.I -anything
contains more optional characters, separated from the type name by a dash, and
.I .ext
-is a file extension appropriate for native dynamically loadable modules on the
+is a file extension appropriate for native dynamically-loadable modules on the
host platform, if any.
.PP
The type name is also the value of the
@@ -151,7 +150,7 @@
section below.
.TP
.I licence
-indicates the licence type of the plugin. It affects what license boilerplate
+indicates the licence type of the plugin. It affects which license boilerplate
(if any) is printed along with version information. See the
.B HELP AND VERSION OUTPUT
section below for details.
@@ -289,7 +288,7 @@
.TP
.I argname
the placeholder name of the argument used in usage output. For stylistic
-consitency, it is recommended this consist of upper case letters only. If the
+consitency, it is suggested this consist of upper case letters only. If the
option is of type
.BR DF_OPT_NO_ARG ,
this value is ignored and may be NULL. Otherwise, if this is NULL, a default
@@ -300,7 +299,7 @@
usage output (see the
.B HELP AND VERSION OUTPUT
section below). It should contain no newlines; they will be inserted where
-appropriate by defile. For stylistic consistency, it is recommended this begin
+appropriate by defile. For stylistic consistency, it is suggested this begin
with a lower case letter, and have independent clauses separated by semicolons.
If this option record specifies neither
.I sopt
@@ -429,18 +428,18 @@
The input plugin's role in each state is discussed below.
The input plugin's main loop may return at any time if it's job is complete,
-or if it ran into an unrecoverable error. Returning a value of zero
+or if it ran into an irrecoverable error. Returning a value of zero
indicates to defile that the input plugin completed normally (success).
Returning any other value indicates that the input plugin encountered an
-unrecoverable error (failure).
+irrecoverable error (failure).
.SS START State
Defile begins in the
.B START
-state. In this state, defile starts by processing the defile options. It
-then determines the input plugin type to use, either as a result of an explicit
-type specified by the user, or else by using automatic type detection on the
+state. In this state, defile first processes the defile options. It then
+determines the input plugin type to use, either as a result of an explicit type
+specified by the user, or else by using automatic type detection on the
specified input (see
.B AUTOMATIC TYPE DETECTION
for information on how to get an input plugin to participate in this).
@@ -471,7 +470,9 @@
options and input directives.
.TP
.I value
-an array of integers of length
+an array of
+.IR int s
+of length
.I n_config
containing the values (see
.B INPUT OPTIONS
@@ -511,11 +512,9 @@
The input plugin is required to define at least one subframe (via the
.BR df_add_framedef (3)
call) which describes the raw data in the data objects which the input plugin
-uses to communicate with defile. It may also add derived channels to the output
-dirfile using
+uses to communicate with defile. It may also add derived channels and other objects to the output dirfile using
.BR df_add_entry (3)
-and define the rest of the output dirfile metadata.
-(See also the
+(or similar) and define the rest of the output dirfile metadata. (See also the
.B DEFILE DATA MODEL
section below for an overview of how defile expects data to be marshalled.)
This is also the earliest time at which the input plugin is able to determine
@@ -589,13 +588,14 @@
Defile enters the
.B ABORT
-state in cases when an unrecoverable error occurs during operation, or else when
+state in cases when an irrecoverable error occurs during operation, or else when
it receives an asynchronous request to cancel (for example a keyboard
interrupt). Most of the input plugin API functions check whether defile has
entered this state and return
.B DF_ABORT
when detected (see
-.BR "Standard API Return Semaphores" ).
+.B Standard API Return Semaphores
+below).
The input should either monitor the return value of these functions to
detect an unexpected transition into the
.B ABORT
@@ -694,7 +694,7 @@
The most common reason for this is the input plugin spending too long in the
.B ABORT
state, but it may happen in other exceptional circumstances. Input plugins which
-disable cancelability for long periods of time may be subject to more drastic
+disable cancellability for long periods of time may be subject to more drastic
measures without forewarning.
.SS Console I/O
@@ -784,7 +784,7 @@
A careful trade-off must be made between false negatives (returning zero in
cases where the input designator really does indicate something readable by the
input plugin) and false positives (returning non-zero in cases where the input
-designator does not, after all, indicate something readable by the plugin.
+designator does not, after all, indicate something readable by the plugin).
False negatives cause defile to be unable to automatically find a suitable
input plugin; excessive false positives can lead to multiple input plugins
claiming the input (resulting in neither being automatically given it).
@@ -798,7 +798,7 @@
The following functions (some listed multiple times) are provided by the defile
C API, grouped here by sequencing restrictions. See the indicated manual pages
-for details.
+for details on the functions themselves.
.TP
Functions which may be called at any time, regardless of current state:
Modified: trunk/defile/doc/defile.1.in
===================================================================
--- trunk/defile/doc/defile.1.in 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/defile.1.in 2014-05-03 00:06:48 UTC (rev 894)
@@ -137,7 +137,7 @@
.BR +t ", " \-\-autotype
ignore any previous input type specified. If no subsequent
.B \-t
-occurs, defile with attempt to automatically determine the input type. This
+occurs, defile will attempt to automatically determine the input type. This
is the default behaviour. Defile attempts to automatically determine the
appropriate input plugin for the
.I INPUT
@@ -155,11 +155,11 @@
.SS Ouptut Location Options
The path of the created dirfile is controlled by
-.B \-\-dirfile
+.B \-\-directory
and
.BR \-\-output ,
at least one of which must be given, unless running as a server. If
-.B \-\-dirfile
+.B \-\-directory
is used without
.BR \-\-output ,
the name of the output dirfile will depend on the
@@ -424,8 +424,8 @@
.I HOST
(with the username
.IR USER ,
-if given) and transfer data from it using a remote defile. Change the (local)
-program used to log into the remote host, see
+if given) and transfer data from it using a remote defile. To change the
+(local) program used to log into the remote host, see
.BR \-\-rsh ;
to change the program executed on the remote host, see
.BR \-\-remote\-command .
@@ -483,7 +483,7 @@
Use
.I COMMAND
as the remote shell used to log into the remote host. By default this is "ssh" (see
-.BR ssh(1)),
+.BR ssh (1)),
and
.I COMMAND
must be "ssh compatible" in the sense that the second last argument passed to
@@ -531,7 +531,7 @@
.BR \-\-append ", " \-\-directory ", " \-\-output ", and " \-\-async .
Any output field list specified, as well as
.BR \-\-clobber ,
-are ignored. (Directive:
+are also ignored. (Directive:
.BR Listen )
.TP
.BR +L ", " \-\-no\-listen
@@ -934,8 +934,7 @@
the default suite of defile input plugins.
.SH ENVIRONMENT
-Defile never modifies the environment, but may consider the following
-environmental variables, if present:
+Defile considers the following environmental variables, if present:
.TP
.B DEFILE_PLUGIN_PATH
Modified: trunk/defile/doc/df_add_entry.3
===================================================================
--- trunk/defile/doc/df_add_entry.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_add_entry.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -73,7 +73,7 @@
If the field has been excluded from the output dirfile by the Output Field List
(see
.BR defile (1)),
-these functions do nothing and succeeds.
+these functions do nothing and succeed.
.SH RETURN VALUE
Upon success,
.BR df_add_entry ()
Modified: trunk/defile/doc/df_add_fragment.3
===================================================================
--- trunk/defile/doc/df_add_fragment.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_add_fragment.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -44,8 +44,8 @@
may contain path elements relative to the base output dirfile directory.
Subdirectories specified in
.I name
-will be created if they do not already exist. The new fragment will be included
-in the fragment indexed by
+will be created in the output dirfile if they do not already exist. The new
+fragment will be included in the fragment indexed by
.IR fragment ,
which should be zero (for the primary format file) or else a fragment index
returned by a previous call to
Modified: trunk/defile/doc/df_add_framedef.3
===================================================================
--- trunk/defile/doc/df_add_framedef.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_add_framedef.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -135,8 +135,8 @@
output in the order defined in the subframe definition, which may be different
than their ordering within the subframe itself.
.PP
-Specifications for field which have not appeared in any previous subframe
-definition will be added to the output fragment indexed by
+Fields which have not appeared in any previous subframe definition will be
+added to the output fragment indexed by
.IR fragment ,
which should be either zero (for the primary fragment) or else a fragment index
returned by
@@ -147,8 +147,8 @@
subframe definition, and need not be the same as the fragment in which the
field is actually defined.
.PP
-Fields which have been excluded from the output dirfile by the Output Field List
-(see
+Fields which have been excluded from the output dirfile by the user via the
+Output Field List (see
.BR defile (1))
are accepted in subframe definitions and simply ignored.
.SH RETURN VALUE
Modified: trunk/defile/doc/df_add_lut.3
===================================================================
--- trunk/defile/doc/df_add_lut.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_add_lut.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -88,6 +88,7 @@
or
.I y_type
was invalid.
+.TP
.B DF_OUTPUT
An error occured attempting to create the LUT. See
.BR mkdir (2),
Deleted: trunk/defile/doc/df_field_in_input.3
===================================================================
--- trunk/defile/doc/df_field_in_input.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_field_in_input.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -1,63 +0,0 @@
-.\" df_field_in_output.3. The df_field_in_output man page.
-.\"
-.\" Copyright (C) 2012 D. V. Wiebe
-.\"
-.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
-.\"
-.\" This file is part of the Defile package.
-.\"
-.\" Permission is granted to copy, distribute and/or modify this document
-.\" under the terms of the GNU Free Documentation License, Version 1.2 or
-.\" any later version published by the Free Software Foundation; with no
-.\" Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-.\" Texts. A copy of the license is included in the `COPYING.DOC' file
-.\" as part of this distribution.
-.\"
-.TH df_field_in_output 3 "27 February 2012" "Version 0.0.1" DEFILE
-.SH NAME
-df_field_in_output \(em check whether defile is writing a field to its output
-.SH SYNOPSIS
-.nh
-.ad l
-.fam C
-.B #include <defile.h>
-.HP
-.BI "int df_field_in_output(const char *" name );
-.fam
-.ad
-.hy
-.SH DESCRIPTION
-This function is part of the defile input plugin C API. See
-.BR defile-input (7)
-for an overview.
-.PP
-The
-.BR df_field_in_output ()
-function consults defile's Output Field List (see
-.BR defile (1)),
-and returns non-zero if the field specified by
-.I name
-would be writen to the output dirfile were it to be defined at some point by
-the input plugin. If the field has been excluded from the output dirfile, this
-function will return zero. Note: this function only checks for the potential
-for exclusion or inclusion: the returned value is not affected by whether a
-field called
-.I name
-actually has been (or will be) defined.
-.PP
-It is not required that an input plugin self-exclude fields not in the output
-dirfile by checking this function. Both included and excluded fields may
-be defined by the input plugin. Excluded fields will be silently ignored. This
-function is provided for use in rare cases where knowing a field is to be
-excluded may speed or simplify the input plugin's operation.
-.SH RETURN VALUE
-The
-.BR df_field_in_output ()
-function returns non-zero if a field called
-.I name
-would be included in the output dirfile if provided. It returns zero if a field
-with such a name would be excluded from the output.
-.SH SEE ALSO
-.BR defile-input (7),
-.BR defile (1),
-.BR df_add_framedef (3).
Copied: trunk/defile/doc/df_field_in_output.3 (from rev 875, trunk/defile/doc/df_field_in_input.3)
===================================================================
--- trunk/defile/doc/df_field_in_output.3 (rev 0)
+++ trunk/defile/doc/df_field_in_output.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -0,0 +1,63 @@
+.\" df_field_in_output.3. The df_field_in_output man page.
+.\"
+.\" Copyright (C) 2012 D. V. Wiebe
+.\"
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.\"
+.\" This file is part of the Defile package.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.2 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+.\" Texts. A copy of the license is included in the `COPYING.DOC' file
+.\" as part of this distribution.
+.\"
+.TH df_field_in_output 3 "27 February 2012" "Version 0.0.1" DEFILE
+.SH NAME
+df_field_in_output \(em check whether defile is writing a field to its output
+.SH SYNOPSIS
+.nh
+.ad l
+.fam C
+.B #include <defile.h>
+.HP
+.BI "int df_field_in_output(const char *" name );
+.fam
+.ad
+.hy
+.SH DESCRIPTION
+This function is part of the defile input plugin C API. See
+.BR defile-input (7)
+for an overview.
+.PP
+The
+.BR df_field_in_output ()
+function consults the Output Field List (see
+.BR defile (1))
+specified by the user, and returns non-zero if the field specified by
+.I name
+would be writen to the output dirfile were it to be defined at some point by
+the input plugin. If the field has been excluded from the output dirfile, this
+function returns zero. Note: this function only checks for the potential for
+exclusion or inclusion: the returned value is not affected by whether a field
+called
+.I name
+actually has been (or will be) defined.
+.PP
+It is not required that an input plugin self-exclude fields not in the output
+dirfile by checking this function. Both included and excluded fields may
+be defined by the input plugin. Excluded fields will be silently dropped by
+defile. This function is provided for use in rare cases where knowing a field
+is to be excluded may speed up or simplify the input plugin's operation.
+.SH RETURN VALUE
+The
+.BR df_field_in_output ()
+function returns non-zero if a field called
+.I name
+would be included in the output dirfile, if provided. It returns zero if a
+field with such a name would be excluded from the output.
+.SH SEE ALSO
+.BR defile-input (7),
+.BR defile (1),
+.BR df_add_framedef (3).
Modified: trunk/defile/doc/df_init.3
===================================================================
--- trunk/defile/doc/df_init.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_init.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -57,7 +57,7 @@
.BR df_update_length (3).
.TP
.I rate
-the expected frame rate for live data in follow mode (see
+the expected frame rate (in frames per second) for live data in follow mode (see
.BR defile-input (7)).
If unknown or difficult to calculate, this may be -1. This value is used to
prime the IIR filter in the rate calculator in the running information provided
@@ -120,7 +120,7 @@
case, if the input plugin is able, it may try calling the function again,
potentially with a different
.I name
-argument. In case of an irrecoverable error, a subsequent call will result in
+argument. In case of an irrecoverable error, a subsequent call will return
.BR DF_ABORT .
.IP
This will
@@ -128,8 +128,8 @@
be returned by
.BR df_reinit ()
in cases where the user has specified an explicit output dirfile name
-(--output) but not allowed overwriting of the output (--clobber), since in this
-case, both the new and old dirfiles have the same user-specified name (ie.
+(--output) but not allowed overwriting of the output (--no-clobber), since in
+this case, both the new and old dirfiles have the same, user-specified name (ie.
.I name
is ignored), and defile will refuse to truncate the dirfile it just created.
Conversely, if the user has specified both --output and --clobber, calling
Modified: trunk/defile/doc/df_push_frame.3
===================================================================
--- trunk/defile/doc/df_push_frame.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_push_frame.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -36,7 +36,7 @@
.BR df_push_frame ()
function attempts to place
.I nframes
-frames of data into the
+subframes of data into the
.BR defile (1)
buffer for conversion to the output dirfile. The
.I data
@@ -48,11 +48,11 @@
.BR gd_add_framedef (3)
when the corresponding subframe was defined.
.PP
-If
+The
.I block
-is one,
-this call will block until all data has been transferred. Otherwise, depending
-on how full defile's buffer is, fewer than
+parameter should be zero or one. If it is one, this call will block until all
+data has been transferred. Otherwise, depending on how full defile's buffer is,
+fewer than
.I nframes
frames of data may actually be buffered. In synchronous mode, care should be
taken with blocking calls to this function to avoid deadlocks. See
Modified: trunk/defile/doc/df_ready.3
===================================================================
--- trunk/defile/doc/df_ready.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_ready.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -39,8 +39,8 @@
dirfile and is ready to start providing data for conversion. (That is, it
signals a transition from the BUILD state into the RUN state; see
.BR defile-input (7).)
-If the input plugin wishes to set a reference field, it may do so now by passing
-the field's name as
+If the input plugin wishes to set a reference field, it should do so now by
+passing the field's name as
.IR reference .
If this is NULL, defile will choose a reference field for the output dirfile.
.PP
@@ -67,7 +67,8 @@
.B DF_INPUT
The field specified as
.I reference
-doesn't appear in any of the previously defined subframe definitions.
+doesn't appear as a raw field in any of the previously defined subframe
+definitions.
.TP
.B DF_SEQUENCE
The function was called while defile was not in the
Modified: trunk/defile/doc/df_shell_expand.3
===================================================================
--- trunk/defile/doc/df_shell_expand.3 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/doc/df_shell_expand.3 2014-05-03 00:06:48 UTC (rev 894)
@@ -35,8 +35,8 @@
.BR df_shell_expand ()
function returns the result of performing shell-like word expansion on the input
.IR string .
-The result is returned in as a new string, which is allocated by
-.BR malloc (3),
+The result is returned in a new string allocated by
+.BR malloc (3)
and must be freed by the caller when no longer needed. For details of
shell-like word expansion, see
.BR wordexp (3).
Modified: trunk/defile/lib/internal.h
===================================================================
--- trunk/defile/lib/internal.h 2014-05-01 04:07:20 UTC (rev 893)
+++ trunk/defile/lib/internal.h 2014-05-03 00:06:48 UTC (rev 894)
@@ -181,6 +181,17 @@
#define DF_OOM(fac) \
df_iprintf(fac, DF_PRN_ERR, "out of memory at [%s,%i]", __FILE__, __LINE__)
+/* GetData version abstraction */
+#ifndef GD_GETDATA_INT_VERSION
+#define GD_GETDATA_INT_VERSION 804 /* Minimum supported version */
+#endif
+
+#if GD_GETDATA_INT_VERSION < 900
+#define DF_SET_COMP_SCAL(E) (E).comp_scal = 1
+#else
+#define DF_SET_COMP_SCAL(E) (E).flags |= GD_EN_COMPSCAL
+#endif
+
/* NList */
struct df_subset_ {
int n; /* # of elements */
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
