On Mar 8, 2012, at 8:29 AM, Tom Browder wrote:

> Cliff automated the configuration section of the "INSTALL" file, but
> the source is still, confusingly to me, named the "INSTALL" file.
> 
> I propose the source be "INSTALL.in", with some cmake variables where
> the existing specific BRL-CAD version numbers are, so the generated
> "INSTALL" file in the distribution always looks current.

The fewer places that refer to specific version numbers, the better.  Less 
complexity, less maintenance concerns.  I'm not sure i see a benefit for the 
INSTALL file containing specific version numbers other than as an example.  If 
we can't generically describe an installation process applicable to any 
version, we should probably improve our process until it is that simple.

Moreover (and perhaps more importantly), I do see value in having an INSTALL 
file presented right after checkout.  The instructions can cover all the bases.

Also, in terms of not repeating information, the README file is already the 
place that spells out the "current" version and release dates are necessarily 
documented in the NEWS file.

> gunzip BRL-CAD_@BRLCAD_VER@_Linux_ia64.tar.gz
> tar -xvf BRL-CAD_@BRLCAD_VER@_Linux_ia64.tar
> sudo mkdir /usr/brlcad/rel-@BRLCAD_VER@
> sudo mv BRL-CAD_@BRLCAD_VER@_Linux_ia64/* /usr/brlcad/rel-@BRLCAD_VER@/

Good example of unnecessary complexity.  The mkdir is not just pointless but 
incomplete.  It's followed by a move of the contents leaving an empty dir that 
we never tell them to remove.  That could probably be just three or two 
commands (e.g., tar zxvf if we assumed gnu tar).

I'd suggest we put the INSTALL file through a careful technical/content review 
to condense it as much possible so it explains the main point(s) quickly, 
clearly, and sufficiently without duplicating information.  Perhaps a 
collaborative edit on our wiki or in a Google doc is in order?  Does anyone 
want to volunteer?

Cheers!
Sean


------------------------------------------------------------------------------
Better than sec? Nothing is better than sec when it comes to
monitoring Big Data applications. Try Boundary one-second 
resolution app monitoring today. Free.
http://p.sf.net/sfu/Boundary-dev2dev
_______________________________________________
BRL-CAD Developer mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-devel

Reply via email to