summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk>2018-11-26 18:09:48 +0000
committerRaoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk>2018-12-05 10:44:02 +0000
commit219fc2f301aeaaccc090154c642c2d7497c6d438 (patch)
tree9119d8aa73c0764f005b30f79ea8f68a3c487f30
parentb0603fb014c51660860ca452d4fa84c8ce52cac7 (diff)
downloadbuildstream-219fc2f301aeaaccc090154c642c2d7497c6d438.tar.gz
format_project.rst: Update documentation for changes to OptionArch
-rw-r--r--doc/source/format_project.rst25
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 9b51f8d4b..29bd73dfd 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -552,9 +552,22 @@ exported as a comma separated list of selected value strings.
Architecture
~~~~~~~~~~~~
-The ``arch`` option type is special enumeration option which
-defaults to the result of `uname -m`, and does not support
-assigning any default in the project configuration.
+The ``arch`` option type is a special enumeration option which defaults via
+`uname -m` results to the following list.
+
+* aarch32
+* aarch64
+* aarch64-BE
+* power-isa-be
+* power-isa-le
+* sparc-v9
+* x86-32
+* x86-64
+
+The reason for this, opposed to using just `uname -m`, is that we want an
+OS-independent list, as well as several results mapping to the same architecture
+(e.g. i386, i486 etc. are all x86-32). It does not support assigning any default
+in the project configuration.
.. code:: yaml
@@ -563,10 +576,10 @@ assigning any default in the project configuration.
type: arch
description: The machine architecture
values:
- - arm
+ - aarch32
- aarch64
- - i386
- - x86_64
+ - x86-32
+ - x86-64
Architecture options can be tested with the same expressions