aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Abraham <thomas.abraham@arm.com>2019-01-16 10:58:02 +0530
committerThomas Abraham <thomas.abraham@arm.com>2019-01-17 18:04:16 +0530
commit0409dd291b518078c3c159478f2825c948f95305 (patch)
tree87c1f8f55bcfd52dfddf2f7ccad617ea6e66f45e /README.md
parent3240d31377d1cf052680730768d170a797860694 (diff)
configs: rename 'platforms' directory as 'configs'
As build-scripts scales up to support platforms specfic tests, there is a need to create a platform specific directory to hold the platform specfic test build scripts. One of the ways to organize the platform specfic test build scripts could be as below build-scripts | |-- build-<component1>.sh |-- build-<component2>.sh |-- . |-- . |-- build-<componentX>.sh |-- build-test-TEST1.sh |-- build-test-TEST2.sh |-- . |-- . |-- build-test-TESTX.sh | |-- configs | | | |-- <platform1> | |-- <platform2> | |-- . | |-- . | |-- <platformX> | |-- <platform1> | | | |-- <build-test-TEST1>.sh | |-- <build-test-TEST2>.sh | |-- . | |-- . | |-- <build-test-TESTX>.sh | |-- <platform2> | | | |-- <build-test-TEST1>.sh | |-- <build-test-TEST2>.sh | |-- . | |-- . | |-- <build-test-TESTX>.sh | |-- <platformX> | |-- <build-test-TEST1>.sh |-- <build-test-TEST2>.sh |-- . |-- . |-- <build-test-TESTX>.sh The existing 'platforms' directory is in fact a bunch of build config files. So the 'platforms' directory can be renamed as 'configs' directory to allow adding platform specific directory under the root of build-scripts directory. This would help to avoid any possible incorrect interpretation of the purpose of the configs directory and the platform specific test build scripts directory. Change-Id: I3ca0576cfdbc7be88d2812fcda841c19c95ce8ca Signed-off-by: Thomas Abraham <thomas.abraham@arm.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 44416a1..a9b3bb1 100644
--- a/README.md
+++ b/README.md
@@ -164,13 +164,13 @@ following example for a more reliable way of building and packaging in one go.
--------------------------------------------------------------------------------
-## Platforms
+## Configs
-Platform files provide configuration for platforms and flavours of that
+Config files provide configuration for platforms and flavours of that
platform. The structure on the filesystem is shown below.
```
-platforms/
+configs/
├── common
│   └── common.base
└── platform_name
@@ -189,7 +189,7 @@ If this behaviour is not desired, and only one flavour of the platform is
required then the following structure might be desired instead:
```
-platforms/
+configs/
├── common
│   └── common.base
└── my_platform