README-hacking

-*- outline -*-

These notes intend to help people working on the checked-out sources.
These requirements do not apply when building from a distribution tarball.


* Requirements

We've opted to keep only the highest-level sources in the GIT repository.
This eases our maintenance burden, (fewer merges etc.), but imposes more
requirements on anyone wishing to build from the just-checked-out sources.
Note the requirements to build the released archive are much less and
are just the requirements of the standard ./configure && make procedure.
Specific development tools and versions will be checked for and listed by
the bootstrap script.  See README-prereq for specific notes on obtaining
these prerequisite tools.

Valgrind <http://valgrind.org/> is also highly recommended, if
Valgrind supports your architecture. See also README-valgrind.

While building from a just-cloned source tree may require installing a
few prerequisites, later, a plain `git pull && make' should be sufficient.

* First GIT checkout

You can get a copy of the source repository like this:

        $ git clone git://git.savannah.gnu.org/cssc.git
        $ cd cssc

The next step is to get and check other files needed to build,
which are extracted from other source packages:

        $ ./bootstrap

If /bin/sh on your system is not POSIX-compatible, then you may need
to run "bootsrap" with a POSIX shell (for example /usr/xpg4/bin/sh on
Solaris).

And there you are!  Just

        $ ./configure --quiet --enable-binary
        $ make
        $ make check

Enjoy!

* If it's not your first GIT checkout

We used to check the googletest subdirectory out from svn, but this
has now moved to git.  Therefore you may need to delete any existing
googletest directory before running "bootstrap".

* Compiler Warnings

You can also enable additional compiler warnings if you prefer, like
this:
        $ ./configure --quiet --enable-binary --enable-gcc-warnings

The --enable-gcc-warnings option is probably useful only with glibc.
If you configure with this option, and spot a problem, please be sure
to send the report to the bug reporting address of this package, and
not to that of gnulib, even if the problem seems to originate in a
gnulib-provided file.

-----

Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2019, 2024 Free Software Foundation, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.