[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: Use &*pkgsrc* XML entities ...

[leot <leot%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/bdf8a5470cf8
branches:  trunk
changeset: 372068:bdf8a5470cf8
user:      leot <leot%pkgsrc.org@localhost>
date:      Mon Nov 27 11:51:47 2017 +0000

description:
doc/guide: Use &*pkgsrc* XML entities instead of hardcoding them

Since the latest pkgsrc stable releases htdocs/share/xml/misc.ent had several
XML pkgsrc related entities added and picked up via htdocs-share-*.tar.gz
distfile.

Use them instead of hardcoding a particular stable branch/release (e.g. 2009Q1
or 2016Q4) or using `pkgsrc-20xxQy' (Yay! Now `The pkgsrc guide' should be ready
for the next century!).

diffstat:

 doc/guide/files/bulk.xml    |   4 ++--
 doc/guide/files/getting.xml |  25 +++++++++----------------
 2 files changed, 11 insertions(+), 18 deletions(-)

diffs (83 lines):

diff -r d161542fb141 -r bdf8a5470cf8 doc/guide/files/bulk.xml
--- a/doc/guide/files/bulk.xml  Mon Nov 27 10:47:55 2017 +0000
+++ b/doc/guide/files/bulk.xml  Mon Nov 27 11:51:47 2017 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: bulk.xml,v 1.24 2017/01/07 04:50:50 sevan Exp $ -->
+<!-- $NetBSD: bulk.xml,v 1.25 2017/11/27 11:51:47 leot Exp $ -->
 
 <chapter id="bulk">
 <title>Creating binary packages for everything in pkgsrc (bulk
@@ -58,7 +58,7 @@
 you have root access).</para></listitem>
 
 <listitem><para>Packages on ftp.NetBSD.org should only be created from
-the stable branches (like 2009Q1), so that users browsing the available
+the stable branches (like &pkgsrc.version.latest;), so that users browsing the available
 collections can see at a glance how old the packages
 are.</para></listitem>
 
diff -r d161542fb141 -r bdf8a5470cf8 doc/guide/files/getting.xml
--- a/doc/guide/files/getting.xml       Mon Nov 27 10:47:55 2017 +0000
+++ b/doc/guide/files/getting.xml       Mon Nov 27 11:51:47 2017 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: getting.xml,v 1.34 2017/01/07 01:24:05 sevan Exp $ -->
+<!-- $NetBSD: getting.xml,v 1.35 2017/11/27 11:51:47 leot Exp $ -->
 
 <chapter id="getting">
 <title>Where to get pkgsrc and how to keep it up-to-date</title>
@@ -21,7 +21,7 @@
        quarterly basis from the current branch and only gets modified
        for security updates. The names of the stable branches are built
        from the year and the quarter, for example
-       <literal>2016Q4</literal>.</para>
+       <literal>&pkgsrc.version.latest;</literal>.</para>
 
        <para>The second step is to decide <emphasis>how</emphasis> you
        want to download pkgsrc. You can get it as a tar file or via CVS.
@@ -55,18 +55,14 @@
 
        <para>You can fetch the same files using FTP.</para>
 
-       <para>The tar file for the stable branch 2016Q4 is in the
-       directory <filename>pkgsrc-2016Q4</filename> and is also called <ulink
-       url="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz";><filename>pkgsrc.tar.gz</filename></ulink>.</para>
+       <para>The tar file for the stable branch &pkgsrc.version.latest; is in the
+       directory <filename>&pkgsrc.branch.latest;</filename> and is also called <ulink
+       url="&url.pkgsrc.tarball.latest;"><filename>&filename.pkgsrc.tarball.latest;</filename></ulink>.</para>
 
-       <para>To download a pkgsrc stable tarball, run:</para>
+       <para>To download the latest pkgsrc stable tarball, run:</para>
 
 <screen>
-&uprompt; <userinput>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<replaceable>pkgsrc-20xxQy</replaceable>/pkgsrc.tar.gz</userinput></screen>
-
-       <para>Where <replaceable>pkgsrc-20xxQy</replaceable> is the
-       stable branch to be downloaded, for example, 
-       <quote>pkgsrc-2016Q4</quote>.</para>
+&uprompt; <userinput>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/&pkgsrc.branch.latest;/&filename.pkgsrc.tarball.latest;</userinput></screen>
 
        <para>If you prefer, you can also fetch it using "wget", "curl",
        or your web browser.</para>
@@ -94,12 +90,9 @@
 
 <para>To fetch a specific pkgsrc stable branch, run:</para>
 
-<screen>&uprompt; <userinput>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r <replaceable>pkgsrc-20xxQy</replaceable> -P pkgsrc</userinput>
+<screen>&uprompt; <userinput>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r &pkgsrc.branch.latest; -P pkgsrc</userinput>
 </screen>
 
-       <para>Where <replaceable>pkgsrc-20xxQy</replaceable> is the stable 
-       branch to be checked out, for example, <quote>pkgsrc-2016Q4</quote></para>
-
        <para>This will create the directory <filename>pkgsrc/</filename> 
        in your <filename>/usr/</filename> directory and all the package source 
        will be stored under <filename>/usr/pkgsrc/</filename>.</para>
@@ -201,7 +194,7 @@
        by adding the option <quote>-A</quote> after the
        <quote>update</quote> keyword. To switch from the current branch
        back to the stable branch, add the
-       <quote>-rpkgsrc-2016Q4</quote> option.</para>
+       <quote>-r&pkgsrc.branch.latest;</quote> option.</para>
 
 </sect3>
 <sect3 id="uptodate-cvs-changes">