build+ci: switch to python3

Also in this commit:
 * Sync CI scripts with other projects
 * Modernize docs/conf.py
 * Cleanup README.md
 * Use the official markdown version of the GPLv3

Refs: #5095
Change-Id: Ie607fcde1f6e41fa5efbbb41b21cb08583017442

.jenkins

@@ -1,10 +1,32 @@
 #!/usr/bin/env bash
 set -e
+source .jenkins.d/util.sh
 
-DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+export CACHE_DIR=${CACHE_DIR:-/tmp}
+export WAF_JOBS=${WAF_JOBS:-1}
+[[ $JOB_NAME == *"code-coverage" ]] && export DISABLE_ASAN=yes
 
-for file in "$DIR"/.jenkins.d/*; do
+nanos() {
+    # Cannot use date(1) because macOS does not support %N format specifier
+    python3 -c 'import time; print(int(time.time() * 1e9))'
+}
+
+for file in .jenkins.d/*; do
     [[ -f $file && -x $file ]] || continue
-    echo "Run: $file"
+
+    if [[ -n $TRAVIS ]]; then
+        label=$(basename "$file" | sed -E 's/[[:digit:]]+-(.*)\..*/\1/')
+        echo -ne "travis_fold:start:${label}\r"
+        echo -ne "travis_time:start:${label}\r"
+        start=$(nanos)
+    fi
+
+    echo "\$ $file"
     "$file"
+
+    if [[ -n $TRAVIS ]]; then
+        finish=$(nanos)
+        echo -ne "travis_time:end:${label}:start=${start},finish=${finish},duration=$((finish-start)),event=${label}\r"
+        echo -ne "travis_fold:end:${label}\r"
+    fi
 done

.jenkins.d/00-deps.sh

@@ -1,29 +1,30 @@
 #!/usr/bin/env bash
-set -e
+set -ex
-
-JDIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-source "$JDIR"/util.sh
-
-set -x
 
 if has OSX $NODE_LABELS; then
     FORMULAE=(boost openssl pkg-config)
-    brew update
+    if has OSX-10.13 $NODE_LABELS || has OSX-10.14 $NODE_LABELS; then
-    if [[ -n $TRAVIS ]]; then
+        FORMULAE+=(python)
-        # travis images come with a large number of brew packages
-        # pre-installed, don't waste time upgrading all of them
-        for FORMULA in "${FORMULAE[@]}"; do
-            brew outdated $FORMULA || brew upgrade $FORMULA
-        done
-    else
-        brew upgrade
     fi
+
+    if [[ -n $TRAVIS ]]; then
+        # Travis images come with a large number of pre-installed
+        # brew packages, don't waste time upgrading all of them
+        brew list --versions "${FORMULAE[@]}" || brew update
+        for FORMULA in "${FORMULAE[@]}"; do
+            brew list --versions "$FORMULA" || brew install "$FORMULA"
+        done
+        # Ensure /usr/local/opt/openssl exists
+        brew reinstall openssl
+    else
+        brew update
+        brew upgrade
         brew install "${FORMULAE[@]}"
         brew cleanup
-fi
+    fi
 
-if has Ubuntu $NODE_LABELS; then
+elif has Ubuntu $NODE_LABELS; then
     sudo apt-get -qq update
-    sudo apt-get -qy install build-essential pkg-config libboost-all-dev \
+    sudo apt-get -qy install g++ pkg-config python3-minimal \
-                             libsqlite3-dev libssl-dev
+                             libboost-all-dev libssl-dev libsqlite3-dev
 fi

.jenkins.d/01-ndn-cxx.sh

@@ -1,12 +1,7 @@
 #!/usr/bin/env bash
-set -e
+set -ex
 
-JDIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+pushd "$CACHE_DIR" >/dev/null
-source "$JDIR"/util.sh
-
-set -x
-
-pushd "${CACHE_DIR:-/tmp}" >/dev/null
 
 INSTALLED_VERSION=
 if has OSX $NODE_LABELS; then
@@ -22,17 +17,15 @@ if [[ -z $INSTALLED_VERSION ]]; then
     INSTALLED_VERSION=$(git -C ndn-cxx rev-parse HEAD 2>/dev/null || echo NONE)
 fi
 
-sudo rm -Rf ndn-cxx-latest
+sudo rm -rf ndn-cxx-latest
-
+git clone --depth 1 https://github.com/named-data/ndn-cxx.git ndn-cxx-latest
-git clone --depth 1 git://github.com/named-data/ndn-cxx ndn-cxx-latest
-
 LATEST_VERSION=$(git -C ndn-cxx-latest rev-parse HEAD 2>/dev/null || echo UNKNOWN)
 
 if [[ $INSTALLED_VERSION != $LATEST_VERSION ]]; then
-    sudo rm -Rf ndn-cxx
+    sudo rm -rf ndn-cxx
     mv ndn-cxx-latest ndn-cxx
 else
-    sudo rm -Rf ndn-cxx-latest
+    sudo rm -rf ndn-cxx-latest
 fi
 
 sudo rm -f /usr/local/bin/ndnsec*
@@ -42,15 +35,25 @@ sudo rm -f /usr/local/lib{,64}/pkgconfig/libndn-cxx.pc
 
 pushd ndn-cxx >/dev/null
 
-./waf configure --color=yes --enable-shared --disable-static --without-osx-keychain
+if has Linux $NODE_LABELS && [[ $CXX != clang* && -z $DISABLE_ASAN ]]; then
-./waf build --color=yes -j${WAF_JOBS:-1}
+    # https://stackoverflow.com/a/47022141
-sudo_preserve_env PATH -- ./waf install --color=yes
+    ASAN="--with-sanitizer=address"
+fi
+if has CentOS-8 $NODE_LABELS; then
+    # https://bugzilla.redhat.com/show_bug.cgi?id=1721553
+    PCH="--without-pch"
+fi
+
+./waf --color=yes configure --disable-static --enable-shared --without-osx-keychain $ASAN $PCH
+./waf --color=yes build -j$WAF_JOBS
+sudo_preserve_env PATH -- ./waf --color=yes install
 
 popd >/dev/null
 popd >/dev/null
 
+if has CentOS-8 $NODE_LABELS; then
+    sudo tee /etc/ld.so.conf.d/ndn.conf >/dev/null <<< /usr/local/lib64
+fi
 if has Linux $NODE_LABELS; then
     sudo ldconfig
-elif has FreeBSD10 $NODE_LABELS; then
-    sudo ldconfig -m
 fi

.jenkins.d/10-build.sh

@@ -1,47 +1,41 @@
 #!/usr/bin/env bash
-set -e
+set -ex
 
-JDIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+git submodule sync
-source "$JDIR"/util.sh
+git submodule update --init
 
-set -x
+if [[ -z $DISABLE_ASAN ]]; then
-
-if [[ $JOB_NAME == *"code-coverage" ]]; then
-    COVERAGE="--with-coverage"
-elif [[ -z $DISABLE_ASAN ]]; then
     ASAN="--with-sanitizer=address"
 fi
-
+if [[ $JOB_NAME == *"code-coverage" ]]; then
-# Cleanup
+    COVERAGE="--with-coverage"
-sudo_preserve_env PATH -- ./waf --color=yes distclean
-
-if [[ $JOB_NAME != *"code-coverage" && $JOB_NAME != *"limited-build" ]]; then
-  # Configure/build in optimized mode with tests
-  ./waf --color=yes configure --with-tests
-  ./waf --color=yes build -j${WAF_JOBS:-1}
-
-  # Cleanup
-  sudo_preserve_env PATH -- ./waf --color=yes distclean
-
-  # Configure/build in optimized mode without tests
-  ./waf --color=yes configure
-  ./waf --color=yes build -j${WAF_JOBS:-1}
-
-  # Cleanup
-  sudo_preserve_env PATH -- ./waf --color=yes distclean
 fi
 
-# Configure/build in debug mode with tests
+if [[ $JOB_NAME != *"code-coverage" && $JOB_NAME != *"limited-build" ]]; then
-./waf --color=yes configure --debug --with-tests $ASAN $COVERAGE
+    # Build in release mode with tests
-./waf --color=yes build -j${WAF_JOBS:-1}
+    ./waf --color=yes configure --with-tests
+    ./waf --color=yes build -j$WAF_JOBS
 
-# (tests will be run against debug version)
+    # Cleanup
+    ./waf --color=yes distclean
+
+    # Build in release mode without tests
+    ./waf --color=yes configure
+    ./waf --color=yes build -j$WAF_JOBS
+
+    # Cleanup
+    ./waf --color=yes distclean
+fi
+
+# Build in debug mode with tests
+./waf --color=yes configure --debug --with-tests $ASAN $COVERAGE
+./waf --color=yes build -j$WAF_JOBS
+
+# (tests will be run against the debug version)
 
 # Install
 sudo_preserve_env PATH -- ./waf --color=yes install
 
 if has Linux $NODE_LABELS; then
     sudo ldconfig
-elif has FreeBSD $NODE_LABELS; then
-    sudo ldconfig -a
 fi

.jenkins.d/20-tests.sh

@@ -1,13 +1,8 @@
 #!/usr/bin/env bash
-set -e
+set -ex
-
-JDIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-source "$JDIR"/util.sh
-
-set -x
 
 # Prepare environment
-rm -Rf ~/.ndn
+rm -rf ~/.ndn
 
 if has OSX $NODE_LABELS; then
     security unlock-keychain -p named-data
@@ -15,7 +10,7 @@ fi
 
 ndnsec-keygen "/tmp/jenkins/$NODE_NAME" | ndnsec-install-cert -
 
-BOOST_VERSION=$(python -c "import sys; sys.path.append('build/c4che'); import _cache; print(_cache.BOOST_VERSION_NUMBER);")
+BOOST_VERSION=$(python3 -c "import sys; sys.path.append('build/c4che'); import _cache; print(_cache.BOOST_VERSION_NUMBER);")
 
 ut_log_args() {
     if (( BOOST_VERSION >= 106200 )); then
@@ -30,13 +25,13 @@ ut_log_args() {
     fi
 }
 
+# https://github.com/google/sanitizers/wiki/AddressSanitizerFlags
 ASAN_OPTIONS="color=always"
-ASAN_OPTIONS+=":detect_stack_use_after_return=true"
+ASAN_OPTIONS+=":check_initialization_order=1"
-ASAN_OPTIONS+=":check_initialization_order=true"
+ASAN_OPTIONS+=":detect_stack_use_after_return=1"
-ASAN_OPTIONS+=":strict_init_order=true"
+ASAN_OPTIONS+=":strict_init_order=1"
-ASAN_OPTIONS+=":detect_invalid_pointer_pairs=1"
+ASAN_OPTIONS+=":strict_string_checks=1"
-ASAN_OPTIONS+=":detect_container_overflow=false"
+ASAN_OPTIONS+=":detect_invalid_pointer_pairs=2"
-ASAN_OPTIONS+=":strict_string_checks=true"
 ASAN_OPTIONS+=":strip_path_prefix=${PWD}/"
 export ASAN_OPTIONS
 

.jenkins.d/README.md

@@ -1,36 +1,28 @@
-CONTINUOUS INTEGRATION SCRIPTS
+# CONTINUOUS INTEGRATION SCRIPTS
-==============================
 
-Environment Variables Used in Build Scripts
+## Environment Variables Used in Build Scripts
--------------------------------------------
 
-- `NODE_LABELS`: the variable defines a list of OS properties.  The set values are used by the
+- `NODE_LABELS`: space-separated list of platform properties. The included values are used by
-  build scripts to select proper behavior for different OS.
+  the build scripts to select the proper behavior for different operating systems and versions.
 
-  The list should include at least `[OS_TYPE]`, `[DISTRO_TYPE]`, and `[DISTRO_VERSION]`.
+  The list should normally contain `[OS_TYPE]`, `[DISTRO_TYPE]`, and `[DISTRO_VERSION]`.
 
-  Possible values for Linux:
+  Example values:
 
-  * `[OS_TYPE]`: `Linux`
+  - `[OS_TYPE]`: `Linux`, `OSX`
-  * `[DISTRO_TYPE]`: `Ubuntu`
+  - `[DISTRO_TYPE]`: `Ubuntu`, `CentOS`
-  * `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04`
+  - `[DISTRO_VERSION]`: `Ubuntu-16.04`, `Ubuntu-18.04`, `CentOS-8`, `OSX-10.14`, `OSX-10.15`
 
-  Possible values for OS X / macOS:
+- `JOB_NAME`: optional variable that defines the type of build job. Depending on the job type,
-
-  * `[OS_TYPE]`: `OSX`
-  * `[DISTRO_TYPE]`: `OSX` (can be absent)
-  * `[DISTRO_VERSION]`: `OSX-10.11`, `OSX-10.12`, `OSX-10.13`
-
-- `JOB_NAME`: optional variable to define type of the job.  Depending on the defined job type,
   the build scripts can perform different tasks.
 
   Possible values:
 
-  * empty: default build process
+  - empty: default build task
-  * `code-coverage` (Ubuntu Linux is assumed): debug build with tests and code coverage analysis
+  - `code-coverage`: debug build with tests and code coverage analysis (Ubuntu Linux is assumed)
-  * `limited-build`: only a single debug build with tests
+  - `limited-build`: only a single debug build with tests
 
-- `CACHE_DIR`: the variable defines a path to folder containing cached files from previous builds,
+- `CACHE_DIR`: directory containing cached files from previous builds, e.g., a compiled version
-  e.g., a compiled version of ndn-cxx library.  If not set, `/tmp` is used.
+  of ndn-cxx. If not set, `/tmp` is used.
 
-- `WAF_JOBS`: number of parallel build jobs used by waf, defaults to 1.
+- `WAF_JOBS`: number of parallel build threads used by waf, defaults to 1.

.jenkins.d/util.sh

@@ -16,6 +16,7 @@ has() {
     set ${saved_xtrace}
     return ${ret}
 }
+export -f has
 
 sudo_preserve_env() {
     local saved_xtrace
@@ -35,3 +36,4 @@ sudo_preserve_env() {
     set ${saved_xtrace}
     sudo env "${vars[@]}" "$@"
 }
+export -f sudo_preserve_env

COPYING.md

@@ -1,108 +1,113 @@
-GNU GENERAL PUBLIC LICENSE
+### GNU GENERAL PUBLIC LICENSE
-==========================
+
 Version 3, 29 June 2007
-=======================
 
-> Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Copyright (C) 2007 Free Software Foundation, Inc.
-  Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+<https://fsf.org/>
 
-# Preamble
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
 
-  The GNU General Public License is a free, copyleft license for
+### Preamble
+
+The GNU General Public License is a free, copyleft license for
 software and other kinds of works.
 
-  The licenses for most software and other practical works are designed
+The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+the GNU General Public License is intended to guarantee your freedom
-share and change all versions of a program--to make sure it remains free
+to share and change all versions of a program--to make sure it remains
-software for all its users.  We, the Free Software Foundation, use the
+free software for all its users. We, the Free Software Foundation, use
-GNU General Public License for most of our software; it applies also to
+the GNU General Public License for most of our software; it applies
-any other work released this way by its authors.  You can apply it to
+also to any other work released this way by its authors. You can apply
-your programs, too.
+it to your programs, too.
 
-  When we speak of free software, we are referring to freedom, not
+When we speak of free software, we are referring to freedom, not
 price. Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
 them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
+To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
+these rights or asking you to surrender the rights. Therefore, you
-certain responsibilities if you distribute copies of the software, or if
+have certain responsibilities if you distribute copies of the
-you modify it: responsibilities to respect the freedom of others.
+software, or if you modify it: responsibilities to respect the freedom
+of others.
 
-  For example, if you distribute copies of such a program, whether
+For example, if you distribute copies of such a program, whether
 gratis or for a fee, you must pass on to the recipients the same
 freedoms that you received. You must make sure that they, too, receive
 or can get the source code. And you must show them these terms so they
 know their rights.
 
-  Developers that use the GNU GPL protect your rights with two steps:
+Developers that use the GNU GPL protect your rights with two steps:
 (1) assert copyright on the software, and (2) offer you this License
 giving you legal permission to copy, distribute and/or modify it.
 
-  For the developers' and authors' protection, the GPL clearly explains
+For the developers' and authors' protection, the GPL clearly explains
 that there is no warranty for this free software. For both users' and
 authors' sake, the GPL requires that modified versions be marked as
 changed, so that their problems will not be attributed erroneously to
 authors of previous versions.
 
-  Some devices are designed to deny users access to install or run
+Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
+modified versions of the software inside them, although the
-can do so.  This is fundamentally incompatible with the aim of
+manufacturer can do so. This is fundamentally incompatible with the
-protecting users' freedom to change the software.  The systematic
+aim of protecting users' freedom to change the software. The
-pattern of such abuse occurs in the area of products for individuals to
+systematic pattern of such abuse occurs in the area of products for
-use, which is precisely where it is most unacceptable.  Therefore, we
+individuals to use, which is precisely where it is most unacceptable.
-have designed this version of the GPL to prohibit the practice for those
+Therefore, we have designed this version of the GPL to prohibit the
-products.  If such problems arise substantially in other domains, we
+practice for those products. If such problems arise substantially in
-stand ready to extend this provision to those domains in future versions
+other domains, we stand ready to extend this provision to those
-of the GPL, as needed to protect the freedom of users.
+domains in future versions of the GPL, as needed to protect the
+freedom of users.
 
-  Finally, every program is threatened constantly by software patents.
+Finally, every program is threatened constantly by software patents.
 States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
+software on general-purpose computers, but in those that do, we wish
-avoid the special danger that patents applied to a free program could
+to avoid the special danger that patents applied to a free program
-make it effectively proprietary.  To prevent this, the GPL assures that
+could make it effectively proprietary. To prevent this, the GPL
-patents cannot be used to render the program non-free.
+assures that patents cannot be used to render the program non-free.
 
-  The precise terms and conditions for copying, distribution and
+The precise terms and conditions for copying, distribution and
 modification follow.
 
-# TERMS AND CONDITIONS
+### TERMS AND CONDITIONS
 
-## 0. Definitions.
+#### 0. Definitions.
 
-  _"This License"_ refers to version 3 of the GNU General Public License.
+"This License" refers to version 3 of the GNU General Public License.
 
-  _"Copyright"_ also means copyright-like laws that apply to other kinds of
+"Copyright" also means copyright-like laws that apply to other kinds
-works, such as semiconductor masks.
+of works, such as semiconductor masks.
 
-  _"The Program"_ refers to any copyrightable work licensed under this
+"The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as _"you"_.  _"Licensees"_ and
+License. Each licensee is addressed as "you". "Licensees" and
 "recipients" may be individuals or organizations.
 
-  To _"modify"_ a work means to copy from or adapt all or part of the work
+To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
+in a fashion requiring copyright permission, other than the making of
-exact copy.  The resulting work is called a _"modified version"_ of the
+an exact copy. The resulting work is called a "modified version" of
-earlier work or a work _"based on"_ the earlier work.
+the earlier work or a work "based on" the earlier work.
 
-  A _"covered work"_ means either the unmodified Program or a work based
+A "covered work" means either the unmodified Program or a work based
 on the Program.
 
-  To _"propagate"_ a work means to do anything with it that, without
+To "propagate" a work means to do anything with it that, without
 permission, would make you directly or secondarily liable for
 infringement under applicable copyright law, except executing it on a
 computer or modifying a private copy. Propagation includes copying,
 distribution (with or without modification), making available to the
 public, and in some countries other activities as well.
 
-  To _"convey"_ a work means any kind of propagation that enables other
+To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
+parties to make or receive copies. Mere interaction with a user
-a computer network, with no transfer of a copy, is not conveying.
+through a computer network, with no transfer of a copy, is not
+conveying.
 
-  An interactive user interface displays "Appropriate Legal Notices"
+An interactive user interface displays "Appropriate Legal Notices" to
-to the extent that it includes a convenient and prominently visible
+the extent that it includes a convenient and prominently visible
 feature that (1) displays an appropriate copyright notice, and (2)
 tells the user that there is no warranty for the work (except to the
 extent that warranties are provided), that licensees may convey the
@@ -110,18 +115,18 @@ work under this License, and how to view a copy of this License.  If
 the interface presents a list of user commands or options, such as a
 menu, a prominent item in the list meets this criterion.
 
-## 1. Source Code.
+#### 1. Source Code.
 
-  The _"source code"_ for a work means the preferred form of the work
+The "source code" for a work means the preferred form of the work for
-for making modifications to it. _"Object code"_ means any non-source
+making modifications to it. "Object code" means any non-source form of
-form of a work.
+a work.
 
-  A _"Standard Interface"_ means an interface that either is an official
+A "Standard Interface" means an interface that either is an official
 standard defined by a recognized standards body, or, in the case of
 interfaces specified for a particular programming language, one that
 is widely used among developers working in that language.
 
-  The _"System Libraries"_ of an executable work include anything, other
+The "System Libraries" of an executable work include anything, other
 than the work as a whole, that (a) is included in the normal form of
 packaging a Major Component, but which is not part of that Major
 Component, and (b) serves only to enable use of the work with that
@@ -132,7 +137,7 @@ implementation is available to the public in source code form.  A
 (if any) on which the executable work runs, or a compiler used to
 produce the work, or an object code interpreter used to run it.
 
-  The _"Corresponding Source"_ for a work in object code form means all
+The "Corresponding Source" for a work in object code form means all
 the source code needed to generate, install, and (for an executable
 work) run the object code and to modify the work, including scripts to
 control those activities. However, it does not include the work's
@@ -145,16 +150,15 @@ linked subprograms that the work is specifically designed to require,
 such as by intimate data communication or control flow between those
 subprograms and other parts of the work.
 
-  The Corresponding Source need not include anything that users
+The Corresponding Source need not include anything that users can
-can regenerate automatically from other parts of the Corresponding
+regenerate automatically from other parts of the Corresponding Source.
-Source.
 
-  The Corresponding Source for a work in source code form is that
+The Corresponding Source for a work in source code form is that same
-same work.
+work.
 
-## 2. Basic Permissions.
+#### 2. Basic Permissions.
 
-  All rights granted under this License are granted for the term of
+All rights granted under this License are granted for the term of
 copyright on the Program, and are irrevocable provided the stated
 conditions are met. This License explicitly affirms your unlimited
 permission to run the unmodified Program. The output from running a
@@ -162,40 +166,40 @@ covered work is covered by this License only if the output, given its
 content, constitutes a covered work. This License acknowledges your
 rights of fair use or other equivalent, as provided by copyright law.
 
-  You may make, run and propagate covered works that you do not
+You may make, run and propagate covered works that you do not convey,
-convey, without conditions so long as your license otherwise remains
+without conditions so long as your license otherwise remains in force.
-in force.  You may convey covered works to others for the sole purpose
+You may convey covered works to others for the sole purpose of having
-of having them make modifications exclusively for you, or provide you
+them make modifications exclusively for you, or provide you with
-with facilities for running those works, provided that you comply with
+facilities for running those works, provided that you comply with the
-the terms of this License in conveying all material for which you do
+terms of this License in conveying all material for which you do not
-not control copyright.  Those thus making or running the covered works
+control copyright. Those thus making or running the covered works for
-for you must do so exclusively on your behalf, under your direction
+you must do so exclusively on your behalf, under your direction and
-and control, on terms that prohibit them from making any copies of
+control, on terms that prohibit them from making any copies of your
-your copyrighted material outside their relationship with you.
+copyrighted material outside their relationship with you.
 
-  Conveying under any other circumstances is permitted solely under
+Conveying under any other circumstances is permitted solely under the
-the conditions stated below.  Sublicensing is not allowed; section 10
+conditions stated below. Sublicensing is not allowed; section 10 makes
-makes it unnecessary.
+it unnecessary.
 
-## 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
 
-  No covered work shall be deemed part of an effective technological
+No covered work shall be deemed part of an effective technological
 measure under any applicable law fulfilling obligations under article
 11 of the WIPO copyright treaty adopted on 20 December 1996, or
 similar laws prohibiting or restricting circumvention of such
 measures.
 
-  When you convey a covered work, you waive any legal power to forbid
+When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
+circumvention of technological measures to the extent such
-is effected by exercising rights under this License with respect to
+circumvention is effected by exercising rights under this License with
-the covered work, and you disclaim any intention to limit operation or
+respect to the covered work, and you disclaim any intention to limit
-modification of the work as a means of enforcing, against the work's
+operation or modification of the work as a means of enforcing, against
-users, your or third parties' legal rights to forbid circumvention of
+the work's users, your or third parties' legal rights to forbid
-technological measures.
+circumvention of technological measures.
 
-## 4. Conveying Verbatim Copies.
+#### 4. Conveying Verbatim Copies.
 
-  You may convey verbatim copies of the Program's source code as you
+You may convey verbatim copies of the Program's source code as you
 receive it, in any medium, provided that you conspicuously and
 appropriately publish on each copy an appropriate copyright notice;
 keep intact all notices stating that this License and any
@@ -203,37 +207,35 @@ non-permissive terms added in accord with section 7 apply to the code;
 keep intact all notices of the absence of any warranty; and give all
 recipients a copy of this License along with the Program.
 
-  You may charge any price or no price for each copy that you convey,
+You may charge any price or no price for each copy that you convey,
 and you may offer support or warranty protection for a fee.
 
-## 5. Conveying Modified Source Versions.
+#### 5. Conveying Modified Source Versions.
 
-  You may convey a work based on the Program, or the modifications to
+You may convey a work based on the Program, or the modifications to
 produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
+terms of section 4, provided that you also meet all of these
+conditions:
 
-    a) The work must carry prominent notices stating that you modified
+-   a) The work must carry prominent notices stating that you modified
     it, and giving a relevant date.
-
+-   b) The work must carry prominent notices stating that it is
-    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under
-    released under this License and any conditions added under section
+    section 7. This requirement modifies the requirement in section 4
-    7.  This requirement modifies the requirement in section 4 to
+    to "keep intact all notices".
-    "keep intact all notices".
+-   c) You must license the entire work, as a whole, under this
-
-    c) You must license the entire work, as a whole, under this
     License to anyone who comes into possession of a copy. This
     License will therefore apply, along with any applicable section 7
     additional terms, to the whole of the work, and all its parts,
     regardless of how they are packaged. This License gives no
     permission to license the work in any other way, but it does not
     invalidate such permission if you have separately received it.
-
+-   d) If the work has interactive user interfaces, each must display
-    d) If the work has interactive user interfaces, each must display
     Appropriate Legal Notices; however, if the Program has interactive
     interfaces that do not display Appropriate Legal Notices, your
     work need not make them do so.
 
-  A compilation of a covered work with other separate and independent
+A compilation of a covered work with other separate and independent
 works, which are not by their nature extensions of the covered work,
 and which are not combined with it such as to form a larger program,
 in or on a volume of a storage or distribution medium, is called an
@@ -243,19 +245,18 @@ beyond what the individual works permit.  Inclusion of a covered work
 in an aggregate does not cause this License to apply to the other
 parts of the aggregate.
 
-## 6. Conveying Non-Source Forms.
+#### 6. Conveying Non-Source Forms.
 
-  You may convey a covered work in object code form under the terms
+You may convey a covered work in object code form under the terms of
-of sections 4 and 5, provided that you also convey the
+sections 4 and 5, provided that you also convey the machine-readable
-machine-readable Corresponding Source under the terms of this License,
+Corresponding Source under the terms of this License, in one of these
-in one of these ways:
+ways:
 
-    a) Convey the object code in, or embodied in, a physical product
+-   a) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by the
     Corresponding Source fixed on a durable physical medium
     customarily used for software interchange.
-
+-   b) Convey the object code in, or embodied in, a physical product
-    b) Convey the object code in, or embodied in, a physical product
     (including a physical distribution medium), accompanied by a
     written offer, valid for at least three years and valid for as
     long as you offer spare parts or customer support for that product
@@ -264,16 +265,14 @@ in one of these ways:
     product that is covered by this License, on a durable physical
     medium customarily used for software interchange, for a price no
     more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
+    conveying of source, or (2) access to copy the Corresponding
-    Corresponding Source from a network server at no charge.
+    Source from a network server at no charge.
-
+-   c) Convey individual copies of the object code with a copy of the
-    c) Convey individual copies of the object code with a copy of the
     written offer to provide the Corresponding Source. This
     alternative is allowed only occasionally and noncommercially, and
     only if you received the object code with such an offer, in accord
     with subsection 6b.
-
+-   d) Convey the object code by offering access from a designated
-    d) Convey the object code by offering access from a designated
     place (gratis or for a charge), and offer equivalent access to the
     Corresponding Source in the same way through the same place at no
     further charge. You need not require recipients to copy the
@@ -285,38 +284,38 @@ in one of these ways:
     Corresponding Source. Regardless of what server hosts the
     Corresponding Source, you remain obligated to ensure that it is
     available for as long as needed to satisfy these requirements.
+-   e) Convey the object code using peer-to-peer transmission,
+    provided you inform other peers where the object code and
+    Corresponding Source of the work are being offered to the general
+    public at no charge under subsection 6d.
 
-    e) Convey the object code using peer-to-peer transmission, provided
+A separable portion of the object code, whose source code is excluded
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
 from the Corresponding Source as a System Library, need not be
 included in conveying the object code work.
 
-  A _"User Product"_ is either (1) a _"consumer product"_, which means any
+A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
+tangible personal property which is normally used for personal,
-or household purposes, or (2) anything designed or sold for incorporation
+family, or household purposes, or (2) anything designed or sold for
-into a dwelling.  In determining whether a product is a consumer product,
+incorporation into a dwelling. In determining whether a product is a
-doubtful cases shall be resolved in favor of coverage.  For a particular
+consumer product, doubtful cases shall be resolved in favor of
-product received by a particular user, "normally used" refers to a
+coverage. For a particular product received by a particular user,
-typical or common use of that class of product, regardless of the status
+"normally used" refers to a typical or common use of that class of
-of the particular user or of the way in which the particular user
+product, regardless of the status of the particular user or of the way
-actually uses, or expects or is expected to use, the product.  A product
+in which the particular user actually uses, or expects or is expected
-is a consumer product regardless of whether the product has substantial
+to use, the product. A product is a consumer product regardless of
-commercial, industrial or non-consumer uses, unless such uses represent
+whether the product has substantial commercial, industrial or
-the only significant mode of use of the product.
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
 
-  _"Installation Information"_ for a User Product means any methods,
+"Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
+procedures, authorization keys, or other information required to
-and execute modified versions of a covered work in that User Product from
+install and execute modified versions of a covered work in that User
-a modified version of its Corresponding Source.  The information must
+Product from a modified version of its Corresponding Source. The
-suffice to ensure that the continued functioning of the modified object
+information must suffice to ensure that the continued functioning of
-code is in no case prevented or interfered with solely because
+the modified object code is in no case prevented or interfered with
-modification has been made.
+solely because modification has been made.
 
-  If you convey an object code work under this section in, or with, or
+If you convey an object code work under this section in, or with, or
 specifically for use in, a User Product, and the conveying occurs as
 part of a transaction in which the right of possession and use of the
 User Product is transferred to the recipient in perpetuity or for a
@@ -327,23 +326,24 @@ if neither you nor any third party retains the ability to install
 modified object code on the User Product (for example, the work has
 been installed in ROM).
 
-  The requirement to provide Installation Information does not include a
+The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
+requirement to continue to provide support service, warranty, or
-for a work that has been modified or installed by the recipient, or for
+updates for a work that has been modified or installed by the
-the User Product in which it has been modified or installed.  Access to a
+recipient, or for the User Product in which it has been modified or
-network may be denied when the modification itself materially and
+installed. Access to a network may be denied when the modification
-adversely affects the operation of the network or violates the rules and
+itself materially and adversely affects the operation of the network
-protocols for communication across the network.
+or violates the rules and protocols for communication across the
+network.
 
-  Corresponding Source conveyed, and Installation Information provided,
+Corresponding Source conveyed, and Installation Information provided,
 in accord with this section must be in a format that is publicly
 documented (and with an implementation available to the public in
 source code form), and must require no special password or key for
 unpacking, reading or copying.
 
-## 7. Additional Terms.
+#### 7. Additional Terms.
 
-  _"Additional permissions"_ are terms that supplement the terms of this
+"Additional permissions" are terms that supplement the terms of this
 License by making exceptions from one or more of its conditions.
 Additional permissions that are applicable to the entire Program shall
 be treated as though they were included in this License, to the extent
@@ -352,41 +352,36 @@ apply only to part of the Program, that part may be used separately
 under those permissions, but the entire Program remains governed by
 this License without regard to the additional permissions.
 
-  When you convey a copy of a covered work, you may at your option
+When you convey a copy of a covered work, you may at your option
 remove any additional permissions from that copy, or from any part of
 it. (Additional permissions may be written to require their own
 removal in certain cases when you modify the work.) You may place
 additional permissions on material, added by you to a covered work,
 for which you have or can give appropriate copyright permission.
 
-  Notwithstanding any other provision of this License, for material you
+Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
+add to a covered work, you may (if authorized by the copyright holders
-that material) supplement the terms of this License with terms:
+of that material) supplement the terms of this License with terms:
 
-    a) Disclaiming warranty or limiting liability differently from the
+-   a) Disclaiming warranty or limiting liability differently from the
     terms of sections 15 and 16 of this License; or
-
+-   b) Requiring preservation of specified reasonable legal notices or
-    b) Requiring preservation of specified reasonable legal notices or
     author attributions in that material or in the Appropriate Legal
     Notices displayed by works containing it; or
-
+-   c) Prohibiting misrepresentation of the origin of that material,
-    c) Prohibiting misrepresentation of the origin of that material, or
+    or requiring that modified versions of such material be marked in
-    requiring that modified versions of such material be marked in
     reasonable ways as different from the original version; or
-
+-   d) Limiting the use for publicity purposes of names of licensors
-    d) Limiting the use for publicity purposes of names of licensors or
+    or authors of the material; or
-    authors of the material; or
+-   e) Declining to grant rights under trademark law for use of some
-
-    e) Declining to grant rights under trademark law for use of some
     trade names, trademarks, or service marks; or
+-   f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions
+    of it) with contractual assumptions of liability to the recipient,
+    for any liability that these contractual assumptions directly
+    impose on those licensors and authors.
 
-    f) Requiring indemnification of licensors and authors of that
+All other non-permissive additional terms are considered "further
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
 restrictions" within the meaning of section 10. If the Program as you
 received it, or any part of it, contains a notice stating that it is
 governed by this License along with a term that is a further
@@ -396,47 +391,47 @@ License, you may add to a covered work material governed by the terms
 of that license document, provided that the further restriction does
 not survive such relicensing or conveying.
 
-  If you add terms to a covered work in accord with this section, you
+If you add terms to a covered work in accord with this section, you
 must place, in the relevant source files, a statement of the
 additional terms that apply to those files, or a notice indicating
 where to find the applicable terms.
 
-  Additional terms, permissive or non-permissive, may be stated in the
+Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
+form of a separately written license, or stated as exceptions; the
-the above requirements apply either way.
+above requirements apply either way.
 
-## 8. Termination.
+#### 8. Termination.
 
-  You may not propagate or modify a covered work except as expressly
+You may not propagate or modify a covered work except as expressly
 provided under this License. Any attempt otherwise to propagate or
 modify it is void, and will automatically terminate your rights under
 this License (including any patent licenses granted under the third
 paragraph of section 11).
 
-  However, if you cease all violation of this License, then your
+However, if you cease all violation of this License, then your license
-license from a particular copyright holder is reinstated (a)
+from a particular copyright holder is reinstated (a) provisionally,
-provisionally, unless and until the copyright holder explicitly and
+unless and until the copyright holder explicitly and finally
-finally terminates your license, and (b) permanently, if the copyright
+terminates your license, and (b) permanently, if the copyright holder
-holder fails to notify you of the violation by some reasonable means
+fails to notify you of the violation by some reasonable means prior to
-prior to 60 days after the cessation.
+60 days after the cessation.
 
-  Moreover, your license from a particular copyright holder is
+Moreover, your license from a particular copyright holder is
 reinstated permanently if the copyright holder notifies you of the
 violation by some reasonable means, this is the first time you have
 received notice of violation of this License (for any work) from that
 copyright holder, and you cure the violation prior to 30 days after
 your receipt of the notice.
 
-  Termination of your rights under this section does not terminate the
+Termination of your rights under this section does not terminate the
 licenses of parties who have received copies or rights from you under
 this License. If your rights have been terminated and not permanently
 reinstated, you do not qualify to receive new licenses for the same
 material under section 10.
 
-## 9. Acceptance Not Required for Having Copies.
+#### 9. Acceptance Not Required for Having Copies.
 
-  You are not required to accept this License in order to receive or
+You are not required to accept this License in order to receive or run
-run a copy of the Program.  Ancillary propagation of a covered work
+a copy of the Program. Ancillary propagation of a covered work
 occurring solely as a consequence of using peer-to-peer transmission
 to receive a copy likewise does not require acceptance. However,
 nothing other than this License grants you permission to propagate or
@@ -444,14 +439,14 @@ modify any covered work.  These actions infringe copyright if you do
 not accept this License. Therefore, by modifying or propagating a
 covered work, you indicate your acceptance of this License to do so.
 
-## 10. Automatic Licensing of Downstream Recipients.
+#### 10. Automatic Licensing of Downstream Recipients.
 
-  Each time you convey a covered work, the recipient automatically
+Each time you convey a covered work, the recipient automatically
 receives a license from the original licensors, to run, modify and
 propagate that work, subject to this License. You are not responsible
 for enforcing compliance by third parties with this License.
 
-  An _"entity transaction"_ is a transaction transferring control of an
+An "entity transaction" is a transaction transferring control of an
 organization, or substantially all assets of one, or subdividing an
 organization, or merging organizations. If propagation of a covered
 work results from an entity transaction, each party to that
@@ -461,7 +456,7 @@ give under the previous paragraph, plus a right to possession of the
 Corresponding Source of the work from the predecessor in interest, if
 the predecessor has it or can get it with reasonable efforts.
 
-  You may not impose any further restrictions on the exercise of the
+You may not impose any further restrictions on the exercise of the
 rights granted or affirmed under this License. For example, you may
 not impose a license fee, royalty, or other charge for exercise of
 rights granted under this License, and you may not initiate litigation
@@ -469,14 +464,14 @@ rights granted under this License, and you may not initiate litigation
 any patent claim is infringed by making, using, selling, offering for
 sale, or importing the Program or any portion of it.
 
-## 11. Patents.
+#### 11. Patents.
 
-  A _"contributor"_ is a copyright holder who authorizes use under this
+A "contributor" is a copyright holder who authorizes use under this
 License of the Program or a work on which the Program is based. The
 work thus licensed is called the contributor's "contributor version".
 
-  A contributor's _"essential patent claims"_ are all patent claims
+A contributor's "essential patent claims" are all patent claims owned
-owned or controlled by the contributor, whether already acquired or
+or controlled by the contributor, whether already acquired or
 hereafter acquired, that would be infringed by some manner, permitted
 by this License, of making, using, or selling its contributor version,
 but do not include claims that would be infringed only as a
@@ -485,19 +480,19 @@ purposes of this definition, "control" includes the right to grant
 patent sublicenses in a manner consistent with the requirements of
 this License.
 
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
+Each contributor grants you a non-exclusive, worldwide, royalty-free
 patent license under the contributor's essential patent claims, to
 make, use, sell, offer for sale, import and otherwise run, modify and
 propagate the contents of its contributor version.
 
-  In the following three paragraphs, a "patent license" is any express
+In the following three paragraphs, a "patent license" is any express
 agreement or commitment, however denominated, not to enforce a patent
 (such as an express permission to practice a patent or covenant not to
 sue for patent infringement). To "grant" such a patent license to a
 party means to make such an agreement or commitment not to enforce a
 patent against the party.
 
-  If you convey a covered work, knowingly relying on a patent license,
+If you convey a covered work, knowingly relying on a patent license,
 and the Corresponding Source of the work is not available for anyone
 to copy, free of charge and under the terms of this License, through a
 publicly available network server or other readily accessible means,
@@ -511,7 +506,7 @@ covered work in a country, or your recipient's use of the covered work
 in a country, would infringe one or more identifiable patents in that
 country that you have reason to believe are valid.
 
-  If, pursuant to or in connection with a single transaction or
+If, pursuant to or in connection with a single transaction or
 arrangement, you convey, or propagate by procuring conveyance of, a
 covered work, and grant a patent license to some of the parties
 receiving the covered work authorizing them to use, propagate, modify
@@ -519,40 +514,41 @@ or convey a specific copy of the covered work, then the patent license
 you grant is automatically extended to all recipients of the covered
 work and works based on it.
 
-  A patent license is "discriminatory" if it does not include within
+A patent license is "discriminatory" if it does not include within the
-the scope of its coverage, prohibits the exercise of, or is
+scope of its coverage, prohibits the exercise of, or is conditioned on
-conditioned on the non-exercise of one or more of the rights that are
+the non-exercise of one or more of the rights that are specifically
-specifically granted under this License.  You may not convey a covered
+granted under this License. You may not convey a covered work if you
-work if you are a party to an arrangement with a third party that is
+are a party to an arrangement with a third party that is in the
-in the business of distributing software, under which you make payment
+business of distributing software, under which you make payment to the
-to the third party based on the extent of your activity of conveying
+third party based on the extent of your activity of conveying the
-the work, and under which the third party grants, to any of the
+work, and under which the third party grants, to any of the parties
-parties who would receive the covered work from you, a discriminatory
+who would receive the covered work from you, a discriminatory patent
-patent license (a) in connection with copies of the covered work
+license (a) in connection with copies of the covered work conveyed by
-conveyed by you (or copies made from those copies), or (b) primarily
+you (or copies made from those copies), or (b) primarily for and in
-for and in connection with specific products or compilations that
+connection with specific products or compilations that contain the
-contain the covered work, unless you entered into that arrangement,
+covered work, unless you entered into that arrangement, or that patent
-or that patent license was granted, prior to 28 March 2007.
+license was granted, prior to 28 March 2007.
 
-  Nothing in this License shall be construed as excluding or limiting
+Nothing in this License shall be construed as excluding or limiting
 any implied license or other defenses to infringement that may
 otherwise be available to you under applicable patent law.
 
-## 12. No Surrender of Others' Freedom.
+#### 12. No Surrender of Others' Freedom.
 
-  If conditions are imposed on you (whether by court order, agreement or
+If conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
 excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
+covered work so as to satisfy simultaneously your obligations under
-License and any other pertinent obligations, then as a consequence you may
+this License and any other pertinent obligations, then as a
-not convey it at all.  For example, if you agree to terms that obligate you
+consequence you may not convey it at all. For example, if you agree to
-to collect a royalty for further conveying from those to whom you convey
+terms that obligate you to collect a royalty for further conveying
-the Program, the only way you could satisfy both those terms and this
+from those to whom you convey the Program, the only way you could
-License would be to refrain entirely from conveying the Program.
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
 
-## 13. Use with the GNU Affero General Public License.
+#### 13. Use with the GNU Affero General Public License.
 
-  Notwithstanding any other provision of this License, you have
+Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
 under version 3 of the GNU Affero General Public License into a single
 combined work, and to convey the resulting work. The terms of this
@@ -561,78 +557,78 @@ but the special requirements of the GNU Affero General Public License,
 section 13, concerning interaction through a network will apply to the
 combination as such.
 
-## 14. Revised Versions of this License.
+#### 14. Revised Versions of this License.
 
-  The Free Software Foundation may publish revised and/or new versions of
+The Free Software Foundation may publish revised and/or new versions
-the GNU General Public License from time to time.  Such new versions will
+of the GNU General Public License from time to time. Such new versions
-be similar in spirit to the present version, but may differ in detail to
+will be similar in spirit to the present version, but may differ in
-address new problems or concerns.
+detail to address new problems or concerns.
 
-  Each version is given a distinguishing version number.  If the
+Each version is given a distinguishing version number. If the Program
-Program specifies that a certain numbered version of the GNU General
+specifies that a certain numbered version of the GNU General Public
-Public License "or any later version" applies to it, you have the
+License "or any later version" applies to it, you have the option of
-option of following the terms and conditions either of that numbered
+following the terms and conditions either of that numbered version or
-version or of any later version published by the Free Software
+of any later version published by the Free Software Foundation. If the
-Foundation.  If the Program does not specify a version number of the
+Program does not specify a version number of the GNU General Public
-GNU General Public License, you may choose any version ever published
+License, you may choose any version ever published by the Free
-by the Free Software Foundation.
+Software Foundation.
 
-  If the Program specifies that a proxy can decide which future
+If the Program specifies that a proxy can decide which future versions
-versions of the GNU General Public License can be used, that proxy's
+of the GNU General Public License can be used, that proxy's public
-public statement of acceptance of a version permanently authorizes you
+statement of acceptance of a version permanently authorizes you to
-to choose that version for the Program.
+choose that version for the Program.
 
-  Later license versions may give you additional or different
+Later license versions may give you additional or different
 permissions. However, no additional obligations are imposed on any
 author or copyright holder as a result of your choosing to follow a
 later version.
 
-## 15. Disclaimer of Warranty.
+#### 15. Disclaimer of Warranty.
 
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
 
-## 16. Limitation of Liability.
+#### 16. Limitation of Liability.
 
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
-SUCH DAMAGES.
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 
-## 17. Interpretation of Sections 15 and 16.
+#### 17. Interpretation of Sections 15 and 16.
 
-  If the disclaimer of warranty and limitation of liability provided
+If the disclaimer of warranty and limitation of liability provided
 above cannot be given local legal effect according to their terms,
 reviewing courts shall apply local law that most closely approximates
 an absolute waiver of all civil liability in connection with the
 Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.
 
-# END OF TERMS AND CONDITIONS
+END OF TERMS AND CONDITIONS
---------------------------------------------------------------------------
 
+### How to Apply These Terms to Your New Programs
 
-# How to Apply These Terms to Your New Programs
+If you develop a new program, and you want it to be of the greatest
-
-  If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
+free software which everyone can redistribute and change under these
+terms.
 
-  To do so, attach the following notices to the program.  It is safest
+To do so, attach the following notices to the program. It is safest to
-to attach them to the start of each source file to most effectively
+attach them to the start of each source file to most effectively state
-state the exclusion of warranty; and each file should have at least
+the exclusion of warranty; and each file should have at least the
-the "copyright" line and a pointer to where the full notice is found.
+"copyright" line and a pointer to where the full notice is found.
 
         <one line to give the program's name and a brief idea of what it does.>
         Copyright (C) <year>  <name of author>
@@ -648,30 +644,32 @@ the "copyright" line and a pointer to where the full notice is found.
         GNU General Public License for more details.
 
         You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-Also add information on how to contact you by electronic and paper mail.
+Also add information on how to contact you by electronic and paper
+mail.
 
-  If the program does terminal interaction, make it output a short
+If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
         <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
+        This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
         This is free software, and you are welcome to redistribute it
-    under certain conditions; type 'show c' for details.
+        under certain conditions; type `show c' for details.
 
-  The hypothetical commands _'show w'_ and _'show c'_ should show the appropriate
+The hypothetical commands \`show w' and \`show c' should show the
-parts of the General Public License.  Of course, your program's commands
+appropriate parts of the General Public License. Of course, your
-might be different; for a GUI interface, you would use an "about box".
+program's commands might be different; for a GUI interface, you would
+use an "about box".
 
-  You should also get your employer (if you work as a programmer) or school,
+You should also get your employer (if you work as a programmer) or
-if any, to sign a "copyright disclaimer" for the program, if necessary.
+school, if any, to sign a "copyright disclaimer" for the program, if
-For more information on this, and how to apply and follow the GNU GPL, see
+necessary. For more information on this, and how to apply and follow
-<http://www.gnu.org/licenses/>.
+the GNU GPL, see <https://www.gnu.org/licenses/>.
 
-  The GNU General Public License does not permit incorporating your program
+The GNU General Public License does not permit incorporating your
-into proprietary programs.  If your program is a subroutine library, you
+program into proprietary programs. If your program is a subroutine
-may consider it more useful to permit linking proprietary applications with
+library, you may consider it more useful to permit linking proprietary
-the library.  If this is what you want to do, use the GNU Lesser General
+applications with the library. If this is what you want to do, use the
-Public License instead of this License.  But first, please read
+GNU Lesser General Public License instead of this License. But first,
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+please read <https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,10 +1,8 @@
-ChronoSync: synchronization library for distributed realtime applications for NDN
+# ChronoSync: synchronization library for distributed realtime applications for NDN
-=================================================================================
 
+![Language](https://img.shields.io/badge/C%2B%2B-14-blue.svg)
 [![Build Status](https://travis-ci.org/named-data/ChronoSync.svg?branch=master)](https://travis-ci.org/named-data/ChronoSync)
-
+![Latest Version](https://img.shields.io/github/tag/named-data/ChronoSync.svg?color=darkkhaki&label=latest%20version)
-If you are new to the NDN community of software generally, read the
-[Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md).
 
 In supporting many distributed applications, such as group text messaging, file sharing,
 and joint editing, a basic requirement is the efficient and robust synchronization of
@@ -19,28 +17,13 @@ be inferred from the digests and disseminated efficiently to all parties.  With
 complete and up-to-date knowledge of the dataset changes, applications can decide whether
 or when to fetch which pieces of the data.
 
-ChronoSync uses [ndn-cxx](https://github.com/named-data/ndn-cxx) library as NDN development
+ChronoSync uses the [ndn-cxx](https://github.com/named-data/ndn-cxx) library.
-library.
 
-ChronoSync is an open source project licensed under GPL 3.0 (see `COPYING.md` for more
+## Installation
-detail).  We highly welcome all contributions to the ChronoSync code base, provided that
-they can licensed under GPL 3.0+ or other compatible license.
-
-Feedback
---------
-
-Please submit any bugs or issues to the **ChronoSync** issue tracker:
-
-* https://redmine.named-data.net/projects/chronosync
-
-Installation instructions
--------------------------
 
 ### Prerequisites
 
-Required:
+* [ndn-cxx and its dependencies](https://named-data.net/doc/ndn-cxx/current/INSTALL.html)
-
-* [ndn-cxx and its dependencies](https://named-data.net/doc/ndn-cxx/)
 
 ### Build
 
@@ -53,5 +36,23 @@ To build ChronoSync from the source:
 To build on memory constrained platform, please use `./waf -j1` instead of `./waf`. The
 command will disable parallel compilation.
 
-If configured with tests: `./waf configure --with-tests`), the above commands will also
+If configured with tests (`./waf configure --with-tests`), the above commands will also
-generate unit tests in `./build/unit-tests`
+generate unit tests that can be run with `./build/unit-tests`.
+
+## Reporting bugs
+
+Please submit any bug reports or feature requests to the
+[ChronoSync issue tracker](https://redmine.named-data.net/projects/chronosync/issues).
+
+## Contributing
+
+We greatly appreciate contributions to the ChronoSync code base, provided that they are
+licensed under the GPL 3.0+ or a compatible license (see below).
+If you are new to the NDN software community, please read the
+[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md)
+to get started.
+
+## License
+
+ChronoSync is an open source project licensed under the GPL version 3.
+See [`COPYING.md`](COPYING.md) for more information.

docs/conf.py

@@ -1,30 +1,46 @@
 # -*- coding: utf-8 -*-
 #
-# NFD - Named Data Networking Forwarding Daemon documentation build configuration file, created by
+# Configuration file for the Sphinx documentation builder.
-# sphinx-quickstart on Sun Apr  6 19:58:22 2014.
 #
-# This file is execfile()d with the current directory set to its
+# This file only contains a selection of the most common options. For a full
-# containing dir.
+# list see the documentation:
-#
+# http://www.sphinx-doc.org/en/master/config
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
 
-import sys
+# -- Path setup --------------------------------------------------------------
-import os
-import re
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+#
+# import os
+import sys
+# sys.path.insert(0, os.path.abspath('.'))
 
-# -- General configuration ------------------------------------------------
+
+# -- Project information -----------------------------------------------------
+
+project = u'ChronoSync: A Synchronization Protocol for NDN'
+copyright = u'Copyright © 2012-2020 Regents of the University of California.'
+author = u'Named Data Networking Project'
+
+# The short X.Y version
+#version = ''
+
+# The full version, including alpha/beta/rc tags
+#release = ''
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%Y-%m-%d'
+
+
+# -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+#
+needs_sphinx = '1.1'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -38,221 +54,81 @@ def addExtensionIfExists(extension):
         __import__(extension)
         extensions.append(extension)
     except ImportError:
-        sys.stderr.write("Extension '%s' in not available. "
+        sys.stderr.write("Extension '%s' not found. "
                          "Some documentation may not build correctly.\n" % extension)
-        sys.stderr.write("To install, use \n"
-                         "  sudo pip install %s\n" % extension.replace('.', '-'))
 
-if sys.version_info[0] >= 3:
+addExtensionIfExists('sphinxcontrib.doxylink')
-    addExtensionIfExists('sphinxcontrib.doxylink')
-
-# sphinxcontrib.googleanalytics is currently not working with the latest version of sphinx
-# if os.getenv('GOOGLE_ANALYTICS', None):
-#     addExtensionIfExists('sphinxcontrib.googleanalytics')
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
+# Add any paths that contain templates here, relative to this directory.
-project = u'ChronoSync: A Synchronization Protocol in NDN'
+templates_path = ['_templates']
-copyright = u'2017, Named Data Networking Project'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+# This pattern also affects html_static_path and html_extra_path.
-
+exclude_patterns = ['RELEASE_NOTES.rst']
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
 
 
-# -- Options for HTML output ----------------------------------------------
+# -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-# html_theme = 'default'
+#
 html_theme = 'named_data_theme'
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['./']
+html_theme_path = ['.']
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-html_file_suffix = ".html"
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'ChronoSync-docs'
 
 
-# -- Options for LaTeX output ---------------------------------------------
+# -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    #
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    #
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
+    # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'ChronoSync-docs.tex', u'A Synchronization Protocol in NDN',
+    ('index', 'ChronoSync-docs.tex', u'A Synchronization Protocol for NDN',
-   u'Named Data Networking Project', 'manual'),
+     author, 'manual'),
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
 
-# For "manual" documents, if this is true, then toplevel headings are parts,
+# -- Options for manual page output ------------------------------------------
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
 ]
 
-
 # If true, show URL addresses after external links.
-man_show_urls = True
+#man_show_urls = True
 
 
-# ---- Custom options --------
+# -- Custom options ----------------------------------------------------------
 
 doxylink = {
-  'ChronoSync' : ('ChronoSync.tag', 'doxygen/'),
+    'ChronoSync': ('ChronoSync.tag', 'doxygen/'),
 }
-
-if os.getenv('GOOGLE_ANALYTICS', None):
-    googleanalytics_id = os.environ['GOOGLE_ANALYTICS']
-    googleanalytics_enabled = True
-
-exclude_patterns = ['RELEASE_NOTES.rst']

waf

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # encoding: latin-1
 # Thomas Nagy, 2005-2018
 #