gitignore: Add generated docbook stylesheets

[apt.git] / prepare-release

diff --git a/prepare-release b/prepare-release
index 3c81a21cbdf5fa1246ea5d3cdf2dbfe5c05d1e04..0004de3103ad2745cb69efa8459b6ef7a6d1e231 100755 (executable)
--- a/prepare-release
+++ b/prepare-release
@@ -11,20 +11,41 @@ VERSION=$(dpkg-parsechangelog | sed -n -e '/^Version:/s/^Version: //p')
 DISTRIBUTION=$(dpkg-parsechangelog | sed -n -e '/^Distribution:/s/^Distribution: //p')
 
 LIBAPTPKGVERSION="$(awk -v ORS='.' '/^\#define APT_PKG_M/ {print $3}' apt-pkg/contrib/macros.h | sed 's/\.$//')"
 DISTRIBUTION=$(dpkg-parsechangelog | sed -n -e '/^Distribution:/s/^Distribution: //p')
 
 LIBAPTPKGVERSION="$(awk -v ORS='.' '/^\#define APT_PKG_M/ {print $3}' apt-pkg/contrib/macros.h | sed 's/\.$//')"

-LIBAPTINSTVERSION="$(egrep '^MAJOR=' apt-inst/makefile |cut -d '=' -f 2)"
+LIBAPTINSTVERSION="$(sed -nr 's/set\(MAJOR ([^)]*)\)/\1/p' apt-inst/CMakeLists.txt)"

 
 librarysymbolsfromfile() {
        local MISSING="$(grep '^+#MISSING' "$1")"
 
 librarysymbolsfromfile() {
        local MISSING="$(grep '^+#MISSING' "$1")"

+       local SYMVER="$2"

        echo '=== Missing optional symbols:'
        echo -n "$MISSING" | grep '|optional=' || true
        echo '=== Missing required symbols:'
        echo -n "$MISSING" | grep -v '|optional=' || true
        echo '=== New symbols:'
        echo '=== Missing optional symbols:'
        echo -n "$MISSING" | grep '|optional=' || true
        echo '=== Missing required symbols:'
        echo -n "$MISSING" | grep -v '|optional=' || true
        echo '=== New symbols:'

-       grep '^+ ' "$1" | cut -d' ' -f 2 | cut -d'@' -f 1 | c++filt | while read line; do
-               echo " (c++)\"${line}@Base\" $VERSION"
+       grep '^+ ' "$1" | grep -v '^+ (c++' | cut -d' ' -f 2 | cut -d'@' -f 1 | c++filt | while read line; do
+               echo " (c++)\"${line}@${SYMVER}\" $VERSION"

        done | sort -u
 }
 
        done | sort -u
 }
 

+test_deb_control() {
+       echo "Package: apt-test-depends"
+       echo "Version: 1.0"
+       echo "Architecture: all"
+       printf "Depends:"
+       (
+       for i in Build-Depends Build-Depends-Indep Build-Depends-Arch; do
+               grep-dctrl -ns $i -S apt ./debian/control && echo ,
+       done
+               grep-dctrl -ns Depends -F Tests run-tests ./debian/tests/control
+       ) | tr '\n' ' '\
+         | sed -r -e 's#<[^,<>()@]*>##g' \
+                  -e 's#@[^,<>()@]*@##g' \
+                  -e 's#dpkg-dev \([^)]*\)#dpkg-dev#g' \
+                  -e 's#debhelper \([^)]*\)#debhelper#g' \
+                  -e 's#@##g' \
+                  -e 's#,(\s+,)+#, #g' \
+                  -e 's#\s+# #g'
+}
+

 if [ "$1" = 'pre-export' ]; then
        libraryversioncheck() {
                local LIBRARY="$1"
 if [ "$1" = 'pre-export' ]; then
        libraryversioncheck() {
                local LIBRARY="$1"


@@ -52,23 +73,62 @@ if [ "$1" = 'pre-export' ]; then
                VERSION="$VERSION~$(date +%Y%m%d)"
        fi
 
                VERSION="$VERSION~$(date +%Y%m%d)"
        fi
 

+       sed -i -e "s/^set(PACKAGE_VERSION \".*\")$/set(PACKAGE_VERSION \"${VERSION}\")/" CMakeLists.txt
+       sed -i -e "s/^<!ENTITY apt-product-version \".*\">$/<!ENTITY apt-product-version \"${VERSION}\">/" doc/apt-verbatim.ent
+
+       # update the last-modification field of manpages based on git changes
+       grep --files-with-matches '<date>' doc/*.xml | while read file; do \
+               LASTMOD="$(date -d "@$(git log --format='%at' --max-count=1 --invert-grep --fixed-strings --grep 'review
+typo
+release
+Git-Dch: Ignore' "$file")" '+%Y-%m-%dT00:00:00Z')"
+               sed -i -e "s#^\([ ]\+\)<date>.*</date>\$#\1<date>$LASTMOD</date>#" "$file"
+       done
+

        if [ "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' po/apt-all.pot | cut -d' ' -f 2)" -o \
             "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' doc/po/apt-doc.pot | cut -d' ' -f 2)" ]; then
                echo >&2 'POT files are not up-to-date. Execute »make update-po« for you…'
        if [ "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' po/apt-all.pot | cut -d' ' -f 2)" -o \
             "$(date +%Y-%m-%d)" != "$(grep --max-count=1 '^"POT-Creation-Date: .*\n"$' doc/po/apt-doc.pot | cut -d' ' -f 2)" ]; then
                echo >&2 'POT files are not up-to-date. Execute »make update-po« for you…'

-               make update-po
+               [ -e build ] || mkdir build
+               ( cd build && cmake .. )
+               cmake --build build --target update-po -- -j 4
+       fi
+elif [ "$1" = 'pre-build' ]; then
+       if [ "$DISTRIBUTION" = "UNRELEASED" ]; then
+               echo 'BUILDING AN UNRELEASED VERSION'
+       else
+               CONFVERSION="$(sed -ne "s/^set(PACKAGE_VERSION \"\(.*\)\")$/\1/p" CMakeLists.txt)"
+               if [ "$VERSION" != "$CONFVERSION" ]; then
+                       echo "changelog (${VERSION}) and CMakeLists.txt (${CONFVERSION}) talk about different versions!"
+                       echo "You probably want to run »./prepare-release pre-export« to fix this."
+                       exit 1
+               fi

        fi
        fi

-
-       sed -i -e "s/^PACKAGE_VERSION=\".*\"$/PACKAGE_VERSION=\"${VERSION}\"/" configure.ac
-       sed -i -e "s/^<!ENTITY apt-product-version \".*\">$/<!ENTITY apt-product-version \"${VERSION}\">/" doc/apt-verbatim.ent

 elif [ "$1" = 'post-build' ]; then
        if [ "$DISTRIBUTION" != "UNRELEASED" ]; then
 elif [ "$1" = 'post-build' ]; then
        if [ "$DISTRIBUTION" != "UNRELEASED" ]; then

-               echo >&2 "REMEMBER: Tag this release with »git tag ${VERSION}« if you are satisfied"
+               echo >&2 "REMEMBER: Tag this release with »git tag -s ${VERSION}« if you are satisfied"

        else
                echo >&2 'REMEMBER: Change to a valid distribution before release'
        fi
 
        dpkg-checkbuilddeps -d 'libxml2-utils'
 
        else
                echo >&2 'REMEMBER: Change to a valid distribution before release'
        fi
 
        dpkg-checkbuilddeps -d 'libxml2-utils'
 

+       HEADERBLUEPRINT="$(mktemp)"
+       sed -n '1,/^$/p' doc/apt.8.xml > "$HEADERBLUEPRINT"
+       find doc -mindepth 1 -maxdepth 1 -type f -name '*.xml' | while read FILE; do
+               if ! sed -n '1,/^$/p' "$FILE" | cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
+                       echo >&2 "WARNING: Manpage $FILE has not the usual header! (see diff below)"
+                       sed -n '1,/^$/p' "$FILE" | diff -u "$HEADERBLUEPRINT" - || true
+               fi
+       done
+       sed -n '1,/^$/p' doc/guide.dbk > "$HEADERBLUEPRINT"
+       find doc -mindepth 1 -maxdepth 1 -type f -name '*.dbk' | while read FILE; do
+               if ! sed -n '1,/^$/p' "$FILE" | cmp "$HEADERBLUEPRINT" - >/dev/null 2>&1; then
+                       echo >&2 "WARNING: Documentation $FILE has not the usual header (see diff below)!"
+                       sed -n '1,/^$/p' "$FILE" | diff -u "$HEADERBLUEPRINT" - || true
+               fi
+       done
+       rm "$HEADERBLUEPRINT"
+

        # check the manpages with each vendor for vendor-specific errors…
        find vendor -mindepth 1 -maxdepth 1 -type d | cut -d'/' -f 2 | while read DISTRO; do
                ln -sf ../vendor/${DISTRO}/apt-vendor.ent doc
        # check the manpages with each vendor for vendor-specific errors…
        find vendor -mindepth 1 -maxdepth 1 -type d | cut -d'/' -f 2 | while read DISTRO; do
                ln -sf ../vendor/${DISTRO}/apt-vendor.ent doc


@@ -77,9 +137,11 @@ elif [ "$1" = 'post-build' ]; then
                fi
        done
        # lets assume we will always have a german manpage translation
                fi
        done
        # lets assume we will always have a german manpage translation

-       if [ -e 'doc/de/' ]; then
+       if [ -e */doc/de/ -o -e doc/de ]; then

                # … but check the translations only with one vendor for translation-specific errors
                # … but check the translations only with one vendor for translation-specific errors

-               if ! xmllint --nonet --valid --noout $(find doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then
+               if ! xmllint  --path /vendor/$(./vendor/getinfo current)/ \
+                                         --path doc/ \
+                                       --nonet --valid --noout $(find doc/ */doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then

                        echo >&2 "WARNING: translated docbook manpages have errors!"
                fi
        else
                        echo >&2 "WARNING: translated docbook manpages have errors!"
                fi
        else


@@ -89,10 +151,22 @@ elif [ "$1" = 'post-build' ]; then
 
 elif [ "$1" = 'library' ]; then
        librarysymbols() {
 
 elif [ "$1" = 'library' ]; then
        librarysymbols() {

-               echo "Checking $1 in version $2"
+               local libname=$(echo "${1}" | cut -c 4-)
+               local buildlib="build/bin/${1}.so.${2}"
+               for dir in $libname */$libname; do
+                       local new_buildlib="$dir/${1}.so.${2}"
+                       if [  -r "${new_buildlib}" ] && [ ! -e "$buildlib" -o "$new_buildlib" -nt "$buildlib" ]; then
+                               local buildlib="${new_buildlib}"
+                       fi
+               done
+               if [ ! -r "$buildlib" ]; then
+                       echo "ERROR: The library ${1} has to be built before symbols can be checked!"
+                       return
+               fi
+               echo "Checking $1 in version $2 build at $(stat -L -c '%y' "$buildlib")"

                local tmpfile=$(mktemp)
                local tmpfile=$(mktemp)

-               dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile || true
-               librarysymbolsfromfile "$tmpfile"
+               dpkg-gensymbols -p${1}${2} -e${buildlib} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile || true
+               librarysymbolsfromfile "$tmpfile" "$(echo "${1}" | cut -c 4- | tr -d '-' | tr 'a-z' 'A-Z')_${2}"

                rm -f $tmpfile
        }
        librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"
                rm -f $tmpfile
        }
        librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"


@@ -100,21 +174,74 @@ elif [ "$1" = 'library' ]; then
        librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"
 elif [ "$1" = 'buildlog' ]; then
        while [ -n "$2" ]; do
        librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"
 elif [ "$1" = 'buildlog' ]; then
        while [ -n "$2" ]; do

-               librarysymbolsfromfile "$2"
+               librarysymbolsfromfile "$2" 'UNKNOWN'

                shift
        done
 elif [ "$1" = 'travis-ci' ]; then
                shift
        done
 elif [ "$1" = 'travis-ci' ]; then

-       apt-get install -q --no-install-recommends $(sed -n -e '/^Build-Depends: /,/^Build-Depends-Indep: / {p}' debian/control | sed -e 's#([^)]*)##g' -e 's#^Build-Depends\(-Indep\)\?: ##' | tr -d ',')
+       apt-get install -qy --no-install-recommends dctrl-tools equivs gdebi-core moreutils
+
+       test_deb_control > test-control
+       equivs-build test-control
+       gdebi -n apt-test-depends_1.0_all.deb
+elif [ "$1" = 'coverage' ]; then
+       DIR="${2:-./coverage}"
+       git clean -dfX # remove ignored build artefacts for a clean start
+       make CFLAGS+='--coverage' CXXFLAGS+='--coverage'
+       LCOVRC='--rc geninfo_checksum=1 --rc lcov_branch_coverage=1'
+       mkdir "$DIR"
+       lcov --no-external --directory . --capture --initial --output-file "${DIR}/apt.coverage.init" ${LCOVRC}
+       make test || true
+       ./test/integration/run-tests -q || true
+       lcov --no-external --directory . --capture --output-file "${DIR}/apt.coverage.run" ${LCOVRC}
+       lcov -a "${DIR}/apt.coverage.init" -a "${DIR}/apt.coverage.run"  -o "${DIR}/apt.coverage.total" ${LCOVRC}
+       cp "${DIR}/apt.coverage.total" "${DIR}/apt.coverage.fixed"
+       rewritefile() {
+               file="$1"
+               shift
+               name="$(basename "$file")"
+               while [ -n "$1" ]; do
+                       if [ -r "$1/$name" ]; then
+                               sed -i "s#$file#$1/$name#" "${DIR}/apt.coverage.fixed"
+                               break
+                       fi
+                       shift
+               done
+               if [ -z "$1" ]; then
+                       echo >&2 "Coverage data captured for unknown file $file"
+               fi
+       }
+       grep 'build/include/' "${DIR}/apt.coverage.fixed" | sed "s#^SF:$(pwd)/##" | while read file; do
+               rewritefile "$file" 'apt-pkg' 'apt-pkg/deb' 'apt-pkg/edsp' 'apt-pkg/contrib' \
+                  'apt-inst' 'apt-inst/deb' 'apt-inst/contrib' 'apt-private'
+       done
+       genhtml --output-directory "${DIR}" "${DIR}/apt.coverage.fixed" ${LCOVRC}

 else
        echo >&1 "Usage:\t$0 pre-export
 else
        echo >&1 "Usage:\t$0 pre-export

+\t$0 pre-build

 \t$0 post-build
 \t$0 post-build

+
+Updating po-files and versions as well as some basic checks are done
+by »pre-export« which needs to be run before package building.
+If you use »gbp buildpackage« you will be notified if you forget.
+»pre-build« and »post-build« can be used to run some more or less
+useful checks automatically run by »gbp« otherwise.
+

 \t$0 library
 \t$0 library

+\t$0 buildlog filename…
+
+»library« and »buildlog« aren't run automatically but can be useful for
+maintaining the (more or less experimental) symbols files we provide.
+»library« displays the diff between advertised symbols and the once provided
+by the libraries, while »buildlog« extracts this diff from the buildlogs.
+Both will format the diff properly.
+
+\t$0 travis-ci
+\t$0 coverage [output-dir]

 
 

-If you use »git buildpackage« you can leave this script alone as it will
-be run at the right places auto-magically. Otherwise you should use
-»pre-export« to update po and pot files as well as version numbering.
-»post-build« can be used to run some more or less useful checks later on.
+»travis-ci« is a shortcut to install all build- as well as test-dependencies
+used by .travis.yml.
+»coverage« does a clean build with the right flags for coverage reporting,
+runs all tests and generates a html report in the end.
+"

 
 

-»library« isn't run automatically but can be useful for maintaining the
-(more or less experimental) symbols files we provide"

 fi
 fi