ensure that all docs use all entities files

[apt.git] / prepare-release

diff --git a/prepare-release b/prepare-release
index 73c0be602bd337fc766a186181028cdb23d7eab0..1b8f1e49e5df1950eb8e00875a731bbec14b23dc 100755 (executable)
--- a/prepare-release
+++ b/prepare-release
@@ -1,11 +1,30 @@
 #!/bin/sh
 #!/bin/sh

+set -e
+
+cd "$(readlink -f $(dirname $0))"
+
+if [ -n "${GBP_BUILD_DIR}" ]; then
+   cd "$GBP_BUILD_DIR"
+fi

 
 VERSION=$(dpkg-parsechangelog | sed -n -e '/^Version:/s/^Version: //p')
 DISTRIBUTION=$(dpkg-parsechangelog | sed -n -e '/^Distribution:/s/^Distribution: //p')
 
 
 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/init.h | sed 's/\.$//')"
+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="$(egrep '^MAJOR=' apt-inst/makefile |cut -d '=' -f 2)"
 

+librarysymbolsfromfile() {
+       local MISSING="$(grep '^+#MISSING' "$1")"
+       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"
+       done | sort -u
+}
+

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


@@ -39,41 +58,77 @@ if [ "$1" = 'pre-export' ]; then
                make update-po
        fi
 
                make update-po
        fi
 

-       sed -i -e "s/^PACKAGE_VERSION=\".*\"$/PACKAGE_VERSION=\"${VERSION}\"/" configure.in
+       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
        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

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

        else
                echo >&2 'REMEMBER: Change to a valid distribution before release'
        fi
        else
                echo >&2 'REMEMBER: Change to a valid distribution before release'
        fi

-       if ! xmllint --nonet --valid --noout $(find doc/ -maxdepth 1 -name '*.xml'); then
-               echo >&2 'WARNING: original docbook manpages have errors!'
-       elif ! xmllint --nonet --valid --noout $(find doc/ -mindepth 2 -maxdepth 2 -name '*.xml'); then
-               echo >&2 'WARNING: translated docbook manpages have errors, but originals are okay!'
+
+       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
+               if ! xmllint --nonet --valid --noout $(find doc/ -maxdepth 1 -name '*.xml'); then
+                       echo >&2 "WARNING: original docbook manpages have errors with vendor ${DISTRO}!"
+               fi
+       done
+       # lets assume we will always have a german manpage translation
+       if [ -e 'doc/de/' ]; then
+               # … 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
+                       echo >&2 "WARNING: translated docbook manpages have errors!"
+               fi
+       else
+               echo >&2 "ERROR: translated manpages need to be build before they can be checked!"

        fi
        fi

+       rm -f doc/apt-vendor.ent
+

 elif [ "$1" = 'library' ]; then
        librarysymbols() {
                echo "Checking $1 in version $2"
                local tmpfile=$(mktemp)
 elif [ "$1" = 'library' ]; then
        librarysymbols() {
                echo "Checking $1 in version $2"
                local tmpfile=$(mktemp)

-               dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile
-               echo '=== Missing symbols:'
-               grep '^+#MISSING' $tmpfile
-               echo '=== New symbols:'
-               grep '^+ ' $tmpfile | cut -d' ' -f 2 | cut -d'@' -f 1 | c++filt | while read line; do
-                       echo " (c++)\"${line}@Base\" $VERSION"
-               done | sort -u
-               rm $tmpfile
+               dpkg-gensymbols -p${1}${2} -ebuild/bin/${1}.so.${2} -Idebian/${1}${2}.symbols -O/dev/null 2> /dev/null > $tmpfile || true
+               librarysymbolsfromfile "$tmpfile"
+               rm -f $tmpfile

        }
        librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"
        echo
        librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"
        }
        librarysymbols 'libapt-pkg' "${LIBAPTPKGVERSION}"
        echo
        librarysymbols 'libapt-inst' "${LIBAPTINSTVERSION}"

+elif [ "$1" = 'buildlog' ]; then
+       while [ -n "$2" ]; do
+               librarysymbolsfromfile "$2"
+               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 -q --no-install-recommends $(sed -n 's#^Depends: .*@, \(.*\)$#\1#p' debian/tests/control | tr -d ',')

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

-If you use »bzr builddeb« you can leave this script alone as it will
+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.
 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.