documentation improvements

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@34020 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
rfm 2011-10-18 07:19:16 +00:00
parent 62e4aa75b9
commit 5d9f6c805c
3 changed files with 30 additions and 13 deletions

View file

@ -1,7 +1,9 @@
2011-10-18 Richard Frith-Macdonald <rfm@gnu.org>
* standalone.conf: example configuration file for a stanadalone
* standalone.conf: example configuration file for a standalone
package installation.
* Documentation/Base.gsdoc:
Documentation improvements for packaging
2011-10-17 Richard Frith-Macdonald <rfm@gnu.org>

View file

@ -773,7 +773,7 @@ notice and this notice are preserved.
You configure/install gnustep-make with the 'standalone'
filesystem layout, then you configure/build/install gnustep-base
with the 'standalone.conf' default configuration file, and
build/install the other librarties/packages your app depends
build/install the other libraries/packages your app depends
upon.<br />
This leaves you with a 'standalone' directory containing all
the relocatable code, which you can then copy into your app
@ -786,7 +786,7 @@ cd make
make install
. ~/standalone/Makefile/GNUstep.sh
cd ../base
./configure --with-config-file=./ --with-default-config=standalone.conf
./configure --with-config-file=./GNUstep.conf --with-default-config=standalone.conf
make install
cd ../gui
make install

View file

@ -1,5 +1,5 @@
#
# Standalone filesystem layout
# Standalone file system layout
#
# This is a *deployment* layout for standalone application deployment,
# with all the libraries and executables stored in one place.
@ -7,29 +7,39 @@
# gnustep-make (FilesystemLayouts/standalone).
#
# You can configure gnustep-base using
# --with-config-file=./GNUstep.conf --with-default-config=standalone.conf
# to provide built-in path information from this file, but permit it to be
# overridden by a GNUstep.conf file at runtime.
#
# You can configure gnustep-base using
# --with-config-file=./ --with-default-config=standalone.conf
# to tell if to ignore any GNUstep.conf file and always use the resource
# to tell if to ignore any GNUstep.conf file and always use the built-in
# location information obtained from this file.
# Alternatively, you can configue base using
# --with-config-file=./GNUstep.conf
# and copy this file to ~/standalone/GNUstep.conf if you want to be able
# to modify locations later rather than having them hard-coded.
#
# This tells gnustep-make to put the 'standalone' directory in your home
# directory.
# directory. It's not actually used for a deployed application, but this
# matches the configuration you would have used when building your code.
GNUSTEP_DEFAULT_PREFIX=~
# These are only used to implement the NSUserDirectory API.
# They are used literall, without the default prefix.
# They are used literally, without the default prefix.
GNUSTEP_SYSTEM_USERS_DIR=/home
GNUSTEP_NETWORK_USERS_DIR=/home
GNUSTEP_LOCAL_USERS_DIR=/home
# NB: $prefix will be added to all the MAKEFILES/SYSTEM/NETWORK/LOCAL
# paths.
# This is used by gnustep-make when building/installing systems and is not
# actually relevant to a deployed application.
GNUSTEP_MAKEFILES=./Makefiles
# The following path settings are designed to find all resources relative to
# the configured location of the GNUstep config file, which should itself
# be found at a location relative to the gnustep-base library.
# So normally, the '.' in these paths represents the 'standalone' directory
# you will have copied into your application.
# The paths locate all binaries (libraries and executables) in the same
# directory, but puts documentation and headers in subdirectories since
# you may wish to delete those rather then distribute them with your app.
GNUSTEP_SYSTEM_APPS=./
GNUSTEP_SYSTEM_ADMIN_APPS=./
GNUSTEP_SYSTEM_WEB_APPS=./
@ -66,6 +76,11 @@ GNUSTEP_LOCAL_DOC=./Documentation
GNUSTEP_LOCAL_DOC_MAN=./man
GNUSTEP_LOCAL_DOC_INFO=./info
# For a standalone deployment we use the normal directory layout for
# user resources, but hide that in .GNUstep rather than the normal
# GNUstep directory since we assume that a standalone deployment implies
# that the target system is non-gnustep and the user won't be expecting
# to see GNUstep in their home directory.
GNUSTEP_USER_DIR_APPS=.GNUstep/Applications
GNUSTEP_USER_DIR_ADMIN_APPS=.GNUstep/Applications/Admin
GNUSTEP_USER_DIR_WEB_APPS=.GNUstep/WebApplications