aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2011-05-05 14:09:48 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2011-05-05 14:39:29 +0300
commit6c3f6c1b02dd5f9ac343c713bdae4aa83bafc328 (patch)
tree49bc8df1cff7157c711c63447c3e272ebc67cd4c /doc
parenta60eb4b18345626a84e23784d77ca231812e1dff (diff)
downloadgrecs-6c3f6c1b02dd5f9ac343c713bdae4aa83bafc328.tar.gz
grecs-6c3f6c1b02dd5f9ac343c713bdae4aa83bafc328.tar.bz2
Improve node formatting. Add version comparasion functions.
* am/grecs.m4 (GRECS_SETUP): New option: shared. * doc/GRECS_SETUP.3: Document new options. * doc/grecs_format_locus.3: Update. * doc/grecs_format_node.3: Document new flags. * src/.gitignore: Update. * src/version.c: New file. * src/Make.am (GRECS_SRC): Add version.c (EXTRA_DIST): Update. * src/diag.c (default_print_diag): Flush stdout as per the docs. * src/format.c (grecs_format_locus): Don't print trailing semicolon. (grecs_format_value): Handle GRECS_NODE_FLAG_NOQUOTE flag. (grecs_format_node): Print delimiters when needed. * src/grecs.h (grecs_version_info): New struct. (grecs_version, grecs_version_cmp): New protos. (GRECS_NODE_FLAG_NOQUOTE): New flag. * tests/gcfver.c: New file. * tests/vercmp.at: New file. * tests/.gitignore: Update. * tests/Makefile.am: Define GRECS_VERCMP_AT in package.m4 (TESTSUITE_AT): Add vercmp.at (conditionally). (noinst_PROGRAMS): Add gcfver. * tests/testsuite.at: Conditionally include vercmp.at.
Diffstat (limited to 'doc')
-rw-r--r--doc/GRECS_SETUP.37
-rw-r--r--doc/grecs_format_locus.32
-rw-r--r--doc/grecs_format_node.38
3 files changed, 13 insertions, 4 deletions
diff --git a/doc/GRECS_SETUP.3 b/doc/GRECS_SETUP.3
index 23c0ad5..af0f8e0 100644
--- a/doc/GRECS_SETUP.3
+++ b/doc/GRECS_SETUP.3
@@ -13,13 +13,13 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Grecs. If not, see <http://www.gnu.org/licenses/>.
.\" This file is part of SLB.
.\" Copyright (C) 2011 Sergey Poznyakoff
.\"
-.TH GRECS_SETUP 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH GRECS_SETUP 3 "May 5, 2011" "GRECS" "Grecs User Reference"
.SH NAME
GRECS_SETUP \- Initialize \fBgrecs\fR submodule.
.SH SYNOPSIS
.BI "GRECS_SETUP(" "dir" ", " "options" ", " "pp-setup-file" )
.SH DESCRIPTION
The \fBGRECS_SETUP\fR macro is invoked from the host project's
@@ -50,12 +50,17 @@ are understood:
Disable the use of preprocessor.
.TP
.B install
Create and install shared library \fBlibgrecs.so\fR. Install the
documentation as well.
.TP
+.B shared
+Create a shared convenience library. By default, a static library is
+created. Use this option if you want to incorporate grecs into another
+shared library.
+.TP
.B std-pp-setup
Install the standard \fBpp-setup\fR file.
.TP
.B pp-setup-option
Add the
.B --with-pp-setup-file
diff --git a/doc/grecs_format_locus.3 b/doc/grecs_format_locus.3
index 3803c2b..90ffa03 100644
--- a/doc/grecs_format_locus.3
+++ b/doc/grecs_format_locus.3
@@ -26,13 +26,13 @@ grecs_format_locus \- format and output source file location
.BI "void grecs_format_locus(grecs_locus_t " "*locus" ", FILE " "*fp" );
.SH DESCRIPTION
\fBgrecs_format_locus\fR formats the location from \fIlocus\fR in the
human-readable form and outputs it to file \fBfp\fR.
.PP
The location is output as follows: the file name, followed by a
-semicolon, followed by line number and another semicolon.
+semicolon, followed by the line number.
.PP
If \fIlocus\fR is \fBNULL\fR, \fBgrecs_format_locus\fR returns without
doing anything.
.SH "RETURN VALUE"
None.
.SH NOTES
diff --git a/doc/grecs_format_node.3 b/doc/grecs_format_node.3
index d1d8b02..76cebec 100644
--- a/doc/grecs_format_node.3
+++ b/doc/grecs_format_node.3
@@ -55,16 +55,20 @@ Print the node value.
.B GRECS_NODE_FLAG_QUOTE
Always quote the value. By default, the value will be quoted only
when necessary, i.e. if it contains white space, quotes or special
characters. This option is useful only together with
\fBGRECS_NODE_FLAG_VALUE\fR.
.TP
+.B GRECS_NODE_FLAG_NOQUOTE
+Never quote values. If both \fBGRECS_NODE_FLAG_QUOTE\fR and
+\fBGRECS_NODE_FLAG_NOQUOTE\fR are given, the former takes precedence
+over the latter.
+.TP
.B GRECS_NODE_FLAG_QUOTE_HEX
Print non-printable characters as C hex escapets. This option is
-useful only together with \fBGRECS_NODE_FLAG_QUOTE\fR and
-\fBGRECS_NODE_FLAG_VALUE\fR.
+ignored if \fBGRECS_NODE_FLAG_NOQUOTE\fR is set.
.TP
.B GRECS_NODE_FLAG_DEFAULT
Same as
.sp
.nf
GRECS_NODE_FLAG_PATH|GRECS_NODE_FLAG_VALUE|GRECS_NODE_FLAG_QUOTE

Return to:

Send suggestions and report system problems to the System administrator.