Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

README.md: Update to say something more currently and directly useful

Mention bugurl, pkgversion, and how these are generally built for the
illumos build environment.
  • Loading branch information...
commit ff28631112cd3766b361949dd4e616edacae7c26 1 parent f268959
@richlowe authored
Showing with 39 additions and 8 deletions.
  1. +39 −8 README.md
View
47 README.md
@@ -1,8 +1,39 @@
-This is GCC with the patches from CodeSourcery and Sun Microsystems used in
-the gcc 3.4.3 shipped with Solaris on the codesourcery/* and sun/* branches,
-and the GCCFSS sources from the git repository in their source tarball in the
-sun/gccfss* branches.
-
-The il-* branches contain the Solaris patches rebased forward across GCC
-versions in an attempt to bring them up to date. All stupidity in the merges is
-mine.
+This is the GCC used for compiling illumos.
+
+The `il-*` branches contain the the patches used for building illumos, which
+are rebased versions of those used for Solaris/OpenSolaris, and then
+additional changes. The versions actually in use are tagged with
+`il-VERSION-ilN` where _N_ version the illumos changes over the GCC version in
+question.
+
+The `wip/*` branches are works in progress and _should never be used_
+
+The `codesourcery/*` and `sun/*` branches contain the original GCCs as patched by
+CodeSourcery and Sun Microsystems for use compiling Solaris and OpenSolaris as
+was, and the GCCFSS patches of Sun's
+
+When building the compilers for illumos use the flags generally used are:
+
+i386
+~~~sh
+../../configure --prefix=/opt/gcc/$VER --with-as=/usr/sfw/bin/gas --with-gnu-as \
+ --with-ld=/usr/bin/ld --without-gnu-ld --enable-languages="c,c++,objc" \
+ --enable-shared --with-mpfr-include=/usr/include/mpfr \
+ --with-gmp-include=/usr/include/gmp \
+ --with-pkgversion="Illumos $(git describe --all)" \
+ --with-bugurl="http://github.com/richlowe/gcc/issues"
+~~~
+
+sparc
+~~~sh
+../../configure --prefix=/opt/gcc/$VER --without-gnu-as --with-as=/usr/ccs/bin/as" \
+ --with-ld=/usr/bin/ld --without-gnu-ld --enable-languages="c,c++,objc" \
+ --enable-shared --with-mpfr-include=/usr/include/mpfr \
+ --with-gmp-include=/usr/include/gmp \
+ --with-pkgversion="Illumos $(git describe --all)" \
+ --with-bugurl="http://github.com/richlowe/gcc/issues"
+~~~
+
+Please use the correct `--with-bugurl` and `--with-pkgversion` flags as
+appropriate for any modifications you make, but please also be sure that they
+accurately describe what is in use (ie, are not left at the defaults) either.
Please sign in to comment.
Something went wrong with that request. Please try again.