osl-0.1.3.
[osl.git] / Makefile
index cc44478..eeb5dcc 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,23 +1,31 @@
 # where to install
-prefix := /usr/local
-libdir := $(prefix)/lib
-includedir := $(prefix)/include
+PREFIX ?= /usr/local
+libdir := $(PREFIX)/lib
+includedir := $(PREFIX)/include
+bindir := $(PREFIX)/bin
+mandir := $(PREFIX)/man/man1
 
 objects := osl.o util.o rbtree.o sha1.o
 fsck_objects := fsck.fsck.o osl.fsck.o util.fsck.o rbtree.fsck.o sha1.fsck.o fsck.cmdline.o
 headers := osl.h
+executables := oslfsck
+man_pages := oslfsck.1
 
 INSTALL := install
-CC := gcc
+ifeq "$(origin CC)" "default"
+        CC := gcc
+endif
 MKDIR := mkdir -p
 RM := rm -f
 LN := ln
+LD := ld
+OBJCOPY := objcopy
 
 # libosl's versioning consists of three numbers. Let's call them x, y and z.
 # The way x, y and z are interpreted depends on the OS.
 x := 0
 y := 1
-z := 0
+z := 3
 VERSION := $(x).$(y).$(z)
 
 # common flags
@@ -38,38 +46,20 @@ LIBCFLAGS += -fPIC
 LIBCFLAGS += -fvisibility=hidden
 
 uname_s := $(shell uname -s 2>/dev/null || echo "UNKNOWN_OS")
-uname_rs := $(shell uname -rs)
 
 libname := osl
-ifeq ($(uname_s),Linux)
-       # On Linux, the following conventions apply (see dhweeler's Program
-       # Library HOWTO):
-       #
-       # The soname has the prefix ``lib'', the name of the library, the
-       # phrase ``.so'', followed by a period and a version number that is
-       # incremented whenever the interface changes.
-       soname := lib$(libname).so.$(x)
-
-       # The real name adds to the soname a period, a minor number, another
-       # period, and the release number.
-       realname := $(soname).$(y).$(z)
-
-       # In addition, there's the name that the compiler uses when requesting
-       # a library, (I'll call it the ``linker name''), which is simply the
-       # soname without any version number.
-       linkername := lib$(libname).so
 
-       LDFLAGS += --shared
+ifeq ($(uname_s),Linux)
+       format := elf
        LDFLAGS += -Wl,-soname,$(soname)
        # disallow undefined symbols
        LDFLAGS += -Wl,-z,defs
 endif
 ifeq ($(uname_s),Darwin)
        # Darwin has its own idea on version numbers:
-       #
        realname := lib$(libname).$(x).dylib
        soname := $(realname)
-       linkername := lib$(libname).so
+       linkername := lib$(libname).dylib
        # The minor version number is an incremental number using the format
        # X[.Y[.Z]]. To set the minor version number of a dynamic library, use
        # the gcc -current_version option.
@@ -82,35 +72,64 @@ ifeq ($(uname_s),Darwin)
        LDFLAGS += -dynamiclib
 endif
 ifeq ($(uname_s),SunOS)
+       format := elf
        # Solaris needs another set of flags
-       LDFLAGS += --shared
        LDFLAGS += -z text
        LDFLAGS += -z defs
+       CPPFLAGS += -I/opt/csw/include
+       LDFLAGS += -lc
+endif
+
+ifeq ($(uname_s),NetBSD)
+       format := elf
+       LDFLAGS += -Wl,-soname,$(soname)
+endif
+
+ifeq ($(uname_s),FreeBSD)
+       format := elf
+       LDFLAGS += -Wl,-soname,$(soname)
+endif
+
+ifeq ($(format),elf)
+       # On ELf-based systems, the following conventions apply (see dhweeler's
+       # Program Library HOWTO):
+       #
+       # The soname has the prefix ``lib'', the name of the library, the
+       # phrase ``.so'', followed by a period and a version number that is
+       # incremented whenever the interface changes.
        soname := lib$(libname).so.$(x)
+
+       # The real name adds to the soname a period, a minor number, another
+       # period, and the release number.
        realname := $(soname).$(y).$(z)
+
+       # In addition, there's the name that the compiler uses when requesting
+       # a library, (I'll call it the ``linker name''), which is simply the
+       # soname without any version number.
        linkername := lib$(libname).so
-       CPPFLAGS += -I/opt/csw/include
-       LDFLAGS += -lc
+       LDFLAGS += --shared
 endif
 
-all: $(realname) oslfsck
+all: $(realname) $(executables) $(man_pages)
+shared: $(realname)
+
 Makefile.deps: $(wildcard *.c *.h)
        $(CC) -MM -MG *.c > $@
-osl.c fsck.c: errtab.h
+osl.c fsck.c:
 
 -include Makefile.deps
 
 fsck.cmdline.o: fsck.cmdline.c fsck.cmdline.h
        $(CC) -c -DVERSION='"$(VERSION)"' $<
 
-%.fsck.o: %.c Makefile fsck.cmdline.c fsck.cmdline.h
+%.fsck.o: %.c Makefile fsck.cmdline.c fsck.cmdline.h osl.h errtab.h
        $(CC) -c -DVERSION='"$(VERSION)"' $(CPPFLAGS) $(CFLAGS) $< -o $@
 
-%.o: %.c Makefile
+%.o: %.c Makefile errtab.h
        $(CC) -c $(CPPFLAGS) $(CFLAGS) $(LIBCFLAGS) $<
 
 fsck.cmdline.h fsck.cmdline.c: fsck.ggo Makefile
-       gengetopt $$O \
+       gengetopt \
                --conf-parser \
                --unamed-opts=table \
                --no-handle-version \
@@ -121,31 +140,77 @@ fsck.cmdline.h fsck.cmdline.c: fsck.ggo Makefile
                < $<
 
 oslfsck: $(fsck_objects)
-       $(CC) -o $@ $(fsck_objects) -lcrypto
+       $(CC) -o $@ $(fsck_objects)
+
+oslfsck.1: oslfsck
+       help2man -h --detailed-help -N ./$< > $@
 
 $(realname): $(objects)
-       $(CC) $(LDFLAGS) -o $@ $(objects) -lcrypto
+       $(CC) $(LDFLAGS) -o $@ $(objects)
+
+$(libname).sym: osl.h.in
+       sed -Ene '/^int|^const/{s/.*(osl_.*)\(.*/\1/; p;}' $< > $@
+$(libname).ga: $(objects)
+       $(LD) -r -o $@ $(objects)
+lib$(libname).a: $(libname).ga $(libname).sym
+       $(OBJCOPY) --keep-global-symbols $(libname).sym $(libname).ga $@
 
 osl_errors.h: errlist
+       echo '/** public error codes of the osl library. */' > $@
        sed -e 's/\([A-Z_]*\)   .*/     E_OSL_\1/' \
                -e '1s/^/enum osl_errors {/1' \
                -e '1s/$$/=1/1' \
                -e '$$!s/$$/,/g' \
-               -e '$$s/$$/};/1' $< > $@
+               -e '$$s/$$/};/1' $< >> $@
 
 errtab.h: errlist
-       sed -e 's/^\([A-Z_]*\)\s*\(.*\)/_S(E_OSL_\1, \2)/g' $< > $@
+       sed -e 's/^\([A-Z_]*\)\s*\(.*\)/OSL_ERROR(E_OSL_\1, \2)/g' $< > $@
 
 osl.h: osl.h.in osl_errors.h Makefile
-       cat osl.h.in osl_errors.h > $@
+       echo '#ifndef _OSL_H' > $@
+       echo '#define _OSL_H' >> $@
+       cat osl.h.in osl_errors.h >> $@
+       echo '#endif /* _OSL_H */' >> $@
 clean:
-       rm -f *.o $(realname) osl.h osl_errors.h errtab.h fsck.cmdline.h fsck.cmdline.c
+       rm -f *.o $(realname) osl.h osl_errors.h errtab.h fsck.cmdline.h \
+               fsck.cmdline.c oslfsck *.a *.ga *.sym
+
+distclean: clean
+       rm -f web/index.html web/oslfsck.1.html web/osl.png
+       rm -rf web/doxygen
 
-install: all
+install-bin: $(executables)
+       $(MKDIR) $(bindir)
+       $(INSTALL) -m 755 $(executables) $(bindir)
+
+install-man: $(man_pages)
+       $(MKDIR) $(mandir)
+       $(INSTALL) -m 644 $(man_pages) $(mandir)
+
+install-lib: $(realname) $(headers)
        $(MKDIR) $(libdir) $(includedir)
        $(RM) $(libdir)/$(linkername)
-       $(LN) -s $(libdir)/$(soname) $(libdir)/$(linkername)
-       $(INSTALL) -s -m 755 $(realname) $(libdir)
+       $(LN) -s $(soname) $(libdir)/$(linkername)
+       $(INSTALL) -m 755 $(realname) $(libdir)
        $(INSTALL) -m 644 $(headers) $(includedir)
 
-.PHONY: all clean install
+install: all install-bin install-man install-lib
+www: web/index.html web/osl.png web/doxygen/index.html
+
+.PHONY: all shared clean install install-bin install-man install-lib www
+
+web/osl.png: web/osl.pdf Makefile
+       convert -scale 200x200 $< $@
+
+web/index.html: oslfsck.1 web/index.html.in INSTALL README
+       sed -e '/@README@/,$$d' web/index.html.in > $@
+       markdown < README >> $@
+       sed -e '1,/@README@/d' -e '/@INSTALL@/,$$d' web/index.html.in >> $@
+       markdown < INSTALL >> $@
+       sed -e '1,/@INSTALL@/d' -e '/@MAN_PAGE@/,$$d' web/index.html.in >> $@
+       groff -m man -Thtml -P -l oslfsck.1 | sed -e '1,/^<body>/d; /^<\/body>/,$$d' >> $@
+       sed -e '1,/@MAN_PAGE@/d' web/index.html.in >> $@
+
+web/doxygen/index.html: $(wildcard *.c *.h) web/Doxyfile web/header.html \
+               web/footer.html
+       doxygen web/Doxyfile