From 6db91505bfc2c877c3bf0a41b187c1db58e2619d Mon Sep 17 00:00:00 2001 From: Patrick C Lankswert Date: Mon, 29 Dec 2014 21:24:59 -0500 Subject: [PATCH] Updated the README files to reference the master build in root Change-Id: Ibeb95e7a872ca51e29656a825c37247e48d89fe5 Signed-off-by: Patrick Lankswert --- resource/README.setup.txt | 11 +++++++++++ resource/csdk/README | 11 +++++++++++ resource/csdk/connectivity/samples/linux/README | 12 ++++++++++++ resource/csdk/libcoap-4.1.1/README | 9 +++++++++ resource/csdk/logger/README | 11 +++++++++++ resource/csdk/logger/test/android/README | 13 +++++++++++++ resource/csdk/occoap/README.txt | 11 +++++++++++ resource/csdk/ocmalloc/test/linux/README | 13 +++++++++++++ resource/csdk/ocsocket/README.txt | 13 +++++++++++++ resource/csdk/stack/README | 11 +++++++++++ .../csdk/stack/samples/arduino/SimpleClientServer/README | 11 +++++++++++ .../samples/arduino/SimpleClientServer/ocserver/README | 11 +++++++++++ resource/csdk/stack/test/README | 13 +++++++++++++ resource/csdk/stack/test/android/README | 13 +++++++++++++ resource/csdk/stack/test/arduino/README | 13 +++++++++++++ resource/oc_logger/samples/linux/README | 13 +++++++++++++ resource/unittests/README | 13 +++++++++++++ 17 files changed, 202 insertions(+) diff --git a/resource/README.setup.txt b/resource/README.setup.txt index 3c6e6ac..d248d66 100644 --- a/resource/README.setup.txt +++ b/resource/README.setup.txt @@ -19,6 +19,17 @@ -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= =============================================================================== +== NOTICE - Transition to SCONS == +=============================================================================== + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +=============================================================================== == Rich Stack & Lite Stack == =============================================================================== diff --git a/resource/csdk/README b/resource/csdk/README index bf548d8..fb92438 100644 --- a/resource/csdk/README +++ b/resource/csdk/README @@ -1,4 +1,15 @@ ------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- **Linux** ------------------------------------------------------------------------------- To make octbstack.a in release mode: diff --git a/resource/csdk/connectivity/samples/linux/README b/resource/csdk/connectivity/samples/linux/README index 53c5564..239ddbc 100644 --- a/resource/csdk/connectivity/samples/linux/README +++ b/resource/csdk/connectivity/samples/linux/README @@ -1,3 +1,15 @@ +//---------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//---------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//---------------------------------------------------------------------- #1. build "connectivity" project - execute make command in "connectivity/build/" folder. diff --git a/resource/csdk/libcoap-4.1.1/README b/resource/csdk/libcoap-4.1.1/README index 41af33e..043a317 100644 --- a/resource/csdk/libcoap-4.1.1/README +++ b/resource/csdk/libcoap-4.1.1/README @@ -25,6 +25,15 @@ Public License (GPL), Version 2 or higher, OR the revised BSD license. Please refer to LICENSE.GPL oder LICENSE.BSD for further details. +NOTICE - TRANSITION TO SCONS + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + BUILD STEPS FOR INTEL OC STACK Use below command to build libcoap: diff --git a/resource/csdk/logger/README b/resource/csdk/logger/README index d8800aa..1e024fe 100644 --- a/resource/csdk/logger/README +++ b/resource/csdk/logger/README @@ -1,6 +1,17 @@ Build notes //------------------------------------------------- +// NOTICE - Transition to SCONS +//------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//------------------------------------------------- // Linux //------------------------------------------------- To enable logging, ensure that diff --git a/resource/csdk/logger/test/android/README b/resource/csdk/logger/test/android/README index 3bcbfe5..4648a96 100644 --- a/resource/csdk/logger/test/android/README +++ b/resource/csdk/logger/test/android/README @@ -1,3 +1,16 @@ +//--------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//--------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//--------------------------------------------------------------------- + loggertests.cpp contain several logger tests that can be used in an Android JNI app. androidloggertestoutput.txt is a file capture from running loggertests.cpp in an Android JNI app. diff --git a/resource/csdk/occoap/README.txt b/resource/csdk/occoap/README.txt index fb78597..20e7013 100644 --- a/resource/csdk/occoap/README.txt +++ b/resource/csdk/occoap/README.txt @@ -1,4 +1,15 @@ #============================================================================== +# NOTICE - Transition to SCONS +#============================================================================== + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +#============================================================================== # Build instructions for Linux #============================================================================== diff --git a/resource/csdk/ocmalloc/test/linux/README b/resource/csdk/ocmalloc/test/linux/README index 4b28837..72e3c1c 100644 --- a/resource/csdk/ocmalloc/test/linux/README +++ b/resource/csdk/ocmalloc/test/linux/README @@ -1,3 +1,16 @@ +------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- + # To build the ocmalloc google unit test for Linux: # First diff --git a/resource/csdk/ocsocket/README.txt b/resource/csdk/ocsocket/README.txt index 0f2c567..61dc001 100644 --- a/resource/csdk/ocsocket/README.txt +++ b/resource/csdk/ocsocket/README.txt @@ -1,3 +1,16 @@ +------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- + To compile for Linux or Android, include ocsocket.c and ocsocket.h in your project. Look at the Makefile in ocsocket/test/linux and ocsocket/test/android for compilation dependencies. diff --git a/resource/csdk/stack/README b/resource/csdk/stack/README index 5a2c667..965b476 100644 --- a/resource/csdk/stack/README +++ b/resource/csdk/stack/README @@ -1,6 +1,17 @@ Build notes //------------------------------------------------- +// NOTICE - Transition to SCONS +//------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//------------------------------------------------- // Linux //------------------------------------------------- To build, run diff --git a/resource/csdk/stack/samples/arduino/SimpleClientServer/README b/resource/csdk/stack/samples/arduino/SimpleClientServer/README index 87a02d4..78f204e 100644 --- a/resource/csdk/stack/samples/arduino/SimpleClientServer/README +++ b/resource/csdk/stack/samples/arduino/SimpleClientServer/README @@ -1,4 +1,15 @@ ------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- **Arduino** -- Must be built with the same BUILD mode declared as octbstack.a. ------------------------------------------------------------------------------- When an Arduino SimpleClientServer application is running, it outputs logs to diff --git a/resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/README b/resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/README index b1573b3..dc0e35b 100644 --- a/resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/README +++ b/resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/README @@ -1,4 +1,15 @@ ------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- **Arduino** -- Must be built with the same BUILD mode declared as octbstack.a. ------------------------------------------------------------------------------- When an Arduino SimpleClientServer application is running, it outputs logs to diff --git a/resource/csdk/stack/test/README b/resource/csdk/stack/test/README index c16e3b7..0e3dfa4 100644 --- a/resource/csdk/stack/test/README +++ b/resource/csdk/stack/test/README @@ -1,3 +1,16 @@ +//--------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//--------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//--------------------------------------------------------------------- + stacktests.cpp is a unit test of the APIs in ocstack.c. It uses Google Test for the unit tests. Note that the unit tests are only to test the functionality of diff --git a/resource/csdk/stack/test/android/README b/resource/csdk/stack/test/android/README index c3eb5ee..0c51097 100644 --- a/resource/csdk/stack/test/android/README +++ b/resource/csdk/stack/test/android/README @@ -1,3 +1,16 @@ +//--------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//--------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//--------------------------------------------------------------------- + stacktests.cpp contain several stack tests that can be used in an Android JNI app. Note: to enable the logger for Android, TB_LOG should be defined in the ./jni/Android.mk file as diff --git a/resource/csdk/stack/test/arduino/README b/resource/csdk/stack/test/arduino/README index d5e7c82..b2e46d0 100644 --- a/resource/csdk/stack/test/arduino/README +++ b/resource/csdk/stack/test/arduino/README @@ -1,3 +1,16 @@ +//--------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//--------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//--------------------------------------------------------------------- + ArduinoStackTest.cpp contains several logger tests and can be used in an Arduino sketch. diff --git a/resource/oc_logger/samples/linux/README b/resource/oc_logger/samples/linux/README index 966cff9..25a4cd3 100644 --- a/resource/oc_logger/samples/linux/README +++ b/resource/oc_logger/samples/linux/README @@ -1,3 +1,16 @@ +------------------------------------------------------------------------------- + NOTICE - Transition to SCONS +------------------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +------------------------------------------------------------------------------- + To run the oc_logger C sample app, first build liboctbstack.a cd /csdk diff --git a/resource/unittests/README b/resource/unittests/README index 70d5515..0fd09ea 100644 --- a/resource/unittests/README +++ b/resource/unittests/README @@ -1,3 +1,16 @@ +//--------------------------------------------------------------------- +// NOTICE - Transition to SCONS +//--------------------------------------------------------------------- + +The IoTivity build system is transitioning to SCONS. Although the +makefiles are still available (until v1.0) and some developers are +still using them, they are currently no longer supported. To learn more +about building using SCONS see Readme.scons.txt in the repository root +directory. The build steps used in continuous integration can be found +in auto_build.sh which is also in the the repository root directory. + +//--------------------------------------------------------------------- + tests.cpp contains unittests for C++ APIs. It uses Google Test for the unit tests. Note that the unit tests are only to test the functionality of OCApi.h. It is not a system or end-to-end test. -- 2.7.4