admin/fs-build-variables
1
0
Fork 0
mirror of https://github.com/FirestormViewer/fs-build-variables.git synced 2026-08-14 00:57:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove obsolete reference to build-variables fork.

Browse Source 
Also tweak README.md with relative references and code formatting.
This commit is contained in:
Nat Goodspeed
2023-11-14 16:40:41 -05:00
parent ba0dc72228
commit 3eeabb52f1
1 changed files with 17 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -21
View File
@@ -1,44 +1,40 @@
# Overview
This repository is intended to centralize string data common to many builds
This repository is intended to centralize string data common to many viewer builds
(such as required compiler switches), both internal to Linden and external, on
TeamCity and on individual dev machines.
This fork holds data for viewer (and viewer library) builds. Changes here are
viewer-only. To affect both viewer and server, push to
https://bitbucket.org/lindenlab/build-variables and pull the changes.
# Bash Usage
Intended usage is to clone this repository as a sibling to the source
directory being built, then use the bash "source" or "." commands to read
../build-variables/convenience into your build script. This gives you
`../build-variables/convenience` into your build script. This gives you
shell variables such as
LL_BUILD_RELEASE, LL_BUILD_RELWITHDEBINFO, LL_BUILD_DEBUG
LL_BUILD_RELEASE, LL_BUILD_RELWITHDEBINFO, LL_BUILD_DEBUG
which are aliases for the platform-specific variables (e.g.)
LL_BUILD_LINUX_RELEASE, LL_BUILD_LINUX_RELWITHDEBINFO, LL_BUILD_LINUX_DEBUG
LL_BUILD_LINUX_RELEASE, LL_BUILD_LINUX_RELWITHDEBINFO, LL_BUILD_LINUX_DEBUG
et al.
If you pass a build-type argument (Release, RelWithDebInfo, Debug) when
sourcing the convenience script, e.g.:
If you pass a build-type argument (`Release`, `RelWithDebInfo`, `Debug`) when
sourcing the [convenience](convenience) script, e.g.:
source ../build-variables/convenience Release
then you get the additional alias LL_BUILD, which (in the example above,
assuming you're running on Linux) is the same as LL_BUILD_LINUX_RELEASE.
then you get the additional alias `LL_BUILD`, which (in the example above,
assuming you're running on Linux) is the same as `LL_BUILD_LINUX_RELEASE`.
The convenience script also provides bash functions for removing or replacing
individual switches from any one of those variables. See the comments in the
script for function usage.
The [`functions`](functions) script (also sourced by [`convenience`](convenience)) provides bash functions
for removing or replacing individual switches from any one of those variables.
See the comments in the script for function usage.
# Other Languages
## Variable Suite
The convenience script sources the variables script, which provides the
The [convenience](convenience) script sources the [variables](variables) script, which provides the
underlying suite of variables. Variable names are of the form:
LL\_BUILD\_{platform}\_{buildtype}
LL\_BUILD\_{platform}\_{buildtype}
where:
@@ -50,7 +46,7 @@ buildtype | RELEASE, RELWITHDEBINFO, DEBUG. BASE for switches common to all.
These variables are in turn composed of variables that separate out
command-line macro definitions from other kinds of compiler switches:
LL\_BUILD\_{platform}\_{buildtype}\_{category}
LL\_BUILD\_{platform}\_{buildtype}\_{category}
where:
@@ -59,16 +55,16 @@ component | meaning
category | MACROS, SWITCHES.
These are typically aggregated into the corresponding
LL\_BUILD\_{platform}\_{buildtype} variables:
`LL\_BUILD\_{platform}\_{buildtype}` variables:
LL_BUILD_LINUX_RELEASE="$LL_BUILD_LINUX_RELEASE_SWITCHES $LL_BUILD_LINUX_RELEASE_MACROS"
LL_BUILD_LINUX_RELEASE="$LL_BUILD_LINUX_RELEASE_SWITCHES $LL_BUILD_LINUX_RELEASE_MACROS"
CMake, in particular, distinguishes between macro definitions
([add_definitions()](https://cmake.org/cmake/help/v3.1/command/add_definitions.html))
and other compiler switches
([add_compile_options()](https://cmake.org/cmake/help/v3.1/command/add_compile_options.html)),
so it may be useful to populate those CMake commands from the underlying
_MACROS and _SWITCHES variables.
`_MACROS` and `_SWITCHES` variables.
## Parsing the variables file
The variables file should be kept as simple as possible to parse, so it can be