#10825: Make gap support SAGE_SPKG_INSTALL_DOCS
------------------------------------------------------------------+---------
       Reporter:  jason                                           |         
Owner:  tbd            
           Type:  enhancement                                     |        
Status:  closed         
       Priority:  major                                           |     
Milestone:  sage-4.7       
      Component:  packages                                        |    
Resolution:  fixed          
       Keywords:                                                  |   Work 
issues:                 
Report Upstream:  Reported upstream. Developers acknowledge bug.  |     
Reviewers:  David Kirkby   
        Authors:  Jason Grout                                     |     Merged 
in:  sage-4.7.alpha1
   Dependencies:                                                  |      
Stopgaps:                 
------------------------------------------------------------------+---------

Comment (by leif):

 I'm not sure what the following is supposed to do (or mean):
 {{{
 #!sh
     # Build and install docs if requested
     if [ "x$SAGE_SPKG_INSTALL_DOCS" = xyes ] ; then
         if [ $? -ne 0 ]; then
             echo "Error building gap docs."
             exit 1
         fi
         mkdir -p $SAGE_ROOT/local/share/doc/gap
         cp -r src/doc/htm $SAGE_ROOT/local/share/doc/gap/html
     fi
 }}}
 Either there's a command missing to '''build''' the documentation, or we
 don't have to build it, in which case testing `$?` there is useless, since
 previous errors are catched above that block.  (On the other hand, whether
 the creation of the directory and the copy command succeeded isn't checked
 at all, so maybe the `if`-block was supposed to be ''below'' the `cp`.)

 I've currently changed this to
 {{{
 #!sh
     # Build and install docs if requested:
     if [[ "$SAGE_SPKG_INSTALL_DOCS" = yes ]]; then
         # ?????
         if [[ $? -ne 0 ]]; then
             echo "Error building GAP docs."
             exit 1
         fi
         mkdir -p "$SAGE_LOCAL"/share/doc/gap &&
         cp -r src/doc/htm "$SAGE_LOCAL"/share/doc/gap/html
         if [[ $? -ne 0 ]]; then
             echo >&2 "Error copying GAP's HTML documentation."
             exit 1
         fi
     fi
 }}}

 Btw., the description in `SPKG.txt` (still) says the docs (as well as
 tests, which seem to be there again, too) have been removed from the spkg.
 The `src/doc/` directory in contrast contains (subdirectories with) lots
 of LaTeX, HTML and probably other files.

 [[BR]]

 I'm currently working on a GAP 4.4.12.p7 spkg for #7041, so perhaps leave
 comments (also) there.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10825#comment:14>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to