Rename Makefile.config to Makefile.defaults and update the docs

svn path=/trunk/netsurf/; revision=6937
This commit is contained in:
Daniel Silverstone 2009-03-27 11:23:25 +00:00
parent 38c56a9d73
commit 308d2d3345
4 changed files with 47 additions and 41 deletions

View File

@ -16,10 +16,11 @@
Building and executing NetSurf
=================================
First of all, you should examine the contents of Makefile.config and enable
and disable relevant features as you see fit. Some of these options can be
automatically detected and used, although it is better to explicitly enable
or disable options.
First of all, you should examine the contents of Makefile.defaults
and enable and disable relevant features as you see fit by creating
a Makefile.config. Some of these options can be automatically
detected and used, although it is better to explicitly enable or
disable options.
You should then obtain NetSurf's dependencies, keeping in mind which options
you have enabled in the configuration file. See the next section for
@ -31,7 +32,7 @@
If that produces errors, you probably don't have some of NetSurf's build
dependencies installed. See "Obtaining NetSurf's dependencies" below, or turn
off the complaining features in Makefile.config.
off the complaining features in a Makefile.config.
Running NetSurf from the build tree requires some setup:
@ -161,7 +162,7 @@
NetSurf uses James Shaw's librosprite for rendering RISC OS Sprite files on
non-RISC OS platforms. The Makefile will automatically use librosprite, you
can disable it by editing Makefile.config.
can disable it by creating a Makefile.config.
To build librosprite, check out from svn://svn.rjek.com/jshaw/libsprite/trunk
@ -173,7 +174,7 @@
NetSurf can use Haru PDF to enable PDF export and printing in GTK. This
is currently enabled by default, and cannot be auto-detected by the Makefile.
If you wish to disable it, do so by editing Makefile.config.
If you wish to disable it, do so by creating a Makefile.config.
Haru PDF can be obtained from http://libharu.sourceforge.net/, although we
currently depend on features that the official version does not have. You

View File

@ -10,13 +10,12 @@
Building and executing NetSurf
=================================
First of all, you should examine the contents of Makefile.config and
enable and disable relevant features as you see fit in a
Makefile.config.override . Some of these options can be
automatically detected and used, and where this is the case they are
set to such. Others cannot be automatically detected from the
Makefile, so you will either need to install the dependencies, or
set them to NO.
First of all, you should examine the contents of Makefile.defaults
and enable and disable relevant features as you see fit in a
Makefile.config file. Some of these options can be automatically
detected and used, and where this is the case they are set to such.
Others cannot be automatically detected from the Makefile, so you
will either need to install the dependencies, or set them to NO.
One option it is vitally important to set is the Framebuffer ports
frontend type by setting the NETSURF_FB_FRONTEND variable. The port
@ -33,7 +32,7 @@
If that produces errors, you probably don't have some of NetSurf's build
dependencies installed. See "Obtaining NetSurf's dependencies" below. Or turn
off the complaining features in Makefile.config. You may need to "make clean"
off the complaining features in your Makefile.config. You may need to "make clean"
before attempting to build after installing the dependencies.
Run NetSurf by executing the "nsfb" shell script:
@ -263,9 +262,10 @@ Index: framebuffer/fb_font_freetype.c
Librosprite
-------------
NetSurf uses James Shaw's librosprite for rendering RISC OS Sprite files on
non-RISC OS platforms. The Makefile will automatically use librosprite if
it is installed. You can disable it entirely by editing Makefile.config.
NetSurf uses James Shaw's librosprite for rendering RISC OS Sprite
files on non-RISC OS platforms. The Makefile will automatically use
librosprite if it is installed. You can disable it entirely by
creating a Makefile.config file.
To build librosprite, check out from svn://svn.rjek.com/jshaw/libsprite/trunk
Build and install it:
@ -281,7 +281,7 @@ Index: framebuffer/fb_font_freetype.c
NetSurf can use Haru PDF to enable PDF export and printing in GTK. This
is currently enabled by default, and cannot be auto-detected by the Makefile.
If you wish to disable it, do so by editing Makefile.config.
If you wish to disable it, do so by creating a Makefile.config file.
Haru PDF can be obtained from http://libharu.org/, although we currently
depend on features that none of the official released versions does have.

View File

@ -12,11 +12,12 @@
Building and executing NetSurf
=================================
First of all, you should examine the contents of Makefile.config and enable
and disable relevant features as you see fit. Some of these options can be
automatically detected and used, and where this is the case they are set to
such. Others cannot be automatically detected from the Makefile, so you will
either need to install the dependencies, or set them to NO.
First of all, you should examine the contents of Makefile.defaults
and enable and disable relevant features as you see fit by creating
a Makefile.config file. Some of these options can be automatically
detected and used, and where this is the case they are set to such.
Others cannot be automatically detected from the Makefile, so you
will either need to install the dependencies, or set them to NO.
You should then obtain NetSurf's dependencies, keeping in mind which options
you have enabled in the configuration file. See the next section for
@ -26,10 +27,11 @@
$ make
If that produces errors, you probably don't have some of NetSurf's build
dependencies installed. See "Obtaining NetSurf's dependencies" below. Or turn
off the complaining features in Makefile.config. You may need to "make clean"
before attempting to build after installing the dependencies.
If that produces errors, you probably don't have some of NetSurf's
build dependencies installed. See "Obtaining NetSurf's dependencies"
below. Or turn off the complaining features in a Makefile.config
file. You may need to "make clean" before attempting to build after
installing the dependencies.
Run NetSurf by executing the "netsurf" shell script:
@ -119,9 +121,10 @@
Librosprite
-------------
NetSurf uses James Shaw's librosprite for rendering RISC OS Sprite files on
non-RISC OS platforms. The Makefile will automatically use librosprite if
it is installed. You can disable it entirely by editing Makefile.config.
NetSurf uses James Shaw's librosprite for rendering RISC OS Sprite
files on non-RISC OS platforms. The Makefile will automatically use
librosprite if it is installed. You can disable it entirely by
creating a Makefile.config file.
To build librosprite, check out from svn://svn.rjek.com/jshaw/libsprite/trunk
Build and install it:
@ -137,7 +140,7 @@
NetSurf can use Haru PDF to enable PDF export and printing in GTK. This
is currently enabled by default, and cannot be auto-detected by the Makefile.
If you wish to disable it, do so by editing Makefile.config.
If you wish to disable it, do so by creating a Makefile.config file.
Haru PDF can be obtained from http://libharu.org/, although we currently
depend on features that none of the official released versions does have.

View File

@ -1,5 +1,5 @@
#
# NetSurf build configuration
# NetSurf default build configuration
#
# Some of these options support an 'AUTO' option, as well as YES and NO.
# When an option is set to AUTO, the Makefile will attempt to detect if that
@ -9,12 +9,14 @@
# use as a web browser and should be set to YES unless there is a particularly
# good reason not to.
#
# This file should be treated as INVIOLATE and only altered to alter the
# defaults by a core developer. If you wish to configure the build of NetSurf
# then instead please create a file called Makefile.config.override and simply
# override the statements you require in that.
# Remember that Makefile.config.override cannot override the TARGET. That must
# be set on the commandline. i.e. 'make TARGET=framebuffer'
# This file should be treated as INVIOLATE and only altered to alter
# the defaults by a core developer. If you wish to configure the build
# of NetSurf then instead please create a file called Makefile.config
# and simply override the statements you require in that. Remember
# that Makefile.config cannot override the TARGET. That must be set on
# the commandline. i.e. 'make TARGET=framebuffer' However
# Makefile.config can use the TARGET variable to control what to set
# the configuration options to.
#
# ----------------------------------------------------------------------------
@ -234,6 +236,6 @@ ifeq ($(TARGET),framebuffer)
endif
# Include any local overrides
-include Makefile.config.override
# Include any local configuration
-include Makefile.config