Revision: 77118
http://sourceforge.net/p/brlcad/code/77118
Author: brlcad
Date: 2020-09-13 06:29:24 +0000 (Sun, 13 Sep 2020)
Log Message:
-----------
moving platform-specific README's together. platforms should be presented
equitably or can result in a dismissive perspective harmful in the long term.
best practice and project ethos has always been to handle cross-platform
variants on valid footing.
Modified Paths:
--------------
brlcad/trunk/doc/CMakeLists.txt
Added Paths:
-----------
brlcad/trunk/doc/README.AIX
brlcad/trunk/doc/README.BSD
brlcad/trunk/doc/README.IRIX
brlcad/trunk/doc/README.OSCON-2014
brlcad/trunk/doc/README.Solaris
brlcad/trunk/doc/README.VAX
Removed Paths:
-------------
brlcad/trunk/doc/README.other/README.AIX
brlcad/trunk/doc/README.other/README.BSD
brlcad/trunk/doc/README.other/README.IRIX
brlcad/trunk/doc/README.other/README.OSCON-2014
brlcad/trunk/doc/README.other/README.Solaris
brlcad/trunk/doc/README.other/README.VAX
Modified: brlcad/trunk/doc/CMakeLists.txt
===================================================================
--- brlcad/trunk/doc/CMakeLists.txt 2020-09-13 06:05:48 UTC (rev 77117)
+++ brlcad/trunk/doc/CMakeLists.txt 2020-09-13 06:29:24 UTC (rev 77118)
@@ -9,11 +9,11 @@
README.Linux
README.MacOSX
README.Windows
- README.other/README.AIX
- README.other/README.BSD
- README.other/README.IRIX
- README.other/README.Solaris
- README.other/README.VAX
+ README.AIX
+ README.BSD
+ README.IRIX
+ README.Solaris
+ README.VAX
checklist.txt
description.txt
notes/TODO.BREP
@@ -208,7 +208,7 @@
CMAKEFILES(
CMakeLists.txt
- README.other/README.OSCON-2014
+ README.OSCON-2014
STARTERS
STRATEGY
notes/bsd_semaphore_bug.txt
Copied: brlcad/trunk/doc/README.AIX (from rev 77117,
brlcad/trunk/doc/README.other/README.AIX)
===================================================================
--- brlcad/trunk/doc/README.AIX (rev 0)
+++ brlcad/trunk/doc/README.AIX 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,35 @@
+BRL-CAD on AIX README
+=====================
+
+Dec. 15, 2011 - As of this date, it has been some time since an AIX
+build of BRL-CAD has been tested, and thus far it has NOT been tested
+b with the new CMake build system.
+
+Kitware provides an AIX powerpc binary for CMake, see
+http://www.cmake.org/cmake/resources/software.html
+
+
+Building BRL-CAD under AIX is fairly straightforward using a correctly
+installed version on the GCC compiler. If, however, you are using the
+IBM Visual Age compiler, then there are additional manual compilation
+steps that will be necessary. In particular, the IBM compiler and
+associated standard C library headers are inconsistent with respect to
+ANSI/POSIX compliance compiler options.
+
+The IBM compiler supports a variety of compliance options, the two of
+particular relevance to building BRL-CAD (in terms of being the close
+to obtaining a functional compile) are the strict compliance
+(-qlanglvl=stdc89) or "extended" compliance (-qlanglvl=extc89) modes.
+Problems encountered in our build environment using strict compliance
+does mostly work though we ran into errors in the standard C library
+headers.
+
+Using the "extended" compliance mode resolved the standard C library
+header issues, but introduces problems in the compilation of BRL-CAD
+as the compiler then disables the provision of the __STDC__
+preprocessor symbol. BRL-CAD then defaults back to K&R mode, which
+the compiler verbosely refuses to compile. The "quick fix" that has
+been used in the past is to simply swap the compiler between the two
+modes as when one fails (e.g. strict), the other usually succeeds
+(e.g. extended). Barring that working, you can use extended mode and
+define __STDC__ manually.
Copied: brlcad/trunk/doc/README.BSD (from rev 77117,
brlcad/trunk/doc/README.other/README.BSD)
===================================================================
--- brlcad/trunk/doc/README.BSD (rev 0)
+++ brlcad/trunk/doc/README.BSD 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,16 @@
+BRL-CAD on BSD README
+=====================
+
+BRL-CAD is frequently compiled under various variants of
+BSD including FreeBSD, NetBSD, OpenBSD, and even the original
+4.3 BSD (though now rare) - FreeBSD is the most common BSD
+platform tested, not counting Mac OSX. See the README.VAX
+document for additional details that pertain to building
+BRL-CAD on a VAX running BSD.
+
+CMake binaries for *BSD operating systems are not distributed
+by Kitware, but should be available through standard *BSD
+packaging mechanisms. Failing that, CMake can be bootstrapped
+without much difficulty on most modern Unix-style platforms.
+
+BRL-CAD is included in the FreeBSD Ports system.
Copied: brlcad/trunk/doc/README.IRIX (from rev 77117,
brlcad/trunk/doc/README.other/README.IRIX)
===================================================================
--- brlcad/trunk/doc/README.IRIX (rev 0)
+++ brlcad/trunk/doc/README.IRIX 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,51 @@
+BRL-CAD on IRIX README
+======================
+
+Building on IRIX is one of the most tricky platforms to support
+without installing up-to-date compilation tools. That said, the build
+has and should work just fine with either the MIPSPro or GCC
+compilers. The best performance is usually achieved with the MIPSPro
+compiler, whereas GCC will compile faster with less fuss.
+
+Kitware provides CMake binaries for IRIX64 platforms:
+http://www.cmake.org/cmake/resources/software.html
+
+
+Parallel building
+-----------------
+For parallel compilation on IRIX, the -P option enables parallel
+build mode and the PARALLEL environment variable sets the number
+of CPUs (default is two):
+
+PARALLEL=4 make -P
+
+
+Potential problems you may encounter
+------------------------------------
+
+Symptom: MIPSPro linker reports symbol(s) missing
+
+Description: There's a known bug in the MIPSpro linker involving
+rpaths that are too long (namely longer than 255 characters) so care
+should be taken to not compile in directories that are too deep. The
+way this bug is usually seen is that the build will fail during
+compilation where unresolved symbols are reported during linking,
+symbols that are correctly included in the libraries being linked.
+
+Workaround: It is usually sufficient to retry the compile from a
+shorter path. (e.g., /tmp instead of /some/deep/path/to/brlcad)
+
+---
+
+Symptom: GCC crashes during compilation with internal errors
+
+Description: Certain versions of the gcc compiler are known to crash
+with internal error messages, for example on src/mged/animedit.c, when
+using optimization flags (i.e. -O3).
+
+Workaround: Compile in whatever directory is failing with -O0 instead:
+ cd src/mged
+ sed -i "s/ -O3 / -O0 /g" CMakeFiles/mged.dir/flags.make
+ make
+ cd ../..
+ make
Copied: brlcad/trunk/doc/README.OSCON-2014 (from rev 77117,
brlcad/trunk/doc/README.other/README.OSCON-2014)
===================================================================
--- brlcad/trunk/doc/README.OSCON-2014 (rev 0)
+++ brlcad/trunk/doc/README.OSCON-2014 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,53 @@
+BRL-CAD: A Vibrant Open Source Model
+
++ intro
+
+ - speaker
+
+ - old vs. new (Rurel's joke about old farmer and his young farmhand)
+
++ overview
+
+ - history, players
+
+ Mike Muuss [author of ping]
+
+ - license
+
+ - languages (Ohloh stats)
+
++ important technical features
+
+ - database format
+
+ - tools
+
+ - libraries
+
+ - use of other FOSS libraries
+
+ - road map
+
++ other features
+
++ community
+
+ - players (Ohloh stats)
+
++ process
+
+ - Source Forge
+
+ - API changes
+
+ - deprecation policy
+
+ - release procedures
+
+ - version control
+
+ - bug tracking
+
+- policy
+
+- outreach
Copied: brlcad/trunk/doc/README.Solaris (from rev 77117,
brlcad/trunk/doc/README.other/README.Solaris)
===================================================================
--- brlcad/trunk/doc/README.Solaris (rev 0)
+++ brlcad/trunk/doc/README.Solaris 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,61 @@
+BRL-CAD on Solaris README
+=========================
+In recent years, there have been a variety of Solaris-style operating
+systems that have appeared, following Sun's open-source release of
+OpenSolaris. OpenSolaris itself doesn't seem to be especially active, but
+another derivative system called OpenIndiana has appeared, based on the
+illumos kernel - the Solaris file will be the place to add any notes
+needed to build on such derivative systems, as well as Solaris proper.
+
+Kitware does not provide a pre-compiled binary for CMake on Solaris
+type systems. To bootstrap from the source code, try the following:
+
+(You probably want to use gmake and gcc/g++ for this...)
+
+1. Download the source from http://www.cmake.org/cmake/resources/software.html
+2. unzip the tarball: gunzip cmake-X.Y.Z.tar.gz
+3. open the tarball: tar -xvf cmake-X.Y.Z.tar
+4. cd cmake-X.Y.Z
+5. CXX=g++ ./bootstrap -prefix=/home/user/cmake-install (or your preferred
directory)
+6. gmake
+7. gmake install
+
+Then (if you installed to somewhere other than a system dir) add the
+bin directory to your path:
+
+csh: setenv PATH /home/user/cmake-install/bin:$PATH
+bash: export PATH=/home/user/cmake-install/bin:$PATH
+
+From there, you should be good to build BRL-CAD. The most recent tests
+of the Sun Studio compiler suggest that there are issues to resolve,
+so (unless you want to fix those issues, which would be welcome!) you
+probably want to use the GCC compiler suite to build BRL-CAD as well:
+
+CC=gcc CXX=g++ cmake ../brlcad
+
+If while compiling you encounter an error "Text relocation remains
+against symbol" along with some number of lines following, it usually
+means that the build has attempted to link a static system library
+into a shared library being compiled (e.g. attempting to link a system
+libz.a into the png library distributed in src/other/libpng being
+compiled as libpng.so). If this happens, it likely indicates a problem
+with the CMake build logic and should be reported as a bug - you may also
+need to install a shared version of the library. Another possibility
+would be to add -mipure-text to the linker flags.
+
+OpenIndiana
+-----------
+
+To build with gcc and CMake on OpenIndiana, you need to install the
+following packages:
+
+pkg install pkg:/developer/gcc-7
+pkg install pkg:/developer/build/cmake
+pkg install pkg:/developer/versioning/subversion
+pkg install pkg:/system/header
+pkg install pkg:/developer/lexer/flex
+
+(Note that gcc-7 building doesn't work as of 2017-08-23 - the above
+install list is a starting point, but the repo currently doesn't
+build and isn't close to building. It may be an older gcc would
+have better luck...)
Copied: brlcad/trunk/doc/README.VAX (from rev 77117,
brlcad/trunk/doc/README.other/README.VAX)
===================================================================
--- brlcad/trunk/doc/README.VAX (rev 0)
+++ brlcad/trunk/doc/README.VAX 2020-09-13 06:29:24 UTC (rev 77118)
@@ -0,0 +1,43 @@
+BRL-CAD on VAX README
+=====================
+
+One of the first systems to run BRL-CAD was the VAX. In particular, a
+VAX 11/780 named VGR is the baseline reference machine for the BRL-CAD
+Benchmark suite. Through the 80's and most of the 90's, BRL-CAD was
+compiled for and maintained on VGR running 4.3 BSD until the hardware
+was finally decommissioned.
+
+BRL-CAD has been successfully compiled for and run under the simh
+Computer History Simulation Project's VAX simulator. Using this
+simulator, it's feasible to install one of the BSD variants
+(e.g. NetBSD) and the GCC compiler.
+
+No one has tried bootstrapping CMake on a VAX simh NetBSD image yet, so it
+is not known what problems may occur - the basic bootstrap procedure is:
+
+1. Download the source from http://www.cmake.org/cmake/resources/software.html
+2. unzip the tarball: gunzip cmake-X.Y.Z.tar.gz
+3. open the tarball: tar -xvf cmake-X.Y.Z.tar
+4. cd cmake-X.Y.Z
+5. CXX=g++ ./bootstrap -prefix=/home/user/cmake-install (or your preferred
directory)
+6. gmake
+7. gmake install
+
+As of the last effort involved in compiling BRL-CAD under this
+environment (using GNU Autotools), there were a few steps
+necessary that included the following:
+
+ - Define the preprocessor symbol "vax".
+
+ - Disable compilation of libfft and sig. The FFT library builds
+ convolution kernels that are too large for the usual VAX memory
+ sizes.
+
+ - Compile against libm.a instead of libm.so. The shared object
+ library (at least under NetBSD) is buggy and will cause run-time
+ bus errors (i.e. rt will crash). With CMake, you might try:
+ -DM_LIBRARY=/usr/lib/libm.a
+
+After those steps, you should at least be able to perform a benchmark
+compilation (i.e. "make benchmark"), raytrace images, and obtain
+performance metrics.
Deleted: brlcad/trunk/doc/README.other/README.AIX
===================================================================
--- brlcad/trunk/doc/README.other/README.AIX 2020-09-13 06:05:48 UTC (rev
77117)
+++ brlcad/trunk/doc/README.other/README.AIX 2020-09-13 06:29:24 UTC (rev
77118)
@@ -1,35 +0,0 @@
-BRL-CAD on AIX README
-=====================
-
-Dec. 15, 2011 - As of this date, it has been some time since an AIX
-build of BRL-CAD has been tested, and thus far it has NOT been tested
-b with the new CMake build system.
-
-Kitware provides an AIX powerpc binary for CMake, see
-http://www.cmake.org/cmake/resources/software.html
-
-
-Building BRL-CAD under AIX is fairly straightforward using a correctly
-installed version on the GCC compiler. If, however, you are using the
-IBM Visual Age compiler, then there are additional manual compilation
-steps that will be necessary. In particular, the IBM compiler and
-associated standard C library headers are inconsistent with respect to
-ANSI/POSIX compliance compiler options.
-
-The IBM compiler supports a variety of compliance options, the two of
-particular relevance to building BRL-CAD (in terms of being the close
-to obtaining a functional compile) are the strict compliance
-(-qlanglvl=stdc89) or "extended" compliance (-qlanglvl=extc89) modes.
-Problems encountered in our build environment using strict compliance
-does mostly work though we ran into errors in the standard C library
-headers.
-
-Using the "extended" compliance mode resolved the standard C library
-header issues, but introduces problems in the compilation of BRL-CAD
-as the compiler then disables the provision of the __STDC__
-preprocessor symbol. BRL-CAD then defaults back to K&R mode, which
-the compiler verbosely refuses to compile. The "quick fix" that has
-been used in the past is to simply swap the compiler between the two
-modes as when one fails (e.g. strict), the other usually succeeds
-(e.g. extended). Barring that working, you can use extended mode and
-define __STDC__ manually.
Deleted: brlcad/trunk/doc/README.other/README.BSD
===================================================================
--- brlcad/trunk/doc/README.other/README.BSD 2020-09-13 06:05:48 UTC (rev
77117)
+++ brlcad/trunk/doc/README.other/README.BSD 2020-09-13 06:29:24 UTC (rev
77118)
@@ -1,16 +0,0 @@
-BRL-CAD on BSD README
-=====================
-
-BRL-CAD is frequently compiled under various variants of
-BSD including FreeBSD, NetBSD, OpenBSD, and even the original
-4.3 BSD (though now rare) - FreeBSD is the most common BSD
-platform tested, not counting Mac OSX. See the README.VAX
-document for additional details that pertain to building
-BRL-CAD on a VAX running BSD.
-
-CMake binaries for *BSD operating systems are not distributed
-by Kitware, but should be available through standard *BSD
-packaging mechanisms. Failing that, CMake can be bootstrapped
-without much difficulty on most modern Unix-style platforms.
-
-BRL-CAD is included in the FreeBSD Ports system.
Deleted: brlcad/trunk/doc/README.other/README.IRIX
===================================================================
--- brlcad/trunk/doc/README.other/README.IRIX 2020-09-13 06:05:48 UTC (rev
77117)
+++ brlcad/trunk/doc/README.other/README.IRIX 2020-09-13 06:29:24 UTC (rev
77118)
@@ -1,51 +0,0 @@
-BRL-CAD on IRIX README
-======================
-
-Building on IRIX is one of the most tricky platforms to support
-without installing up-to-date compilation tools. That said, the build
-has and should work just fine with either the MIPSPro or GCC
-compilers. The best performance is usually achieved with the MIPSPro
-compiler, whereas GCC will compile faster with less fuss.
-
-Kitware provides CMake binaries for IRIX64 platforms:
-http://www.cmake.org/cmake/resources/software.html
-
-
-Parallel building
------------------
-For parallel compilation on IRIX, the -P option enables parallel
-build mode and the PARALLEL environment variable sets the number
-of CPUs (default is two):
-
-PARALLEL=4 make -P
-
-
-Potential problems you may encounter
-------------------------------------
-
-Symptom: MIPSPro linker reports symbol(s) missing
-
-Description: There's a known bug in the MIPSpro linker involving
-rpaths that are too long (namely longer than 255 characters) so care
-should be taken to not compile in directories that are too deep. The
-way this bug is usually seen is that the build will fail during
-compilation where unresolved symbols are reported during linking,
-symbols that are correctly included in the libraries being linked.
-
-Workaround: It is usually sufficient to retry the compile from a
-shorter path. (e.g., /tmp instead of /some/deep/path/to/brlcad)
-
----
-
-Symptom: GCC crashes during compilation with internal errors
-
-Description: Certain versions of the gcc compiler are known to crash
-with internal error messages, for example on src/mged/animedit.c, when
-using optimization flags (i.e. -O3).
-
-Workaround: Compile in whatever directory is failing with -O0 instead:
- cd src/mged
- sed -i "s/ -O3 / -O0 /g" CMakeFiles/mged.dir/flags.make
- make
- cd ../..
- make
Deleted: brlcad/trunk/doc/README.other/README.OSCON-2014
===================================================================
--- brlcad/trunk/doc/README.other/README.OSCON-2014 2020-09-13 06:05:48 UTC
(rev 77117)
+++ brlcad/trunk/doc/README.other/README.OSCON-2014 2020-09-13 06:29:24 UTC
(rev 77118)
@@ -1,53 +0,0 @@
-BRL-CAD: A Vibrant Open Source Model
-
-+ intro
-
- - speaker
-
- - old vs. new (Rurel's joke about old farmer and his young farmhand)
-
-+ overview
-
- - history, players
-
- Mike Muuss [author of ping]
-
- - license
-
- - languages (Ohloh stats)
-
-+ important technical features
-
- - database format
-
- - tools
-
- - libraries
-
- - use of other FOSS libraries
-
- - road map
-
-+ other features
-
-+ community
-
- - players (Ohloh stats)
-
-+ process
-
- - Source Forge
-
- - API changes
-
- - deprecation policy
-
- - release procedures
-
- - version control
-
- - bug tracking
-
-- policy
-
-- outreach
Deleted: brlcad/trunk/doc/README.other/README.Solaris
===================================================================
--- brlcad/trunk/doc/README.other/README.Solaris 2020-09-13 06:05:48 UTC
(rev 77117)
+++ brlcad/trunk/doc/README.other/README.Solaris 2020-09-13 06:29:24 UTC
(rev 77118)
@@ -1,61 +0,0 @@
-BRL-CAD on Solaris README
-=========================
-In recent years, there have been a variety of Solaris-style operating
-systems that have appeared, following Sun's open-source release of
-OpenSolaris. OpenSolaris itself doesn't seem to be especially active, but
-another derivative system called OpenIndiana has appeared, based on the
-illumos kernel - the Solaris file will be the place to add any notes
-needed to build on such derivative systems, as well as Solaris proper.
-
-Kitware does not provide a pre-compiled binary for CMake on Solaris
-type systems. To bootstrap from the source code, try the following:
-
-(You probably want to use gmake and gcc/g++ for this...)
-
-1. Download the source from http://www.cmake.org/cmake/resources/software.html
-2. unzip the tarball: gunzip cmake-X.Y.Z.tar.gz
-3. open the tarball: tar -xvf cmake-X.Y.Z.tar
-4. cd cmake-X.Y.Z
-5. CXX=g++ ./bootstrap -prefix=/home/user/cmake-install (or your preferred
directory)
-6. gmake
-7. gmake install
-
-Then (if you installed to somewhere other than a system dir) add the
-bin directory to your path:
-
-csh: setenv PATH /home/user/cmake-install/bin:$PATH
-bash: export PATH=/home/user/cmake-install/bin:$PATH
-
-From there, you should be good to build BRL-CAD. The most recent tests
-of the Sun Studio compiler suggest that there are issues to resolve,
-so (unless you want to fix those issues, which would be welcome!) you
-probably want to use the GCC compiler suite to build BRL-CAD as well:
-
-CC=gcc CXX=g++ cmake ../brlcad
-
-If while compiling you encounter an error "Text relocation remains
-against symbol" along with some number of lines following, it usually
-means that the build has attempted to link a static system library
-into a shared library being compiled (e.g. attempting to link a system
-libz.a into the png library distributed in src/other/libpng being
-compiled as libpng.so). If this happens, it likely indicates a problem
-with the CMake build logic and should be reported as a bug - you may also
-need to install a shared version of the library. Another possibility
-would be to add -mipure-text to the linker flags.
-
-OpenIndiana
------------
-
-To build with gcc and CMake on OpenIndiana, you need to install the
-following packages:
-
-pkg install pkg:/developer/gcc-7
-pkg install pkg:/developer/build/cmake
-pkg install pkg:/developer/versioning/subversion
-pkg install pkg:/system/header
-pkg install pkg:/developer/lexer/flex
-
-(Note that gcc-7 building doesn't work as of 2017-08-23 - the above
-install list is a starting point, but the repo currently doesn't
-build and isn't close to building. It may be an older gcc would
-have better luck...)
Deleted: brlcad/trunk/doc/README.other/README.VAX
===================================================================
--- brlcad/trunk/doc/README.other/README.VAX 2020-09-13 06:05:48 UTC (rev
77117)
+++ brlcad/trunk/doc/README.other/README.VAX 2020-09-13 06:29:24 UTC (rev
77118)
@@ -1,43 +0,0 @@
-BRL-CAD on VAX README
-=====================
-
-One of the first systems to run BRL-CAD was the VAX. In particular, a
-VAX 11/780 named VGR is the baseline reference machine for the BRL-CAD
-Benchmark suite. Through the 80's and most of the 90's, BRL-CAD was
-compiled for and maintained on VGR running 4.3 BSD until the hardware
-was finally decommissioned.
-
-BRL-CAD has been successfully compiled for and run under the simh
-Computer History Simulation Project's VAX simulator. Using this
-simulator, it's feasible to install one of the BSD variants
-(e.g. NetBSD) and the GCC compiler.
-
-No one has tried bootstrapping CMake on a VAX simh NetBSD image yet, so it
-is not known what problems may occur - the basic bootstrap procedure is:
-
-1. Download the source from http://www.cmake.org/cmake/resources/software.html
-2. unzip the tarball: gunzip cmake-X.Y.Z.tar.gz
-3. open the tarball: tar -xvf cmake-X.Y.Z.tar
-4. cd cmake-X.Y.Z
-5. CXX=g++ ./bootstrap -prefix=/home/user/cmake-install (or your preferred
directory)
-6. gmake
-7. gmake install
-
-As of the last effort involved in compiling BRL-CAD under this
-environment (using GNU Autotools), there were a few steps
-necessary that included the following:
-
- - Define the preprocessor symbol "vax".
-
- - Disable compilation of libfft and sig. The FFT library builds
- convolution kernels that are too large for the usual VAX memory
- sizes.
-
- - Compile against libm.a instead of libm.so. The shared object
- library (at least under NetBSD) is buggy and will cause run-time
- bus errors (i.e. rt will crash). With CMake, you might try:
- -DM_LIBRARY=/usr/lib/libm.a
-
-After those steps, you should at least be able to perform a benchmark
-compilation (i.e. "make benchmark"), raytrace images, and obtain
-performance metrics.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
