Ticket #3433: SharedUserBuildConfig_ReadMe.diff

File SharedUserBuildConfig_ReadMe.diff, 2.6 KB (added by mmadia, 15 years ago)
  • .ReadMe

    old new  
    1 # UserBuildConfig ReadMe
     1# SharedUserBuildConfig ReadMe
    22# ----------------------
    33
    4 # UserBuildConfig can be used to customize the build according to your needs.
     4# SharedUserBuildConfig can be used to customize the build according to your needs.
    55# If existent it is included by the build system, but it is ignored by svn.
     6# In addition to SharedUserBuildConfig, the build system supports LocalUserBuildConfig.
     7# LocalUserBuildConfig resides in your HAIKU_OUTPU_DIR, typically generated/.
     8# Values in LocalUserBuildConfig will over-write those in SharedUserBuildConfig.
    69# This file documents a few examples, what can be done. Don't just rename it
    7 # to UserBuildConfig -- you don't want all the things to happen, that are
    8 # specified here. Rather create an empty UserBuildConfig and copy the lines
    9 # you really want, or start out with UserBuildConfig.sample.
     10# to SharedUserBuildConfig -- you don't want all the things to happen, that are
     11# specified here. Rather create an empty SharedUserBuildConfig and copy the lines
     12# you really want, or start out with SharedUserBuildConfig.sample.
    1013# Of course, noone reads ReadMe files, so they will just get an error here
    1114# when copying it and jamming:
    12 Exit You must NOT copy UserBuildConfig.ReadMe directly but use parts of it! ;
     15Exit You must NOT copy SharedUserBuildConfig.ReadMe directly but use parts of it! ;
    1316
    1417
    1518# Adjusting Build Variables
    1619
    1720# The following variables can be configured per subdirectory (or subtree) or
    1821# even per object file:
    1922#
    2023#   CCFLAGS C++FLAGS DEBUG DEFINES HDRS LINKFLAGS OPTIM OPTIMIZE SYSHDRS
    switch $(HAIKU_BUILD_PROFILE) {  
    224227# jam -q @vmware update kernel
    225228#   -> Equivalent to running "jam -q update-vmware-image kernel" with the
    226229#      settings for the "vmware" profile.
    227230# jam -q @crash mount
    228231#   -> Enters the bfs_shell mounting the image specified by the "crash" profile.
    229232#
    230233# Note, that the build system will automatically define the build profiles
    231234# "image", "vmware-image", and "install", unless they are already defined in
    232 # the UserBuildConfig. They correspond to the respective build profile types
     235# the SharedUserBuildConfig. They correspond to the respective build profile types
    233236# and use the values of the variables HAIKU[_VMWARE]_IMAGE_NAME,
    234237# HAIKU_IMAGE_DIR, HAIKU_INSTALL_DIR, respectively their default values.
    235238# "jam -q @image" will therefore be equivalent to "jam -q haiku-image".
    236239
    237240
    238241# Creating Sourceable Shell Scripts
    239242
    240243# If you use shell scripts (e.g. for testing) that need to access targets or