[Shake-cvs] Shake/doc/dev/design/requirements ExternalInterfaces.tex,1.2,1.3 Functionality.tex,1.1,1
Status: Pre-Alpha
Brought to you by:
menelan
Menu
▾
▴
[Shake-cvs] Shake/doc/dev/design/requirements ExternalInterfaces.tex,1.2,1.3 Functionality.tex,1.1,1.2 GeneralDescription.tex,1.2,1.3 Introduction.tex,1.3,1.4 NonFunctional.tex,1.2,1.3
Update of /cvsroot/shake/Shake/doc/dev/design/requirements
In directory sc8-pr-cvs1:/tmp/cvs-serv32457/doc/dev/design/requirements
Modified Files:
ExternalInterfaces.tex Functionality.tex
GeneralDescription.tex Introduction.tex NonFunctional.tex
Log Message:
no message
Index: ExternalInterfaces.tex
===================================================================
RCS file: /cvsroot/shake/Shake/doc/dev/design/requirements/ExternalInterfaces.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** ExternalInterfaces.tex 17 Sep 2003 16:11:36 -0000 1.2
--- ExternalInterfaces.tex 20 Sep 2003 16:08:47 -0000 1.3
***************
*** 19,23 ****
\subsection{User interface}
! XXX
%------------------------------------------------------------------------------
--- 19,35 ----
\subsection{User interface}
! \shake is to be a command line utility. That is, its sole user interaction
! takes place from a shell or through some third party application invoking
! Shake on behalf of the user.
!
! The CLI interface to Shake consists of arguments and switches passed to the
! program on invocation, as well as a number of XML configuration files which
! are processed by Shake.
!
! Although the Shake tool itself doesn't provide any higher level (``fancy'')
! user interface, is is the intention that input and output to/from the tool
! be structured to such a degree that it is possible to build front ends to
! the tool and/or integrate the tool in other development environments, GUI or
! otherwise.
%------------------------------------------------------------------------------
***************
*** 25,29 ****
\subsection{Hardware interfaces}
! XXX
%------------------------------------------------------------------------------
--- 37,44 ----
\subsection{Hardware interfaces}
! \shake does not communicate with any special hardware; the only components
! involved are a standard computer capable of executing Shake and a storage
! medium (typically hard drive) from which Shake reads configuration/source
! files and produces output files.
%------------------------------------------------------------------------------
***************
*** 31,35 ****
\subsection{Software interfaces}
! XXX
%------------------------------------------------------------------------------
--- 46,50 ----
\subsection{Software interfaces}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 37,41 ****
\subsection{Communications interfaces}
! XXX
%------------------------------------------------------------------------------
--- 52,56 ----
\subsection{Communications interfaces}
! XXX ToDo XXX
%------------------------------------------------------------------------------
Index: Functionality.tex
===================================================================
RCS file: /cvsroot/shake/Shake/doc/dev/design/requirements/Functionality.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** Functionality.tex 17 Sep 2003 15:54:17 -0000 1.1
--- Functionality.tex 20 Sep 2003 16:08:47 -0000 1.2
***************
*** 17,21 ****
%------------------------------------------------------------------------------
! XXX
%------------------------------------------------------------------------------
--- 17,21 ----
%------------------------------------------------------------------------------
! XXX ToDo XXX
%------------------------------------------------------------------------------
Index: GeneralDescription.tex
===================================================================
RCS file: /cvsroot/shake/Shake/doc/dev/design/requirements/GeneralDescription.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** GeneralDescription.tex 17 Sep 2003 16:17:20 -0000 1.2
--- GeneralDescription.tex 20 Sep 2003 16:08:47 -0000 1.3
***************
*** 19,23 ****
\subsection{Perspective}
! XXX
%------------------------------------------------------------------------------
--- 19,23 ----
\subsection{Perspective}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 25,29 ****
\subsection{Functionality}
! XXX
%------------------------------------------------------------------------------
--- 25,29 ----
\subsection{Functionality}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 31,35 ****
\subsection{Users}
! XXX
%------------------------------------------------------------------------------
--- 31,35 ----
\subsection{Users}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 37,41 ****
\subsection{Environment}
! XXX
%------------------------------------------------------------------------------
--- 37,41 ----
\subsection{Environment}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 43,47 ****
\subsection{Limitations}
! XXX
%------------------------------------------------------------------------------
--- 43,47 ----
\subsection{Limitations}
! XXX ToDo XXX
%------------------------------------------------------------------------------
***************
*** 49,53 ****
\subsection{Assumptions and dependencies}
! XXX
%------------------------------------------------------------------------------
--- 49,53 ----
\subsection{Assumptions and dependencies}
! XXX ToDo XXX
%------------------------------------------------------------------------------
Index: Introduction.tex
===================================================================
RCS file: /cvsroot/shake/Shake/doc/dev/design/requirements/Introduction.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** Introduction.tex 17 Sep 2003 15:54:17 -0000 1.3
--- Introduction.tex 20 Sep 2003 16:08:47 -0000 1.4
***************
*** 61,65 ****
\subsection{References}
! This requirements specification is based on the IEEE 830-1993 standard.
The users of the system being developers, domain knowledge is achieved
--- 61,65 ----
\subsection{References}
! This requirements specification is (very loosely) based on the IEEE 830-1993 standard.
The users of the system being developers, domain knowledge is achieved
Index: NonFunctional.tex
===================================================================
RCS file: /cvsroot/shake/Shake/doc/dev/design/requirements/NonFunctional.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** NonFunctional.tex 17 Sep 2003 16:17:20 -0000 1.2
--- NonFunctional.tex 20 Sep 2003 16:08:47 -0000 1.3
***************
*** 19,25 ****
\subsection{Performance}
! XXX
! %------------------------------------------------------------------------------
%------------------------------------------------------------------------------
--- 19,33 ----
\subsection{Performance}
! Reliability is the primary focus of the \shake project, not raw speed.
! Whereas performance should, of course, be ``reasonable'',\footnote{
! This threshold is currently "open target", i.e. a suitable
! actual requirement is yet to be specified, based on experiments with the
! performance of Shake as well of that of other build systems.} it is
! recognised from the outset that performance (in terms of the time overhead
! spent \emph{not} on actual compilation etc. but on reading configuraions,
! checking source files, etc.) may be slower than that of traditional
! make-utilities (which operate on an incomplete dependenct DAG and use file
! modification timestamps for infering dirty source files).
%------------------------------------------------------------------------------
|
