[Oscar-checkins] CVS: oscar/doc/development release.tex,NONE,1.1 Makefile.am,1.3,1.4 cvs.tex,1.3,1.4

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/oscar/oscar/doc/development
In directory usw-pr-cvs1:/tmp/cvs-serv2127

Modified Files:
	Makefile.am cvs.tex development.tex directories.tex files.tex 
Added Files:
	release.tex 
Log Message:
Minor changes
Added "release procedures" section

--- NEW FILE: release.tex ---
% -*- latex -*-
%
% $Id: release.tex,v 1.1 2002/01/23 05:13:41 jsquyres Exp $
%
% $COPYRIGHT$
%

\section{Release Procedures}
\label{sec:release}

OSCAR distribution packages are supervised by a Release Manager.  All
decisions about a release must be approved through the Release
Manager.

\subsection{Approaching a Release}

As a release approaches, the Release Manager will declare the CVS tree
``frozen''.  The following guidelines will be followed after the CVS
tree is frozen until the version is formally released:

\begin{enumerate}
\item Developers will only work on ``show stoppers'' for a release
  that has been frozen.  Show stoppers defined as ``can we ship with
  this bug?''

\item Show stoppers will have a priority of 9 for the current release.

\item The Release Manager has to approve show stoppers -- i.e., bump
  up to 9 and/or assign someone to work on it.

\item Developers must have bugs assigned to you in the tracker before
  working on them.

\item Documentation bugs have to be marked as category
  ``documentation'' in the tracker.  Documentation issues and bugs can
  be fixed at any time -- they are not subject to the same ``show
  stopper'' rules as described above.
\end{enumerate}

The Release Manager will determine when a version is ready for
release.

\subsection{Releasing on SourceForge}

Making a release on SourceForge is a little less than obvious.  All of
this is itemized in the main SourceForge documentation; this is an
attempt provide a quick overview that should help release technicians
through the process.

\begin{enumerate}

\item Upload the distribution package file to {\tt
    ftp://upload.sf.net/incoming/}.

\item Login to the SourceForge web page.

\item Go to the ``Admin'' section.

\item Go to the ``Edit/Release Files'' subsection.

{\bf Note:} Stable distribution packages are released under the ``{\tt
  oscar}'' SourceForge package; development/beta distribution packages
  are released under the ``{\tt oscar-devel} SourceForge package.

\item Select ``Add Release'' next to the appropriate SourceForge
  package ({\tt oscar} or {\tt oscar-devel}.

\item Type in the version number in the ``New release name'' text
  box.  It should correspond to the version number of the OSCAR
  distribution package.  For example, ``{\tt 1.1}'', ``{\tt 1.2b7}'',
  and ``{\tt 1.2}''.

\item There are four steps to finish the release:

  \begin{enumerate}

    \item Meta information
      \begin{itemize}
      \item Ensure that the text fields for Release Date and Release
        Name are correct.

      \item Set the Status field to ``Active''.

      \item Ensure the Of Package field is set to the appropriate
        package.

      \item Paste the release text in the ``Paste the Notes In:'' text
        box.

      \item Ensure that the ``Preserve my pre-formatted text''
        checkbox is {\em not} checked.

      \item {\bf IMPORTANT:} Click on the ``Submit/Refresh'' button.
        This saves your work so far.
      \end{itemize}

  \item Add the distribution package file to the release.

    \begin{itemize}
    \item In the Step 2 section, there is a list of files.  Check the
      OSCAR distribution package file.

    \item {\bf IMPORTANT:} Click on the ``Add Files and/or Refresh
      View'' button.  This saves your work so far.
    \end{itemize}

  \item Edit files in the release

    \begin{itemize}
    \item Once you have completed the previous step, the OSCAR
      distribution file will appear in step 3.

    \item Ensure that all the data in the fields in step 3 is
      correct.  All fields must be filled in, or the file will not
      show up on the release.

    \item {\bf IMPORTANT:} Click on the ``Update/Refresh'' button.
      This saves your work so far.
    \end{itemize}

  \item Email release notice

    \begin{itemize}
    \item Check the ``I'm sure'' checkbox

    \item Click on the ``Send Notice'' button.  This sends a mail to
    all SourceForge users who are monitoring the OSCAR package.
    \end{itemize}

  \end{enumerate}
\end{enumerate}

Note that the release will show up on the OSCAR download page
immediately, but the distribution package file will not show up for
some time (usually somewhere between 15-30 minutes).

{\large IMPORTANT NOTICE}: {\em Since you cannot delete releases}, do
{\em not} create a new release if you mess one up.  You cannot put a
release in a state that cannot be fixed -- instead of creating a new
one, just go back and fix your previous mistake (you can edit a
previous release .  If necessary, close
your browser and restart the editing process.

\subsection{Removing Old Releases}

SourceForge does not allow deleting of old releases.  All you can do
is ``Hide'' an old release.  That is, go edit the specific release and
set its status to ``Hide''.  This will immediately remove it from the
OSCAR download page.

Note that this will also remove the number of downloads from the total
downloads sum on the downloads page.  Specifically -- the ``total
downloads'' sum shown on the OSCAR download page only reflects the
total number of downloads of all currently active releases.  The total
number of downloads is still maintained on the stats page, regardless
of which releases are hidden and active.

% LocalWords:  Exp

Index: Makefile.am
===================================================================
RCS file: /cvsroot/oscar/oscar/doc/development/Makefile.am,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** Makefile.am	2001/12/22 01:08:36	1.3
--- Makefile.am	2002/01/23 05:13:41	1.4
***************
*** 15,27 ****

  OTHER_SRC_FILES	= \
- 		defs.tex \
- 		titlepage.tex \
- 		toc.tex \
- 		intro.tex \
  		cvs.tex \
  		directories.tex \
  		files.tex \
! 		core.tex \
! 		third-party.tex

  # xfig figures.  .eps and .pdf files will be automatically generated
--- 15,28 ----

  OTHER_SRC_FILES	= \
  		cvs.tex \
+ 		core.tex \
  		directories.tex \
+ 		defs.tex \
+ 		intro.tex \
  		files.tex \
! 		release.tex \
! 		third-party.tex \
! 		titlepage.tex \
! 		toc.tex

  # xfig figures.  .eps and .pdf files will be automatically generated
***************
*** 36,59 ****
  #########################################################################

! SUFFIXES	= .tex .dvi .ps .pdf .eps .fig

- CHAP_CITE	= $(CHAP_CITE_TEX:.tex=)
  MAIN_DVI	= $(MAIN_TEX:.tex=.dvi)
  MAIN_PS		= $(MAIN_TEX:.tex=.ps)
  MAIN_PDF	= $(MAIN_TEX:.tex=.pdf)
- EPS_FIG_FILES	= $(FIG_FILES:.fig=.eps)
- PDF_FIG_FILES	= $(FIG_FILES:.fig=.pdf)

  # Tell automake to include all the relevant files

  EXTRA_DIST	= $(MAIN_TEX) $(OTHER_SRC_FILES) $(FIG_FILES)
! CLEANFILES	= $(MAIN_PS) $(MAIN_DVI) $(MAIN_PDF)

  # Some common target names

! docs: pdf

! ps: $(EPS_FIG_FILES) $(MAIN_PS) 
! pdf: $(PDF_FIG_FILES) $(MAIN_PDF)

  #
--- 37,62 ----
  #########################################################################

! SUFFIXES	= .tex .dvi .ps .pdf .eps .png

  MAIN_DVI	= $(MAIN_TEX:.tex=.dvi)
  MAIN_PS		= $(MAIN_TEX:.tex=.ps)
  MAIN_PDF	= $(MAIN_TEX:.tex=.pdf)

+ TEX_SRC		= $(MAIN_TEX) $(OTHER_SRC_FILES) $(NON_DIST_SRC_FILES)
+ 
+ EPS_FIG_FILES	= $(FIG_FILES:.png=.eps)
+ 
  # Tell automake to include all the relevant files

  EXTRA_DIST	= $(MAIN_TEX) $(OTHER_SRC_FILES) $(FIG_FILES)
! CLEANFILES	= $(MAIN_PS) $(MAIN_DVI) $(MAIN_PDF) *~

  # Some common target names

! all: ps
! docs: $(MAIN_PS)

! ps: $(EPS_FIG_FILES) $(MAIN_PS)
! pdf: $(PNG_FIG_FILES) $(MAIN_PDF)

  #
***************
*** 62,67 ****

  $(MAIN_PS): $(MAIN_DVI)
! $(MAIN_DVI): $(MAIN_TEX) $(OTHER_SRC_FILES) $(EPS_FIGURES)
! $(MAIN_PDF): $(MAIN_TEX) $(OTHER_SRC_FILES) $(PDF_FIGURES)

  #
--- 65,70 ----

  $(MAIN_PS): $(MAIN_DVI)
! $(MAIN_DVI): $(TEX_SRC) $(EPS_FIG_FILES)
! $(MAIN_PDF): $(TEX_SRC) $(FIG_FILES)

  #
***************
*** 69,78 ****
  #

- .fig.eps:
- 	$(FIG2DEV) -L eps $< $@
- 
- .fig.pdf:
- 	$(FIG2DEV) -L pdf $< $@
- 
  .tex.dvi:
  	(unset TEXINPUTS; $(LATEX) $*)
--- 72,75 ----
***************
*** 82,94 ****
  	then makeindex $* ; (unset TEXINPUTS; $(LATEX) $*) ; fi
  	@-if ( grep 'LaTeX Warning: Citation' $*.log > /dev/null ); then \
! 	  if test "$(CHAP_CITE)" ; then \
! 	    for file in bogus $(CHAP_CITE) ; do \
! 	      if test "$$file" != "bogus"; then \
! 		bibtex $$file ; \
! 	      fi ; \
! 	    done ; \
! 	  else \
! 	    bibtex $* ; \
! 	  fi ; \
  	  (unset TEXINPUTS; $(LATEX) $*) ; \
  	fi
--- 79,83 ----
  	then makeindex $* ; (unset TEXINPUTS; $(LATEX) $*) ; fi
  	@-if ( grep 'LaTeX Warning: Citation' $*.log > /dev/null ); then \
! 	  bibtex $* ; \
  	  (unset TEXINPUTS; $(LATEX) $*) ; \
  	fi
***************
*** 114,126 ****
  	then makeindex $* ; (unset TEXINPUTS; $(PDFLATEX) $*) ; fi
  	@-if ( grep 'LaTeX Warning: Citation' $*.log > /dev/null ); then \
! 	  if test "$(CHAP_CITE)" ; then \
! 	    for file in bogus $(CHAP_CITE) ; do \
! 	      if test "$$file" != "bogus"; then \
! 		bibtex $$file ; \
! 	      fi ; \
! 	    done ; \
! 	  else \
! 	    bibtex $* ; \
! 	  fi ; \
  	  (unset TEXINPUTS; $(PDFLATEX) $*) ; \
  	fi
--- 103,107 ----
  	then makeindex $* ; (unset TEXINPUTS; $(PDFLATEX) $*) ; fi
  	@-if ( grep 'LaTeX Warning: Citation' $*.log > /dev/null ); then \
! 	  bibtex $* ; \
  	  (unset TEXINPUTS; $(PDFLATEX) $*) ; \
  	fi
***************
*** 136,139 ****
--- 117,123 ----
  	then (unset TEXINPUTS; $(PDFLATEX) $*) ; else :; fi

+ .png.eps:
+ 	$(PNGTOPNM) $< | $(PNMTOPS) -noturn > $*.eps
+ 
  # Deleting kruft temporary files

***************
*** 141,144 ****
  	-rm -f *~ *.bak *% \
  		  *.log *.aux *.dvi *.blg *.toc *.bbl *.lof *.lot *.out \
! 		  $(EPS_FIG_FILES) $(PDF_FIG_FILES)
! 
--- 125,127 ----
  	-rm -f *~ *.bak *% \
  		  *.log *.aux *.dvi *.blg *.toc *.bbl *.lof *.lot *.out \
! 		  $(EPS_FIG_FILES)

Index: cvs.tex
===================================================================
RCS file: /cvsroot/oscar/oscar/doc/development/cvs.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** cvs.tex	2001/08/28 00:55:55	1.3
--- cvs.tex	2002/01/23 05:13:41	1.4
***************
*** 68,71 ****
--- 68,74 ----
  \subsection{Binary Files}

+ {\Huge This whole section may not be relevant -- we've been putting
+   binary files in CVS for a while now.}
+ 
  There will be no binary files stored in CVS.  Instead, all binary
  files that are part of OSCAR will be stored on various web
***************
*** 167,173 ****
--- 170,181 ----
  \item Issue a ``{\tt make}'' that will invoke the build system to
    automatically download any new or missing binary files.
+ 
+ {\Huge This step is not currently necessary since we keep all binary
+   files in CVS.}
  \end{enumerate}

  After these three steps, the development tree is considered complete.
+ 
+ {\Huge This {\tt update.sh} script doesn't even exist anymore.}

  Since each of these steps involve one or more actual commands, the

Index: development.tex
===================================================================
RCS file: /cvsroot/oscar/oscar/doc/development/development.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** development.tex	2001/08/14 18:17:53	1.1
--- development.tex	2002/01/23 05:13:41	1.2
***************
*** 19,22 ****
--- 19,23 ----
  \input{files}
  \input{directories}
+ \input{release}
  \input{cvs}
  \input{core}

Index: directories.tex
===================================================================
RCS file: /cvsroot/oscar/oscar/doc/development/directories.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** directories.tex	2001/08/21 19:31:09	1.2
--- directories.tex	2002/01/23 05:13:41	1.3
***************
*** 149,153 ****

    \begin{itemize}
!   \item {\tt lam-mpi}
    \item {\tt mpich}
    \item {\tt openssh}
--- 149,153 ----

    \begin{itemize}
!   \item {\tt lam}
    \item {\tt mpich}
    \item {\tt openssh}

Index: files.tex
===================================================================
RCS file: /cvsroot/oscar/oscar/doc/development/files.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** files.tex	2001/08/25 15:52:07	1.2
--- files.tex	2002/01/23 05:13:41	1.3
***************
*** 57,61 ****
  \item Generally, ``oscar'' should not need to appear in filenames,
    either.  But there are some obvious exceptions, such as ``{\tt
!     oscar\_wizard}'', part of a third party's package filename, etc.

  \item Dashes should be used to separate multiple words in a directory
--- 57,61 ----
  \item Generally, ``oscar'' should not need to appear in filenames,
    either.  But there are some obvious exceptions, such as ``{\tt
!     oscar-wizard}'', part of a third party's package filename, etc.

  \item Dashes should be used to separate multiple words in a directory

[Oscar-checkins] CVS: oscar/doc/development release.tex,NONE,1.1 Makefile.am,1.3,1.4 cvs.tex,1.3,1.4

[Oscar-checkins] CVS: oscar/doc/development release.tex,NONE,1.1 Makefile.am,1.3,1.4 cvs.tex,1.3,1.4 development.tex,1.1,1.2 directories.tex,1.2,1.3 files.tex,1.2,1.3