diff options
author | Anthony Fok <foka@debian.org> | 2015-09-10 16:48:31 -0600 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2015-09-11 09:17:51 +0200 |
commit | d8a30df2be787e7352c5ab56948a8bdf04303cf2 (patch) | |
tree | a5b8bcd4d083065ac878af82627a989ec64b4aa6 | |
parent | 881087af0af08f028c3b08a6cc9407942999f74a (diff) |
Fix SGML validation errors in documentation
* Close all <xref> tags
* Change bare "&" to "&"
* Add a missing </para> tag
* Add a missing ";" to an entity
-rw-r--r-- | docs/chapters/building.sgml | 12 | ||||
-rw-r--r-- | docs/chapters/cfgfile.sgml | 2 | ||||
-rw-r--r-- | docs/chapters/import.sgml | 3 | ||||
-rw-r--r-- | docs/chapters/intro.sgml | 2 | ||||
-rw-r--r-- | docs/manpages/gbp-buildpackage-rpm.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/gbp-buildpackage.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/gbp-clone.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/gbp-config.sgml | 2 | ||||
-rw-r--r-- | docs/manpages/gbp-create-remote-repo.sgml | 8 | ||||
-rw-r--r-- | docs/manpages/gbp-dch.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/gbp-import-dsc.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/gbp-import-dscs.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/gbp-import-orig.sgml | 10 | ||||
-rw-r--r-- | docs/manpages/gbp-import-srpm.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/gbp-pq-rpm.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/gbp-pq.sgml | 6 | ||||
-rw-r--r-- | docs/manpages/gbp-pull.sgml | 8 | ||||
-rw-r--r-- | docs/manpages/gbp.conf.sgml | 26 | ||||
-rw-r--r-- | docs/manpages/gbp.sgml | 20 | ||||
-rw-r--r-- | docs/manpages/man.conffiles.sgml | 2 |
20 files changed, 83 insertions, 82 deletions
diff --git a/docs/chapters/building.sgml b/docs/chapters/building.sgml index bddbe240..08bb9ca3 100644 --- a/docs/chapters/building.sgml +++ b/docs/chapters/building.sgml @@ -87,7 +87,7 @@ export-dir=../build-area <title>Running lintian</title> <para>&gbp-buildpackage; exports several variables into the <option>posttag</option>'s environment (for details see the <xref - linkend="man.gbp.buildpackage">). + linkend="man.gbp.buildpackage"/>). To invoke &lintian;, we need to tell it where to find the changes file: <programlisting> <command>git-buildpackage</command> <option>--git-postbuild</option>=<replaceable>'lintian $GBP_CHANGES_FILE'</replaceable> @@ -104,7 +104,7 @@ export-dir=../build-area <para>If you want to push your changes automatically after a successful build and tag, you can use &gbp-buildpackage;'s posttag hook. A very simple invocation would look like this: <programlisting> -<command>git-buildpackage</command> <option>--git-tag</option> <option>--git-posttag</option>=<replaceable>"git push && git push --tags"</replaceable> +<command>git-buildpackage</command> <option>--git-tag</option> <option>--git-posttag</option>=<replaceable>"git push && git push --tags"</replaceable> </programlisting> This assumes you have set up a remote repository to push to in <filename>.git/config</filename>.</para> @@ -131,7 +131,7 @@ else exit 1 fi -if [ "$GBP_SHA1" ] && [ "$GBP_BRANCH" ]; then +if [ "$GBP_SHA1" ] && [ "$GBP_BRANCH" ]; then git push "$REMOTE" "$GBP_SHA1":"$GBP_BRANCH" else echo "GBP_SHA1 or GBP_BRANCH not set." @@ -155,7 +155,7 @@ echo "done." <title>Running postexport hook</title> <para>&gbp-buildpackage; exports several variables into the <option>postexport</option>'s environment (for details see - the <xref linkend="man.gbp.buildpackage">). The motivation + the <xref linkend="man.gbp.buildpackage"/>). The motivation for the postexport action is to allow further adjustment of the sources prior to building the package. A typical use case scenario is to allow creating multiple source and binary @@ -260,8 +260,8 @@ cat $source_lintian | sed -e "$REPLACE_EXPR" > ${source_lintian%.tmpl} rm $source_lintian # rules and control file are package flavor specific -[ -f rules.$PKG_FLAVOR ] && mv rules.$PKG_FLAVOR rules -[ -f control.$PKG_FLAVOR ] && mv control.$PKG_FLAVOR control +[ -f rules.$PKG_FLAVOR ] && mv rules.$PKG_FLAVOR rules +[ -f control.$PKG_FLAVOR ] && mv control.$PKG_FLAVOR control rm -f rules.* control.* exit 0 diff --git a/docs/chapters/cfgfile.sgml b/docs/chapters/cfgfile.sgml index a3b8252e..9833774b 100644 --- a/docs/chapters/cfgfile.sgml +++ b/docs/chapters/cfgfile.sgml @@ -91,6 +91,6 @@ upstream-branch=notdfsgclean git-log=--no-merges </programlisting> <para> -For more details, see the <xref linkend="man.gbp.conf"> manual page. +For more details, see the <xref linkend="man.gbp.conf"/> manual page. </para> </chapter> diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml index 138fd014..e3bb4758 100644 --- a/docs/chapters/import.sgml +++ b/docs/chapters/import.sgml @@ -45,6 +45,7 @@ by version number. <screen> &gbp-import-dscs; --debsnap package </screen> + </para> </sect1> <sect1 id="gbp.import.new.upstream"> @@ -224,7 +225,7 @@ upstream-tag = v%(version)s <replaceable>version</replaceable> will be replaced with the upstream version number as read from <filename>debian/changelog</filename>. </para> - <para>If you're using &pristine-tar;, you can make &gbp-buildpackage commit the generated tarball back to the + <para>If you're using &pristine-tar;, you can make &gbp-buildpackage; commit the generated tarball back to the pristine-tar branch by using the <option>--git-pristine-tar-commit</option> option. This will make sure others building your package can regenerate the tarball you generated for building the &debian; package. </para> diff --git a/docs/chapters/intro.sgml b/docs/chapters/intro.sgml index 6320cc56..8a6ee39c 100644 --- a/docs/chapters/intro.sgml +++ b/docs/chapters/intro.sgml @@ -80,7 +80,7 @@ <option>upstream-branch</option>—it doesn't matter if these branches are maintained with &gbp-import-orig; or not.</para> <para> - A recommended branch layout is described in <xref linkend="gbp.branch.naming">. + A recommended branch layout is described in <xref linkend="gbp.branch.naming"/>. </para> <para>Since &gbp-buildpackage; only works with local &git;-repositories, diff --git a/docs/manpages/gbp-buildpackage-rpm.sgml b/docs/manpages/gbp-buildpackage-rpm.sgml index 4b75113f..15d7821b 100644 --- a/docs/manpages/gbp-buildpackage-rpm.sgml +++ b/docs/manpages/gbp-buildpackage-rpm.sgml @@ -525,13 +525,13 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.import.srpm">, - <xref linkend="man.gbp.pq.rpm">, + <xref linkend="man.gbp.import.srpm"/>, + <xref linkend="man.gbp.pq.rpm"/>, <citerefentry> <refentrytitle>rpmbuild</refentrytitle> <manvolnum>8</manvolnum> </citerefentry>, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-buildpackage.sgml b/docs/manpages/gbp-buildpackage.sgml index 6d20fe40..7e2c0cfe 100644 --- a/docs/manpages/gbp-buildpackage.sgml +++ b/docs/manpages/gbp-buildpackage.sgml @@ -645,10 +645,10 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.import.dscs">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.dch">, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.dscs"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.dch"/>, <citerefentry> <refentrytitle>git-pbuilder</refentrytitle> <manvolnum>1</manvolnum> @@ -657,7 +657,7 @@ <refentrytitle>cowbuilder</refentrytitle> <manvolnum>8</manvolnum> </citerefentry>, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-clone.sgml b/docs/manpages/gbp-clone.sgml index 5b681584..8c3cbdb6 100644 --- a/docs/manpages/gbp-clone.sgml +++ b/docs/manpages/gbp-clone.sgml @@ -99,9 +99,9 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.pull">, - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.pull"/>, + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp-config.sgml b/docs/manpages/gbp-config.sgml index 32e8b410..04a50ed9 100644 --- a/docs/manpages/gbp-config.sgml +++ b/docs/manpages/gbp-config.sgml @@ -90,7 +90,7 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp-create-remote-repo.sgml b/docs/manpages/gbp-create-remote-repo.sgml index 5cf8bff3..ae07f328 100644 --- a/docs/manpages/gbp-create-remote-repo.sgml +++ b/docs/manpages/gbp-create-remote-repo.sgml @@ -84,7 +84,7 @@ </term> <listitem> <para>Name of a config file section in <filename>gbp.conf</filename> - that specifies the above parameters. See <xref linkend="man.gbp.conf"> + that specifies the above parameters. See <xref linkend="man.gbp.conf"/> manpage for details. </para> </listitem> @@ -128,9 +128,9 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.pull">, - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.pull"/>, + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp-dch.sgml b/docs/manpages/gbp-dch.sgml index 8c3583b5..8f538f9f 100644 --- a/docs/manpages/gbp-dch.sgml +++ b/docs/manpages/gbp-dch.sgml @@ -523,11 +523,11 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.import.dscs">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.dscs"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; <ulink url="https://honk.sigxcpu.org/cl2vcs"> <citetitle>Cl2vcs</citetitle></ulink>, diff --git a/docs/manpages/gbp-import-dsc.sgml b/docs/manpages/gbp-import-dsc.sgml index b7b14fe3..a9659131 100644 --- a/docs/manpages/gbp-import-dsc.sgml +++ b/docs/manpages/gbp-import-dsc.sgml @@ -228,10 +228,10 @@ <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.import.dscs">, - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.dch">, + <xref linkend="man.gbp.import.dscs"/>, + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.dch"/>, <citerefentry> <refentrytitle>apt-get</refentrytitle> <manvolnum>1</manvolnum> @@ -240,7 +240,7 @@ <refentrytitle>dget</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-import-dscs.sgml b/docs/manpages/gbp-import-dscs.sgml index a0f2a959..70cdb510 100644 --- a/docs/manpages/gbp-import-dscs.sgml +++ b/docs/manpages/gbp-import-dscs.sgml @@ -79,11 +79,11 @@ options shipped in the package source.</para> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.dch">, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.dch"/>, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-import-orig.sgml b/docs/manpages/gbp-import-orig.sgml index 8fd01acc..5049a9ed 100644 --- a/docs/manpages/gbp-import-orig.sgml +++ b/docs/manpages/gbp-import-orig.sgml @@ -282,11 +282,11 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.import.dscs">, - <xref linkend="man.gbp.dch">, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.dscs"/>, + <xref linkend="man.gbp.dch"/>, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-import-srpm.sgml b/docs/manpages/gbp-import-srpm.sgml index ceea02af..daf2d75f 100644 --- a/docs/manpages/gbp-import-srpm.sgml +++ b/docs/manpages/gbp-import-srpm.sgml @@ -230,9 +230,9 @@ <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage.rpm">, - <xref linkend="man.gbp.pq.rpm">, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.buildpackage.rpm"/>, + <xref linkend="man.gbp.pq.rpm"/>, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/gbp-pq-rpm.sgml b/docs/manpages/gbp-pq-rpm.sgml index 8d172aa5..1716fbf6 100644 --- a/docs/manpages/gbp-pq-rpm.sgml +++ b/docs/manpages/gbp-pq-rpm.sgml @@ -199,9 +199,9 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage.rpm">, - <xref linkend="man.gbp.import.srpm">, - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.buildpackage.rpm"/>, + <xref linkend="man.gbp.import.srpm"/>, + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp-pq.sgml b/docs/manpages/gbp-pq.sgml index cb90df8f..2bb1645a 100644 --- a/docs/manpages/gbp-pq.sgml +++ b/docs/manpages/gbp-pq.sgml @@ -225,7 +225,7 @@ bug number when using <option>export</option> <option>--commit</option>. The default is <literal>'(?:bug|issue)?\#?\s?\d+'</literal>. - See <xref linkend="man.gbp.dch"> for details. + See <xref linkend="man.gbp.dch"/> for details. </para> </listitem> </varlistentry> @@ -286,7 +286,7 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, + <xref linkend="man.gbp.buildpackage"/>, <citerefentry> <refentrytitle>dpkg-source</refentrytitle> <manvolnum>1</manvolnum> @@ -295,7 +295,7 @@ <refentrytitle>quilt</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>, - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp-pull.sgml b/docs/manpages/gbp-pull.sgml index 93173901..185a0d0b 100644 --- a/docs/manpages/gbp-pull.sgml +++ b/docs/manpages/gbp-pull.sgml @@ -132,10 +132,10 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.clone">, - <xref linkend="man.gbp.pq">, - <xref linkend="man.gbp.conf"> + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.clone"/>, + <xref linkend="man.gbp.pq"/>, + <xref linkend="man.gbp.conf"/> </para> </refsect1> <refsect1> diff --git a/docs/manpages/gbp.conf.sgml b/docs/manpages/gbp.conf.sgml index 481778ee..8ba056a5 100644 --- a/docs/manpages/gbp.conf.sgml +++ b/docs/manpages/gbp.conf.sgml @@ -85,7 +85,7 @@ named like the command-line options of the corresponding command with the '--' stripped off and can hold the same values (but see below for details). For example, - the <xref linkend="man.gbp.buildpackage"> manual page documents + the <xref linkend="man.gbp.buildpackage"/> manual page documents the <option>--git-export-dir</option>=<parameter>directory</parameter> option which can be turned into configuration file setting by dropping the @@ -100,7 +100,7 @@ <para> Options that can be repeated on the command line take Python-like lists in the config file. For example, - the <xref linkend="man.gbp.import.orig"> commmand has the + the <xref linkend="man.gbp.import.orig"/> commmand has the <option>--filter</option>=<parameter>pattern</parameter> option which can be turned into a configuration file option like this: </para> @@ -112,7 +112,7 @@ <para> Boolean options can be either <option>True</option> or <option>False</option>. For example, -<xref linkend="man.gbp.import.orig"> has the <option>--pristine-tar</option> and +<xref linkend="man.gbp.import.orig"/> has the <option>--pristine-tar</option> and <option>--no-pristine-tar</option> options which translate to: </para> <programlisting> @@ -130,7 +130,7 @@ Boolean options can be either <option>True</option> or <option>False</option>. F <note> <para> To see the current set of values that would be applied after parsing the - configuration files, use <xref linkend="man.gbp.config">. + configuration files, use <xref linkend="man.gbp.config"/>. </para> </note> <note> @@ -141,7 +141,7 @@ can't be configured via <filename>gbp.conf</filename>. </note> <para> -<xref linkend="man.gbp.create.remote.repo"> can additionally parse remote site +<xref linkend="man.gbp.create.remote.repo"/> can additionally parse remote site configurations from <filename>gbp.conf</filename>. For example, a configuration like: </para> @@ -229,14 +229,14 @@ the above list of configuration files.</para></listitem> <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.clone">, - <xref linkend="man.gbp.create.remote.repo">, - <xref linkend="man.gbp.pq">, - <xref linkend="man.gbp.pull">, - <xref linkend="man.gbp.dch">, - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.buildpackage">, + <xref linkend="man.gbp.clone"/>, + <xref linkend="man.gbp.create.remote.repo"/>, + <xref linkend="man.gbp.pq"/>, + <xref linkend="man.gbp.pull"/>, + <xref linkend="man.gbp.dch"/>, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.buildpackage"/>, <ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html"> <citetitle>The Git-Buildpackage Manual</citetitle></ulink> </para> diff --git a/docs/manpages/gbp.sgml b/docs/manpages/gbp.sgml index b456484a..e6faa458 100644 --- a/docs/manpages/gbp.sgml +++ b/docs/manpages/gbp.sgml @@ -154,20 +154,20 @@ <refsect1> <title>SEE ALSO</title> <para> - <xref linkend="man.gbp.buildpackage">, - <xref linkend="man.gbp.import.dsc">, - <xref linkend="man.gbp.import.dscs">, - <xref linkend="man.gbp.import.orig">, - <xref linkend="man.gbp.dch">, - <xref linkend="man.gbp.pq">, - <xref linkend="man.gbp.create.remote.repo">, - <xref linkend="man.gbp.pull">, - <xref linkend="man.gbp.clone">, + <xref linkend="man.gbp.buildpackage"/>, + <xref linkend="man.gbp.import.dsc"/>, + <xref linkend="man.gbp.import.dscs"/>, + <xref linkend="man.gbp.import.orig"/>, + <xref linkend="man.gbp.dch"/>, + <xref linkend="man.gbp.pq"/>, + <xref linkend="man.gbp.create.remote.repo"/>, + <xref linkend="man.gbp.pull"/>, + <xref linkend="man.gbp.clone"/>, <citerefentry> <refentrytitle>git-pbuilder</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>, - <xref linkend="man.gbp.conf">, + <xref linkend="man.gbp.conf"/>, &man.seealso.common; </para> </refsect1> diff --git a/docs/manpages/man.conffiles.sgml b/docs/manpages/man.conffiles.sgml index 83c88426..17dcd1ca 100644 --- a/docs/manpages/man.conffiles.sgml +++ b/docs/manpages/man.conffiles.sgml @@ -1,4 +1,4 @@ <title>CONFIGURATION FILES</title> <para>Several <filename>gbp.conf</filename> files are parsed to set defaults for the above command-line arguments. See the - <xref linkend="man.gbp.conf"> manpage for details.</para> + <xref linkend="man.gbp.conf"/> manpage for details.</para> |