Merge pull request #83 from cs50/develop

v8.0.3

Author: Kareem Zidane

.gitignore

@@ -1,3 +1,9 @@
 .*
 !.gitignore
+!.travis.yml
 build/
+debian/changelog
+debian/docs/
+hackerrank/
+libcs50-*
+libcs50_*

.travis.yml

@@ -0,0 +1,23 @@
+dist: trusty
+sudo: required
+before_install:
+- sudo apt-get install build-essential debhelper devscripts dh-make lintian
+- gem install asciidoctor
+install: true
+before_script: echo -e $GPG_SECRET | gpg --import
+script: make deb
+deploy:
+- provider: script
+  script: 'curl --fail --data "{ \"tag_name\": \"v$(make version)\",
+    \"target_commitish\": \"$TRAVIS_COMMIT\", \"name\": \"v$(make version)\"
+  }" --user bot50:$GITHUB_TOKEN https://api.github.com/repos/$TRAVIS_REPO_SLUG/releases'
+  on:
+    branch: master
+- provider: script
+  script: dput ppa:cs50/ppa build/deb/*.changes
+  skip_cleanup: true
+  on:
+    branch: master
+notifications:
+  slack:
+    secure: ISOGlNSGXOrMBrKTnjTWQXVjjoBn78++xF1mUv/PYZxn3J4L4WpybLLjAuBENsD7YeHSaXUnSbIV5mDzlx5Q1cyrS+auGOHqi5xGV01zNBB1Fig1SkUf7zJS8KyjiPKyi+DexnTt1BY4xaA1uGzq9hoGZEPXKHNlz4v1I6f6fHQ=

Makefile

@@ -1,117 +1,60 @@
-# useful paths
-SRC_DIR = src
-HDR = $(SRC_DIR)/cs50.h
-SRC = $(SRC_DIR)/cs50.c
+VERSION := 8.0.3
 
-BUILD_DIR = build
-OBJ = $(BUILD_DIR)/cs50.o
-USR_DIR = $(BUILD_DIR)/usr
-INCLUDE_DIR = $(USR_DIR)/include
-LIB_DIR = $(USR_DIR)/lib
-MAN_DIR = $(USR_DIR)/share/man/man3
-BUILD_SRC = $(USR_DIR)/src
+# soname - libcs50.so.<major_version>
+SONAME := libcs50.so.$(shell echo $(VERSION) | head -c 1)
 
-# eprintf
-EPRINTF_EXE = $(BUILD_DIR)/eprintf
-
-# HackerRank
-HR_HDR = $(BUILD_DIR)/cs50.h
-HR_EXE = $(BUILD_DIR)/hackerrank
-
-TESTS_DIR = tests
-
-# deb package info
-DESCRIPTION = CS50 Library for C
-MAINTAINER = CS50 <[email protected]>
-NAME = libcs50
-OLD_NAMES = lib50-c library50-c
-VERSION = 8.0.2
-
-.PHONY: bash
-bash:
-	docker run -i --rm -t -v "$(PWD):/root" cs50/cli
+# installation directory (/usr/local by default)
+DESTDIR ?= /usr/local
 
 .PHONY: build
-build: clean Makefile $(SRC) $(HDR)
-	mkdir -p "$(INCLUDE_DIR)" "$(LIB_DIR)" "$(MAN_DIR)" "$(BUILD_SRC)"
-	gcc -c -fPIC -std=gnu99 -Wall -o "$(OBJ)" "$(SRC)"
-	gcc -o "$(LIB_DIR)/libcs50.so" -shared "$(OBJ)"
-	rm -f "$(OBJ)"
-	cp "$(HDR)" "$(INCLUDE_DIR)"
-	cp "$(SRC)" "$(BUILD_SRC)"
-	cp -r docs/* "$(MAN_DIR)"
-	find "$(BUILD_DIR)" -type d -exec chmod 0755 {} +
-	find "$(BUILD_DIR)" -type f -exec chmod 0644 {} +
-
-.PHONY: clean
-clean:
-	rm -rf "$(BUILD_DIR)"
-
-.PHONY: deb
-deb: build
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(BUILD_DIR)" \
-	-s dir \
-	-t deb \
-	-v "$(VERSION)" \
-	--conflicts "$(NAME) (<< $(VERSION))" \
-	$(foreach name,$(OLD_NAMES),--conflicts $(name) --provides $(name) --replaces $(name)) \
-	--deb-no-default-config-files \
-	--depends c-compiler \
-	--description "$(DESCRIPTION)" \
-	--provides "$(NAME)" \
-	--replaces "$(NAME) (<= $(VERSION))" \
-	usr
-
-.PHONY: hackerrank
-hackerrank: build
-	cat "$(HDR)" > "$(HR_HDR)"
-	echo "\n#ifndef _CS50_C\n#define _CS50_C\n" >> "$(HR_HDR)"
-	cat "$(SRC)" >> "$(HR_HDR)"
-	echo "\n#endif" >> "$(HR_HDR)"
+build: clean
+	$(CC) -c -fPIC -std=gnu99 -Wall -o cs50.o src/cs50.c
+	$(CC) -shared -Wl,-soname,$(SONAME) -o libcs50.so.$(VERSION) cs50.o
+	rm -f cs50.o
+	ln -s libcs50.so.$(VERSION) $(SONAME)
+	ln -s $(SONAME) libcs50.so
+	install -D -m 644 src/cs50.h build/include/cs50.h
+	mkdir -p build/lib build/src/libcs50
+	mv libcs50.so* build/lib
+	cp -r src/* build/src/libcs50
 
 .PHONY: install
-install: build
-	cp "$(INCLUDE_DIR)"/* /usr/include
-	cp "$(LIB_DIR)"/* /usr/lib
+install: build docs
+	mkdir -p $(DESTDIR) $(DESTDIR)/share/man/man3
+	cp -r build/* $(DESTDIR)
+	cp -r debian/docs/* $(DESTDIR)/share/man/man3
 
-# TODO: add dependencies
-.PHONY: pacman
-pacman: build
-	rm -f "$(NAME)-$(VERSION)-"*.pkg.tar.xz
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(BUILD_DIR)" \
-	-s dir \
-	-t pacman \
-	-v "$(VERSION)" \
-	--description "$(DESCRIPTION)" \
-	usr
+.PHONY: clean
+clean:
+	rm -rf build debian/docs/ libcs50-* libcs50_*
 
-# TODO: add dependencies
-.PHONY: rpm
-rpm: build
-	rm -f "$(NAME)-$(VERSION)-"*.rpm
-	fpm \
-	-C "$(BUILD_DIR)" \
-	-m "$(MAINTAINER)" \
-	-n "$(NAME)" \
-	-p "$(BUILD_DIR)" \
-	-s dir \
-	-t rpm \
-	-v "$(VERSION)" \
-	--description "$(DESCRIPTION)" \
-	usr
+# requires asciidoctor (gem install asciidoctor)
+.PHONY: docs
+docs:
+	asciidoctor -d manpage -b manpage -D debian/docs/ docs/*.adoc
 
-# TODO: improve test suite
-.PHONY: test
-test: build hackerrank
-	#clang -ggdb3 -I "$(INCLUDE_DIR)" -O0 -Wall -Werror -Wno-deprecated-declarations "$(TESTS_DIR)/eprintf.c" -L "$(LIB_DIR)" -lcs50 -o "$(EPRINTF_EXE)"
-	#clang -I "$(BUILD_DIR)" -Wall -Werror -Wno-deprecated-declarations "$(TESTS_DIR)/hackerrank.c" -o "$(HR_EXE)"
-	clang -ggdb3 -I "$(INCLUDE_DIR)" -O0 -Wall -Werror -Wno-deprecated-declarations "$(TESTS_DIR)/get_int.c" -L "$(LIB_DIR)" -lcs50 -o "$(BUILD_DIR)"/get_int
-	LD_LIBRARY_PATH="$(LIB_DIR)" "$(BUILD_DIR)"/get_int
+.PHONY: deb
+deb: build docs
+	@echo "libcs50 ($(VERSION)-0ubuntu1) trusty; urgency=low" > debian/changelog
+	@echo "  * v$(VERSION)" >> debian/changelog
+	@echo " -- CS50 Sysadmins <[email protected]> $$(date --rfc-2822)" >> debian/changelog
+	mkdir -p libcs50-$(VERSION)/usr
+	rsync -a build/* libcs50-$(VERSION)/usr --exclude=hack
+	tar -cvzf libcs50_$(VERSION).orig.tar.gz libcs50-$(VERSION)
+	cp -r debian libcs50-$(VERSION)
+	cd libcs50-$(VERSION) && debuild -S -sa --lintian-opts --display-info --info --show-overrides
+	mkdir -p build/deb
+	mv libcs50-* libcs50_* build/deb
+
+.PHONY: hack
+hack:
+	rm -rf build/hack && mkdir -p build/hack
+	cat src/cs50.h > build/hack/cs50.h
+	echo "\n#ifndef _CS50_C\n#define _CS50_C\n" >> build/hack/cs50.h
+	cat src/cs50.c >> build/hack/cs50.h
+	echo "\n#endif" >> build/hack/cs50.h
+
+# used by .travis.yml
+.PHONY: version
+version:
+	@echo $(VERSION)

README.md

@@ -1,17 +1,28 @@
 # CS50 Library for C
 
+[![Build Status](https://travis-ci.org/cs50/libcs50.svg?branch=master)](https://travis-ci.org/cs50/libcs50)
+
 ## Development
 
-Requires [Docker Engine](https://docs.docker.com/engine/installation/).
+`make build`: builds dynamic library
+
+`make deb`: builds source deb
+
+`make hack`: combines library into `cs50.h`
+
+`make install`: installs the library under `/usr/local` by default (set `DESTDIR` to change that)
 
-    make bash
-    make build # builds dynamic library
-    make deb # builds .deb
-    make pacman # builds .pkg.tar.xz
-    make rpm # builds .rpm
-    make test # builds test program
+## Installation
 
-# Installation
+### Ubuntu
+
+```
+$ sudo apt-add-repository ppa:cs50/ppa
+$ sudo apt-get update
+$ sudo apt-get install libcs50
+```
+
+### From Source
 
 1. Download the latest release per https://github.com/cs50/libcs50/releases
 1. Extract `libcs50-*.*`
@@ -33,6 +44,10 @@ Link with `-lcs50`.
     long long ll = get_long_long();
     string s = get_string();
 
+## Documentation
+
+See `man get_*` after installation, or [CS50 Reference](https://reference.cs50.net/cs50/)!
+
 ## TODO
 
 *   Add tests.

debian/compat

@@ -0,0 +1 @@
+9

debian/control

@@ -0,0 +1,16 @@
+Source: libcs50
+Priority: optional
+Maintainer: CS50 Sysadmins <[email protected]>
+Build-Depends: debhelper (>= 9)
+Standards-Version: 3.9.5
+Section: libs
+Vcs-Git: https://github.com/cs50/libcs50.git
+
+Package: libcs50
+Architecture: any
+Conflicts: lib50-c, libcs50, library50-c
+Depends: ${shlibs:Depends}, ${misc:Depends}
+Provides: lib50-c, libcs50, library50-c
+Replaces: lib50-c, libcs50, library50-c
+Description: CS50 library for C
+ makes it easier to write programs that prompt the users for input

debian/copyright

@@ -0,0 +1,37 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: libcs50
+Source: http://github.com/cs50/libcs50/releases
+
+Files: *
+Copyright: 2017 David J. Malan <[email protected]>
+           2017 Glenn Holloway <[email protected]>
+License: BSD-3-Clause
+
+Files: debian/*
+Copyright: 2017 CS50 Sysadmins <[email protected]>
+License: BSD-3-Clause
+
+License: BSD-3-Clause
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+ 3. Neither the name of the University nor the names of its contributors
+    may be used to endorse or promote products derived from this software
+    without specific prior written permission.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE HOLDERS OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

debian/libcs50.dirs

@@ -0,0 +1,3 @@
+usr/lib
+usr/include
+usr/src

debian/libcs50.install

@@ -0,0 +1,3 @@
+usr/include/*
+usr/lib/libcs50.so*
+usr/src/*

debian/libcs50.manpages

@@ -0,0 +1,7 @@
+debian/docs/eprintf.3
+debian/docs/get_char.3
+debian/docs/get_double.3
+debian/docs/get_float.3
+debian/docs/get_int.3
+debian/docs/get_long_long.3
+debian/docs/get_string.3