Merge pull request #28 from masatake/propagate-errors

Propagate errors and release version 0.1.0

Author: masatake

.gitignore

@@ -32,6 +32,7 @@ test-driver
 tests/*.log
 tests/*.trs
 tests/test-api-tagsFind
+tests/test-api-tagsFirst
 tests/test-api-tagsFirstPseudoTag
 tests/test-api-tagsOpen
 tests/test-fix-null-deref

Makefile.am

@@ -3,14 +3,16 @@ ACLOCAL_AMFLAGS = -I m4
 
 AM_CFLAGS=-Wall
 
+EXTRA_DIST = README.md NEWS.md
+
 lib_LTLIBRARIES    = libreadtags.la
 libreadtags_la_LDFLAGS = -no-undefined -version-info $(LT_VERSION)
 libreadtags_la_CFLAGS  = $(GCOV_CFLAGS)
 
 libreadtags_la_SOURCES = readtags.c readtags.h
 nobase_include_HEADERS = readtags.h
 
-EXTRA_DIST = libreadtags.pc.in
+EXTRA_DIST += libreadtags.pc.in
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libreadtags.pc
 

NEWS.md

@@ -0,0 +1,16 @@
+# Version 0.1.0
+
+- propagate internal errors to caller
+
+- LT_VERSION 1:0:0
+
+	- extend the API for the error propagation
+
+		- add tagsGetErrno function
+		- add tagErrno eum type
+
+	- break the API
+
+		- rename sortType to tagSortType for avoiding name conflictions
+		  However, sortType is still defined as a macro.
+		  See readtags.h

README.md

@@ -1,5 +1,12 @@
-# libreadtags
+libreadtags is a library for reading tags files generated by ctags.
+libreadtags assumes the tags file format explained in [tags(5)](https://docs.ctags.io/en/latest/man/tags.5.html)
+of Universal-ctags.
 
-THIS REPOSITORY IS FOR TESTING.
-DON'T FORK ME. THIS REPOSITORY WILL BE
-DELETED AFTER TESTING.
+See the comments at the top of readtags.h about the license and copyright.
+libreadtags was derived from readtags.c of Exuberant-ctags.
+
+NEWS.md describes note worty changes.
+
+If you are looking for command line interface for tags files,
+you will like [readtags command](https://docs.ctags.io/en/latest/man/readtags.1.html)
+shipped as part of Universal-ctags. It uses libreadtags extensively.

configure.ac

@@ -1,13 +1,31 @@
 # -*- Autoconf -*-
-AC_INIT(libreadtags, 0.0.0)
+AC_INIT(libreadtags, 0.1.0)
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([readtags.c])
 
 AM_INIT_AUTOMAKE
 AC_PROG_LIBTOOL
 
-# libtool -version-info
-AC_SUBST(LT_VERSION, [0:0:0])
+# LT_VERSION => CURRENT[:REVISION[:AGE]]
+#
+# (the following instructions are taken from configure.ac in libskk)
+#
+# If library source has changed since last release, increment revision
+# If public symbols have been added, removed or changed since last release,
+#  increment current and set revision to 0
+# If public symbols have been added since last release, increment age
+# If public symbols have been removed since last release, set age to 0
+#
+# Revision history
+#
+# 0:0:0
+#    initial version; API is the same as readtags.h in Exuberant-ctags.
+#
+# 1:0:0
+#    introduced tagsGetErrno() and tagErrno.
+#    rename sortType to tagSortType.
+
+AC_SUBST(LT_VERSION, [1:0:0])
 
 AC_ARG_ENABLE([gcov],
 	[AS_HELP_STRING([--enable-gcov],