summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/register/register.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/register/register.dtx')
-rw-r--r--Master/texmf-dist/source/latex/register/register.dtx40
1 files changed, 21 insertions, 19 deletions
diff --git a/Master/texmf-dist/source/latex/register/register.dtx b/Master/texmf-dist/source/latex/register/register.dtx
index 5d66e87a1ce..8ec5d4f942a 100644
--- a/Master/texmf-dist/source/latex/register/register.dtx
+++ b/Master/texmf-dist/source/latex/register/register.dtx
@@ -3,8 +3,8 @@
% register.dtx
% Register diagrams with field descriptions
%
-% Author: Matthew Lovell (lovell@indra.com)
-% Copyright 2001 by Matthew B. Lovell
+% Author: Matthew Lovell (lovells@gmail.com)
+% Copyright 2001-2018 by Matthew B. Lovell
%
% Run LaTeX on the file `register.ins' to get a .sty-file and
% then on `register.dtx' to obtain instructions.
@@ -39,12 +39,13 @@
% \changes{v1.4}{2004/08/16}{Now provide a boolean set only in register context}
% \changes{v1.5}{2007/03/08}{Corrected use of conditionals used in spreading register reset value}
% \changes{v1.6}{2011/01/11}{Mainmatter correction suggested by Kjetil Oftedal}
+% \changes{v1.6.1}{2018/05/19}{Published with updated email address; no functional changes}
%
-% \def\fileversion{v1.6}
-% \def\filedate{2011/01/11}
+% \def\fileversion{v1.6.1}
+% \def\filedate{2018/05/19}
% \title{Register diagrams with field descriptions}
% \author{Matthew Lovell\\
-% \texttt{lovell@indra.com}
+% \texttt{lovells@gmail.com}
% }
% \date{\filedate}
% \maketitle
@@ -86,37 +87,37 @@
%
% \section{Introduction} \label{sec:background}
%
-% My group at work designs the memory and I/O controllers for HP's
-% servers and workstations. Historically, our chip documentation was
-% done with FrameMaker or, more recently, Microsoft Word. While these
-% approaches have various disadvantages, one of the most egregious was
-% register documentation.
+% My group at work designed the memory and I/O controllers for servers
+% and workstations. Historically, our chip documentation was done
+% with FrameMaker or Microsoft Word. While these approaches have
+% various disadvantages, one of the most egregious was register
+% documentation.
%
-% Our recent chips have had 64-bit wide control-status registers (CSR)
-% or, more simply, registers. Throw in the fact that many of these
+% The recent chips have 64-bit wide control-status registers (CSR)
+% or, more simply, registers. Add the fact that many of these
% registers have a large number of single-bit fields, and you get a
% typesetting challenge. The typical solution was to describe such
% registers using a table, typing field names vertically if space
% became a problem. For a complicated register, these tables became
% quite complex and filled a large portion of a page.
%
-% When we decided to evaluate \LaTeX{} for the latest round of
-% documentation, we had three goals in mind with respect to registers:
+% When we decided to evaluate \LaTeX{} for documentation, we had three
+% goals in mind with respect to registers:
% \begin{enumerate}
% \item Create a method of documenting registers which was consistent
% and easy to read, regardless of the number of fields within a
% register.
% \item Automate the creation of lists of registers, both in order
-% of appearance within the text and in memory order.
+% of appearance within the text and in memory address order.
% \item Enable the automatic extraction of documented register reset
% values in order to verify register functionality in the chip
% itself.
% \end{enumerate}
% The |register| package is my attempt at meeting all three goals. It
-% has been in use by my group since April 1999; it may be not be
+% was first put into use in April 1999; it may be not be
% pretty to all eyes, but it certainly has proven itself stable.
%
-% In order to promote \LaTeX{} within our group at the time, we
+% In order to promote \LaTeX{} within our group at the time, we also
% adopted \LyX{}. The |register| package thus attempts to work well
% within that environment. All \LyX{}-specific code, however, is
% controlled via package options.
@@ -499,7 +500,7 @@
%
% Announce the name and load required packages:
% \begin{macrocode}
-\ProvidesPackage{register} [2011/01/11 v1.6 Register macros with
+\ProvidesPackage{register} [2018/05/19 v1.6.1 Register macros with
hyperref/LyX support]
\RequirePackage{ifthen}[1997/11/02]
@@ -1123,7 +1124,8 @@ hyperref/LyX support]
{\newcommand{\TR}[1]{}}
% \end{macrocode}
%
-%
+% \par
+% Enjoy! Happy documenting.
%
% \Finale
%