Browse Source

ensure that all docs use all entities files

Not all are needed for all files at the moment, but the new docbook
building hadn't available some of the entities it used as the files
weren't correctly copied around in all cases and having the same across
the bord makes working with all of them a little easier.

Git-Dch: Ignore
tags/devuan/2.0.1+devuan1
David Kalnischkies 6 years ago
parent
commit
5abbf5bbb5
23 changed files with 75 additions and 133 deletions
  1. +3
    -2
      buildlib/docbook.mak
  2. +3
    -9
      doc/apt-cache.8.xml
  3. +3
    -9
      doc/apt-cdrom.8.xml
  4. +3
    -9
      doc/apt-config.8.xml
  5. +3
    -9
      doc/apt-extracttemplates.1.xml
  6. +3
    -9
      doc/apt-ftparchive.1.xml
  7. +3
    -9
      doc/apt-get.8.xml
  8. +3
    -9
      doc/apt-key.8.xml
  9. +3
    -9
      doc/apt-mark.8.xml
  10. +3
    -9
      doc/apt-secure.8.xml
  11. +3
    -9
      doc/apt-sortpkgs.1.xml
  12. +3
    -7
      doc/apt.8.xml
  13. +3
    -9
      doc/apt.conf.5.xml
  14. +3
    -9
      doc/apt_preferences.5.xml
  15. +2
    -1
      doc/design.dbk
  16. +2
    -1
      doc/dpkg-tech.dbk
  17. +2
    -1
      doc/files.dbk
  18. +2
    -1
      doc/guide.dbk
  19. +1
    -1
      doc/makefile
  20. +2
    -1
      doc/method.dbk
  21. +2
    -1
      doc/offline.dbk
  22. +3
    -9
      doc/sources.list.5.xml
  23. +17
    -0
      prepare-release

+ 3
- 2
buildlib/docbook.mak View File

@@ -13,6 +13,7 @@
LOCAL := docbook-$(firstword $(SOURCE))
$(LOCAL)-HTML := $(addsuffix .html,$(addprefix $(DOC)/,$(basename $(SOURCE))))
$(LOCAL)-TEXT := $(addsuffix .text,$(addprefix $(DOC)/,$(basename $(SOURCE))))
INCLUDES = apt.ent apt-verbatim.ent apt-vendor.ent

docbook:

@@ -30,7 +31,7 @@ veryclean: veryclean/html/$(LOCAL)

vpath %.dbk $(SUBDIRS)
vpath $(DOCBOOK_HTML_STYLESHEET) $(SUBDIRS)
$(DOC)/%.html: %.dbk $(DOCBOOK_HTML_STYLESHEET)
$(DOC)/%.html: %.dbk $(DOCBOOK_HTML_STYLESHEET) $(INCLUDES)
echo Creating html for $< to $@
-rm -rf $@
mkdir -p $@
@@ -59,7 +60,7 @@ veryclean: veryclean/text/$(LOCAL)

vpath %.dbk $(SUBDIRS)
vpath $(DOCBOOK_TEXT_STYLESHEET) $(SUBDIRS)
$(DOC)/%.text: %.dbk $(DOCBOOK_TEXT_STYLESHEET)
$(DOC)/%.text: %.dbk $(DOCBOOK_TEXT_STYLESHEET) $(INCLUDES)
echo Creating text for $< to $@
$(DOCBOOK) \
--stringparam l10n.gentext.default.language $(LC) \


+ 3
- 9
doc/apt-cache.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-cdrom.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-config.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-extracttemplates.1.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-ftparchive.1.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-get.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-key.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-mark.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-secure.8.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt-sortpkgs.1.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 7
doc/apt.8.xml View File

@@ -1,13 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt.conf.5.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 3
- 9
doc/apt_preferences.5.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 2
- 1
doc/design.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 2
- 1
doc/dpkg-tech.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 2
- 1
doc/files.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 2
- 1
doc/guide.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 1
- 1
doc/makefile View File

@@ -29,7 +29,7 @@ include $(COPY_H)
clean: clean/subdirs clean/examples
veryclean: veryclean/subdirs clean/examples
manpages: apt-vendor.ent manpages/subdirs
docbook: docbook/subdirs
docbook: apt-vendor.ent docbook/subdirs

DOCUMENTATIONPO = $(patsubst %.po,%,$(notdir $(wildcard po/*.po)))
DOCDIRLIST = $(addsuffix /makefile,$(DOCUMENTATIONPO))


+ 2
- 1
doc/method.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 2
- 1
doc/offline.dbk View File

@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- -*- DocBook -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<book lang="en">


+ 3
- 9
doc/sources.list.5.xml View File

@@ -1,15 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
%aptvendor;
<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
]>

<refentry>


+ 17
- 0
prepare-release View File

@@ -69,6 +69,23 @@ elif [ "$1" = 'post-build' ]; then

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


Loading…
Cancel
Save