[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.28,1.29

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory slayer.i.sourceforge.net:/tmp/cvs-serv10905/doc

Modified Files:
	doc.tex 
Log Message:

\shortversion,
\setshortversion:  New markup to help deal with Python having a "real"
                   version number and an abbreviated version number
                   used to create pathnames to the library installation.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -r1.28 -r1.29
*** doc.tex	2000/09/12 19:58:10	1.28
--- doc.tex	2000/09/14 20:11:05	1.29
***************
*** 237,240 ****
--- 237,252 ----
    facilities.
  
+   \subsection{Markup for the Preamble \label{preamble-info}}
+ 
+     \begin{macrodesc}{release}{\p{ver}}
+       Set the version number for the software described in the
+       document.
+     \end{macrodesc}
+ 
+     \begin{macrodesc}{setshortversion}{\p{sver}}
+       Specify the ``short'' version number of the documented software
+       to be \var{sver}.
+     \end{macrodesc}
+ 
    \subsection{Meta-information Markup \label{meta-info}}
  
***************
*** 568,571 ****
--- 580,594 ----
      \end{macrodesc}
  
+     \begin{macrodesc}{shortversion}{}
+       The ``short'' version number of the documented software, as
+       specified using the \macro{setshortversion} macro in the
+       preamble.  For Python, the short version number for a release is
+       the first three characters of the \code{sys.version} value.  For
+       example, versions 2.0b1 and 2.0.1 both have a short version of
+       2.0.  This may not apply for all packages; if
+       \macro{setshortversion} is not used, this produces an empty
+       expansion.  See also the \macro{version} macro.
+     \end{macrodesc}
+ 
      \begin{macrodesc}{strong}{\p{text}}
        Strongly emphasized text; this will be presented using a bold
***************
*** 589,594 ****
  
      \begin{macrodesc}{version}{}
!       The version number for the documentation, as specified using
!       \macro{release} in the preamble.
      \end{macrodesc}
  
--- 612,618 ----
  
      \begin{macrodesc}{version}{}
!       The version number of the described software, as specified using
!       \macro{release} in the preamble.  See also the
!       \macro{shortversion} macro.
      \end{macrodesc}